OnlineBlock

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineBlock

post

Retrieve online block information

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineBlockRuleNumberintegerRequired

Responses

200

Successful operation.

application/json

post

/getOnlineBlock

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineBlock HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineBlockRuleNumber": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": {
    "CardAcceptorCountryCode": 1,
    "CardAcceptorIdCode": "text",
    "CardAcceptorName": "text",
    "CardAcceptorStates": "text",
    "CardAcceptorZipCodes": "text",
    "CardTypes": "text",
    "Description": "text",
    "ExcludedCountryCodes": "text",
    "ExpirationDate": "2025-12-25",
    "MaximumTransactionAmount": 1,
    "MerchantTypes": "text",
    "MinimumTransactionAmount": 1,
    "PanEntryModes": "text",
    "PseudoTerminalId": "text",
    "RuleNumber": 1,
    "TerminalId": "text",
    "TrackingRecordOverride": true,
    "TransactionTypes": "text",
    "CardNotPresent": true,
    "EmvFallback": true,
    "MasterCardRiskScore": 1,
    "PersontoPersonPayment": true,
    "PinlessPinTransaction": true,
    "VisaAdvAuthScore": 1,
    "TransactionCodes": "text"
  }
}

getOnlineBlockSelectFields

post

Retrieve online block select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineBlockRuleNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/getOnlineBlockSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineBlockSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 843

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineBlockRuleNumber": 1,
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "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,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "PseudoTerminalId": true,
      "RuleNumber": true,
      "TerminalId": true,
      "TrackingRecordOverride": true,
      "TransactionCodes": true,
      "TransactionTypes": true,
      "VisaAdvAuthScore": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": {
    "CardAcceptorCountryCode": 1,
    "CardAcceptorIdCode": "text",
    "CardAcceptorName": "text",
    "CardAcceptorStates": "text",
    "CardAcceptorZipCodes": "text",
    "CardTypes": "text",
    "Description": "text",
    "ExcludedCountryCodes": "text",
    "ExpirationDate": "2025-12-25",
    "MaximumTransactionAmount": 1,
    "MerchantTypes": "text",
    "MinimumTransactionAmount": 1,
    "PanEntryModes": "text",
    "PseudoTerminalId": "text",
    "RuleNumber": 1,
    "TerminalId": "text",
    "TrackingRecordOverride": true,
    "TransactionTypes": "text",
    "CardNotPresent": true,
    "EmvFallback": true,
    "MasterCardRiskScore": 1,
    "PersontoPersonPayment": true,
    "PinlessPinTransaction": true,
    "VisaAdvAuthScore": 1,
    "TransactionCodes": "text"
  }
}

getOnlineBlockPagedList

post

Retrieve paged list of online blocks

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineBlockPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineBlockPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": [
    {
      "CardAcceptorCountryCode": 1,
      "CardAcceptorIdCode": "text",
      "CardAcceptorName": "text",
      "CardAcceptorStates": "text",
      "CardAcceptorZipCodes": "text",
      "CardTypes": "text",
      "Description": "text",
      "ExcludedCountryCodes": "text",
      "ExpirationDate": "2025-12-25",
      "MaximumTransactionAmount": 1,
      "MerchantTypes": "text",
      "MinimumTransactionAmount": 1,
      "PanEntryModes": "text",
      "PseudoTerminalId": "text",
      "RuleNumber": 1,
      "TerminalId": "text",
      "TrackingRecordOverride": true,
      "TransactionTypes": "text",
      "CardNotPresent": true,
      "EmvFallback": true,
      "MasterCardRiskScore": 1,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "VisaAdvAuthScore": 1,
      "TransactionCodes": "text"
    }
  ],
  "Token": "text"
}

getOnlineBlockListSelectFields

post

Retrieve online block list select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineBlockListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineBlockListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 817

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "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,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "PseudoTerminalId": true,
      "RuleNumber": true,
      "TerminalId": true,
      "TrackingRecordOverride": true,
      "TransactionCodes": true,
      "TransactionTypes": true,
      "VisaAdvAuthScore": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlockList": {
    "hasReachedMaximumListSize": true,
    "OnlineBlock": [
      {
        "CardAcceptorCountryCode": 1,
        "CardAcceptorIdCode": "text",
        "CardAcceptorName": "text",
        "CardAcceptorStates": "text",
        "CardAcceptorZipCodes": "text",
        "CardTypes": "text",
        "Description": "text",
        "ExcludedCountryCodes": "text",
        "ExpirationDate": "2025-12-25",
        "MaximumTransactionAmount": 1,
        "MerchantTypes": "text",
        "MinimumTransactionAmount": 1,
        "PanEntryModes": "text",
        "PseudoTerminalId": "text",
        "RuleNumber": 1,
        "TerminalId": "text",
        "TrackingRecordOverride": true,
        "TransactionTypes": "text",
        "CardNotPresent": true,
        "EmvFallback": true,
        "MasterCardRiskScore": 1,
        "PersontoPersonPayment": true,
        "PinlessPinTransaction": true,
        "VisaAdvAuthScore": 1,
        "TransactionCodes": "text"
      }
    ]
  }
}

searchOnlineBlockSelectFields

post

