Payment Verification - /api/v20/check

The check method is used for preliminary payment verification, user identifier validation, and, if necessary, retrieving additional data from the provider.

Request Structure

Parameter	Value
Method	POST
URI	<url>/api/v20/check
URI Parameters	none
Body Parameters	request parameters
Content-Type	application/json

Request Variants

Basic Number Check

Parameter	Description	Required
serviceId	Service code in the processing system	yes
account	User identifier: phone, email, account number, etc.	yes
agentTransactionId	Unique operation number on the Agent's side	yes
agentTransactionDate	Operation date on the Agent's side	yes
amountTo	Amount to be credited	no
amountFrom	Amount received from the user	no

{
  "serviceId": "A1011",
  "account": "7770017711",
  "agentTransactionId": 1233355,
  "agentTransactionDate": "2015-02-17T16:48:37",
  "amountTo": 200.00,
  "amountFrom": 200.00
}

Request with User Identity Data

Parameter	Description	Required
serviceId	Service code in the processing system	yes
account	User identifier	yes
agentTransactionId	Unique operation number on the Agent's side	yes
agentTransactionDate	Operation date on the Agent's side	yes
amountTo	Amount to be credited	no
amountFrom	Amount received from the user	no
identityCard	Passport or ID number	no
fullName	Payer's full name	no

info

For certain countries or service types, legislation may require transmitting payer identity data.

{
  "serviceId": "A1011",
  "account": "7770017711",
  "agentTransactionId": 1233355,
  "agentTransactionDate": "2015-02-17T16:48:37",
  "amountTo": 200.00,
  "amountFrom": 200.00,
  "identityCard": "123456789",
  "fullName": "John Doe"
}

Request with Additional Fields

Parameter	Description	Required
serviceId	Service code in the processing system	yes
account	User identifier	yes
agentTransactionId	Unique operation number on the Agent's side	yes
agentTransactionDate	Operation date on the Agent's side	yes
amountTo	Amount to be credited	no
amountFrom	Amount received from the user	no
extras	Additional parameters container	yes
account1	Additional field account1	no
account2	Additional field account2	no

info

Additional fields in extras are used for services that require supplementary data alongside the main identifier, such as email, order number, or payment type.

{
  "serviceId": "A1012",
  "account": "0",
  "agentTransactionId": 1233355,
  "agentTransactionDate": "2015-02-17T16:48:37",
  "amountTo": 200.00,
  "amountFrom": 200.00,
  "extras": {
    "account1": "test@gmail.com",
    "account2": "121231"
  }
}

Response Variants

Basic Response

Parameter	Description	Required
result	Result code	yes
resultMessage	Text description of the result	yes
transactionId	Operation identifier in the processing system	yes
agentTransactionId	Agent's operation identifier	yes

{
  "result": 0,
  "resultMessage": "ok",
  "transactionId": 100000781233355,
  "agentTransactionId": 1233355
}

Response for International Providers

Parameter	Description	Required
result	Result code	yes
resultMessage	Text description of the result	yes
transactionId	Operation identifier in the processing system	yes
agentTransactionId	Agent's operation identifier	yes
currencyRate	Conversion rate information	no
rate	Conversion rate	no
finalAmount	Credit amount in provider's currency	no
currency	Provider's currency	no

{
  "result": 0,
  "resultMessage": "Success",
  "transactionId": 1402546,
  "agentTransactionId": 12,
  "currencyRate": "Conversion rate KZT/USD 0.0021",
  "rate": 0.0020833333,
  "finalAmount": 1.75,
  "currency": "USD"
}

Response with Display Data

Parameter	Description	Required
result	Result code	yes
resultMessage	Text description of the result	yes
transactionId	Operation identifier in the processing system	yes
agentTransactionId	Agent's operation identifier	yes
displays	Fields to display to the user	no

info

The displays object may contain fields that need to be shown to the user or used in the next payment step.

{
  "result": 0,
  "resultMessage": "ok",
  "transactionId": 270,
  "agentTransactionId": 205,
  "displays": {
    "fio": "Test fio",
    "address": "Embankment 134, apt 5",
    "info": "Amount to pay: 20000.00"
  }
}

Response for Selection Scheme

Parameter	Description	Required
result	Result code	yes
resultMessage	Text description of the result	yes
transactionId	Operation identifier in the processing system	yes
agentTransactionId	Agent's operation identifier	yes
contracts	List of available contracts/accounts/orders to choose from	yes
contractId	Contract/account/order identifier	yes
name	Name or full name	no
contractNumber	Contract number	no
contractSum	Amount to pay	no
contractDate	Issue date	no

info

Typical scenario - returning multiple invoices, orders, or contracts from which the user must select one.

{
  "result": 0,
  "resultMessage": "ok",
  "transactionId": 100000781233355,
  "agentTransactionId": 1233355,
  "contracts": [
    {
      "name": "John Smith",
      "contractId": "000000587",
      "contractNumber": "1/00-A",
      "contractSum": "1000.00",
      "contractDate": "20200215000000"
    },
    {
      "name": "John Smith",
      "contractId": "000000588",
      "contractNumber": "2/00-A",
      "contractSum": "2000.00",
      "contractDate": "20200216000000"
    }
  ]
}

Response for Complex Scheme

Parameter	Description	Required
result	Result code	yes
resultMessage	Text description of the result	yes
transactionId	Operation identifier in the processing system	yes
agentTransactionId	Agent's operation identifier	yes
invoice	Invoice container	yes
invoices	List of invoices	yes
invoiceId	Invoice identifier	no
formedDate	Formation date	no
expireDate	Payment deadline	no
clientName	Payer's full name	no
clientAddress	Payer's address	no
services	List of services within the invoice	yes
subServiceId	Service identifier within the invoice	yes
subServiceName	Service name within the invoice	yes
data	Service attribute set	no
paySum	Amount to pay	no
tariff	Tariff	no
minSum / maxSum	Minimum and maximum allowed amount	no
debtInfo	Debt information	no
isMeter	Metered service flag	no
prevCount / lastCount	Meter readings	no
si	Unit of measurement	no
comment	Service comment	no

info

The composition of invoice depends on the provider's response. Some invoice fields may be absent.

{
  "result": 0,
  "resultMessage": "ok",
  "transactionId": 284,
  "agentTransactionId": 205,
  "invoice": {
    "invoices": [
      {
        "invoiceId": "2020020003535444",
        "formedDate": "20200201000000",
        "expireDate": "20200229000000",
        "clientName": "John Doe",
        "clientAddress": "District 2, building 42, apt. 4",
        "services": [
          {
            "subServiceId": "36",
            "subServiceName": "Electricity",
            "data": {
              "paySum": 359.8,
              "tariff": 0.0,
              "minSum": 0.0,
              "maxSum": 0.0,
              "debtInfo": "0.00",
              "isMeter": true,
              "prevCount": "4870.00",
              "lastCount": "0.00",
              "si": "kWh",
              "comment": ""
            }
          }
        ]
      }
    ]
  }
}