Skip to content
NexumAPI Docs

OnlineBlock⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineBlockSelectFields⁠

POST

Execute the persistent ParameterService getOnlineBlockSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
OnlineBlockRuleNumberintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getOnlineBlockSelectFields
POST /nexum/627/persistent/parameter/getOnlineBlockSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineBlockRuleNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "BlockWarningsList": true,
      "CardAcceptorCountryCode": true,
      "CardAcceptorIdCode": true,
      "CardAcceptorName": true,
      "CardAcceptorStates": true,
      "CardAcceptorZipCodes": true,
      "CardNotPresent": true,
      "CardTypes": true,
      "Description": true,
      "EmvFallback": true,
      "ExcludedCountryCodes": true,
      "ExpirationDate": true,
      "MasterCardRiskScore": true,
      "MaximumTransactionAmount": true,
      "MerchantTypes": true,
      "MinimumTransactionAmount": true,
      "OverrideWarningsList": true,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineBlockPagedListSelectFields⁠

POST

Execute the persistent ParameterService getOnlineBlockPagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getOnlineBlockPagedListSelectFields
POST /nexum/627/persistent/parameter/getOnlineBlockPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "BlockWarningsList": true,
      "CardAcceptorCountryCode": true,
      "CardAcceptorIdCode": true,
      "CardAcceptorName": true,
      "CardAcceptorStates": true,
      "CardAcceptorZipCodes": true,
      "CardNotPresent": true,
      "CardTypes": true,
      "Description": true,
      "EmvFallback": true,
      "ExcludedCountryCodes": true,
      "ExpirationDate": true,
      "MasterCardRiskScore": true,
      "MaximumTransactionAmount": true,
      "MerchantTypes": true,
      "MinimumTransactionAmount": true,
      "OverrideWarningsList": true,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchOnlineBlockPagedSelectFields⁠

POST

Execute the persistent ParameterService searchOnlineBlockPagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchOnlineBlockPagedSelectFields
POST /nexum/627/persistent/parameter/searchOnlineBlockPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "BlockWarningsList": true,
      "CardAcceptorCountryCode": true,
      "CardAcceptorIdCode": true,
      "CardAcceptorName": true,
      "CardAcceptorStates": true,
      "CardAcceptorZipCodes": true,
      "CardNotPresent": true,
      "CardTypes": true,
      "Description": true,
      "EmvFallback": true,
      "ExcludedCountryCodes": true,
      "ExpirationDate": true,
      "MasterCardRiskScore": true,
      "MaximumTransactionAmount": true,
      "MerchantTypes": true,
      "MinimumTransactionAmount": true,
      "OverrideWarningsList": true,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineBlockByID⁠

POST

Execute the persistent ParameterService updateOnlineBlockByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
OnlineBlockRuleNumberintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updateOnlineBlockByID
POST /nexum/627/persistent/parameter/updateOnlineBlockByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineBlockRuleNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineBlockFields": {
    "BlockWarningsList": {
      "Bit": [
        0
      ]
    },
    "CardAcceptorCountryCode": 0,
    "CardAcceptorIdCode": "string",
    "CardAcceptorName": "string",
    "CardAcceptorStates": "string",
    "CardAcceptorZipCodes": "string",
    "CardNotPresent": true,
    "CardTypes": {
      "Bit": [
        0
      ]
    },
    "Description": "string",
    "EmvFallback": true,
    "ExcludedCountryCodes": "string",
    "ExpirationDate": "string",
    "MasterCardRiskScore": 0,
    "MaximumTransactionAmount": 0,
    "MerchantTypes": "string",
    "MinimumTransactionAmount": 0,
    "OverrideWarningsList": {
      "Bit": [
        0
      ]
    },
    "PanEntryModes": "string",
    "PersontoPersonPayment": true,
    "PinlessPinTransaction": true
  },
  "nxAttributes": {
    "customFields": {}
  }
}