Retrieve a list of select fields for searching by online block information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/searchOnlineBlockSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchOnlineBlockSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 849

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "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,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "PseudoTerminalId": true,
      "RuleNumber": true,
      "TerminalId": true,
      "TrackingRecordOverride": true,
      "TransactionCodes": true,
      "TransactionTypes": true,
      "VisaAdvAuthScore": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlockList": {
    "hasReachedMaximumListSize": true,
    "OnlineBlock": [
      {
        "CardAcceptorCountryCode": 1,
        "CardAcceptorIdCode": "text",
        "CardAcceptorName": "text",
        "CardAcceptorStates": "text",
        "CardAcceptorZipCodes": "text",
        "CardTypes": "text",
        "Description": "text",
        "ExcludedCountryCodes": "text",
        "ExpirationDate": "2025-12-25",
        "MaximumTransactionAmount": 1,
        "MerchantTypes": "text",
        "MinimumTransactionAmount": 1,
        "PanEntryModes": "text",
        "PseudoTerminalId": "text",
        "RuleNumber": 1,
        "TerminalId": "text",
        "TrackingRecordOverride": true,
        "TransactionTypes": "text",
        "CardNotPresent": true,
        "EmvFallback": true,
        "MasterCardRiskScore": 1,
        "PersontoPersonPayment": true,
        "PinlessPinTransaction": true,
        "VisaAdvAuthScore": 1,
        "TransactionCodes": "text"
      }
    ]
  }
}

getOnlineBlockPagedListSelectFields

post

Retrieve paged list select fields of online blocks

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getOnlineBlockPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getOnlineBlockPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 911

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "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,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "PseudoTerminalId": true,
      "RuleNumber": true,
      "TerminalId": true,
      "TrackingRecordOverride": true,
      "TransactionCodes": true,
      "TransactionTypes": true,
      "VisaAdvAuthScore": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": [
    {
      "CardAcceptorCountryCode": 1,
      "CardAcceptorIdCode": "text",
      "CardAcceptorName": "text",
      "CardAcceptorStates": "text",
      "CardAcceptorZipCodes": "text",
      "CardTypes": "text",
      "Description": "text",
      "ExcludedCountryCodes": "text",
      "ExpirationDate": "2025-12-25",
      "MaximumTransactionAmount": 1,
      "MerchantTypes": "text",
      "MinimumTransactionAmount": 1,
      "PanEntryModes": "text",
      "PseudoTerminalId": "text",
      "RuleNumber": 1,
      "TerminalId": "text",
      "TrackingRecordOverride": true,
      "TransactionTypes": "text",
      "CardNotPresent": true,
      "EmvFallback": true,
      "MasterCardRiskScore": 1,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "VisaAdvAuthScore": 1,
      "TransactionCodes": "text"
    }
  ],
  "Token": "text"
}

searchOnlineBlockPagedSelectFields

post

Retrieve a list of paged select fields for searching by online block information.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchOnlineBlockPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchOnlineBlockPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 926

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineBlockFields": true,
    "OnlineBlockFields": {
      "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,
      "PanEntryModes": true,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "PseudoTerminalId": true,
      "RuleNumber": true,
      "TerminalId": true,
      "TrackingRecordOverride": true,
      "TransactionCodes": true,
      "TransactionTypes": true,
      "VisaAdvAuthScore": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "OnlineBlock": [
    {
      "CardAcceptorCountryCode": 1,
      "CardAcceptorIdCode": "text",
      "CardAcceptorName": "text",
      "CardAcceptorStates": "text",
      "CardAcceptorZipCodes": "text",
      "CardTypes": "text",
      "Description": "text",
      "ExcludedCountryCodes": "text",
      "ExpirationDate": "2025-12-25",
      "MaximumTransactionAmount": 1,
      "MerchantTypes": "text",
      "MinimumTransactionAmount": 1,
      "PanEntryModes": "text",
      "PseudoTerminalId": "text",
      "RuleNumber": 1,
      "TerminalId": "text",
      "TrackingRecordOverride": true,
      "TransactionTypes": "text",
      "CardNotPresent": true,
      "EmvFallback": true,
      "MasterCardRiskScore": 1,
      "PersontoPersonPayment": true,
      "PinlessPinTransaction": true,
      "VisaAdvAuthScore": 1,
      "TransactionCodes": "text"
    }
  ],
  "Token": "text"
}

updateOnlineBlockByID

post

Update online blocks by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OnlineBlockRuleNumberintegerOptional

Responses

200

Successful operation.

application/json

post

/updateOnlineBlockByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateOnlineBlockByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 797

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineBlockRuleNumber": 1,
  "OnlineBlockUpdatableFields": {
    "CardAcceptorCountryCode": 1,
    "CardAcceptorIdCode": "text",
    "CardAcceptorName": "text",
    "CardAcceptorStates": "text",
    "CardAcceptorZipCodes": "text",
    "CardNotPresent": true,
    "CardTypes": "text",
    "Description": "text",
    "EmvFallback": true,
    "ExcludedCountryCodes": "text",
    "ExpirationDate": "2025-12-25",
    "MasterCardRiskScore": 1,
    "MaximumTransactionAmount": 1,
    "MerchantTypes": "text",
    "MinimumTransactionAmount": 1,
    "PanEntryModes": "text",
    "PersontoPersonPayment": true,
    "PinlessPinTransaction": true,
    "PseudoTerminalId": "text",
    "TerminalId": "text",
    "TrackingRecordOverride": true,
    "TransactionCodes": "text",
    "TransactionTypes": "text",
    "VisaAdvAuthScore": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}