Skip to main content

Payment Execution - /api/v20/pay

The pay method initiates the payment. The exact request body depends on the service type: simple, selection, or complex.

Request Structure

ParameterValue
MethodPOST
URI<url>/api/v20/pay
URI Parametersnone
Body Parametersrequest parameters
Content-Typeapplication/json

Request Variants

Basic Request

ParameterDescriptionRequired
serviceIdService code in the processing systemyes
accountUser identifieryes
agentTransactionIdUnique Agent operation numberyes
agentTransactionDateAgent operation dateyes
amountToAmount to be creditedyes
amountFromAmount received from the userno
info

amountTo and amountFrom are transmitted as decimal values with two decimal places, e.g. 200.00.

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

Request with Additional Fields

ParameterDescriptionRequired
serviceIdService code in the processing systemyes
accountUser identifieryes
agentTransactionIdUnique Agent operation numberyes
agentTransactionDateAgent operation dateyes
amountToAmount to be creditedyes
amountFromAmount received from the userno
extrasAdditional fields containerno
account1Additional field account1no
account2Additional field account2no
{
"serviceId": "A1011",
"account": "7770017711",
"agentTransactionId": 1233355,
"agentTransactionDate": "2015-02-17T16:48:37",
"amountTo": 200.00,
"amountFrom": 200.00,
"extras": {
"account1": "test@gmail.com",
"account2": "121231"
}
}

Response Variants

pay responses mirror the structure of check responses based on the selected service scheme. On successful completion, transactionDate and statusDate may also be returned.

{
"result": 0,
"resultMessage": "Success",
"transactionId": 1402779,
"transactionDate": "2020-10-19T20:19:23.737",
"statusDate": "2020-10-19T20:19:24.940",
"agentTransactionId": 26801048196008
}