Method for initiating withdrawal of funds from the payer's card. Creates a payment with type C2A and status WAITING_COMPLETE and an operation with type SEND and status NEEDS_COMPLETE. After that, you can call the action C2A Complete - completion of debit initiation , C2A СompleteWithoutAcceptance - completion of initiation of non-acceptance write-off or C2A Cancel - cancellation of write-off initiation .
If not one of the methods is called by the client within 1 hour, it will be called automatically C2A Cancel - cancellation of write-off initiation .
Request method - POST
Request path - /api/p2p/payments/c2a/initiate
Parameters for forming the request body in JSON format
Key | Data type | Required? | 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 | "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" |
params.amount | number | yes | payment amount, in kopecks | 10000 |
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 №12345" |
params.callbackUrl | string | no | The URL to which the callback will be sent, no more than 255 characters | "https://client-domain.ua/receive-postback/12345" |
An example of a request body
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8",
"amount": 10000,
"currency": "980",
"description": "Order №12345",
"callbackUrl": "https://client-domain.ua/receive-postback/12345"
}
}
Response body parameters in JSON format
Key | Data type | description | Example |
|---|---|---|---|
data.paymentId | string | payment id | "a85ee391-46ca-4766-b376-292bd7efbeea" |
data.operationId | string | operation id | "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014" |
data.externalId | string | external id of the operation | "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" |
Example of a response body
{
"status": 1,
"data": {
"paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
"operationId": "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014",
"externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8"
}
}