A method for initiating the transfer of funds to the recipient's card. Creates a payment with type A2C and status WAITING_COMPLETE, and a transaction with type RECEIVE and status NEEDS_COMPLETE. After that, you can perform the action TestA2C Complete - завершення ініціювання зарахування or TestA2C Cancel - скасування ініціювання зарахування .
If not one of the methods is called by the client within 1 hour, it will be called automatically TestA2C Cancel - скасування ініціювання зарахування .
Request method - POST
Request path - /api/p2p/payments/a2c/initiate
Parameters for forming the request body in JSON format
Key | Data type | Obligated? | Description | Example |
|---|---|---|---|---|
params.sessionId | string | yes | client session id | "445fb296-8653-4646-8475-5796c97d16ff" |
params.externalId | string | yes | unique external id in the client's system that will be assigned to the created operation, no more than 255 characters | "116f3329-63b8-4eef-9e88-272bd8f697ac" |
params.amount | number | yes | payment amount, in kopecks | 15000 |
params.currency | string | yes | digital currency code, ISO 4217 standard, currently only hryvnia is available - "980" | "980" |
params.description | string | no | description of the payment, no more than 255 characters | "Order №54321" |
params.callbackUrl | string | no | The URL to which the callback will be sent, no more than 255 characters |
An example of a request body
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"externalId": "116f3329-63b8-4eef-9e88-272bd8f697ac",
"amount": 15000,
"currency": "980",
"description": "Order №54321",
"callbackUrl": "https://client-domain.ua/receive-postback/54321"
}
}
Response body parameters in JSON format
Key | Data type | Description | Expample |
|---|---|---|---|
data.paymentId | string | payment id | "25f2f3d4-0406-499b-bb9c-577596ad9ef6" |
data.operationId | string | operation id | "d977281d-c4c5-4c81-b457-791767bb0a02" |
data.externalId | string | external id of the operation | "116f3329-63b8-4eef-9e88-272bd8f697ac" |
Example of a response body
{
"status": 1,
"data": {
"paymentId": "25f2f3d4-0406-499b-bb9c-577596ad9ef6",
"operationId": "d977281d-c4c5-4c81-b457-791767bb0a02",
"externalId": "116f3329-63b8-4eef-9e88-272bd8f697ac"
}
}
0 Comments