A method for canceling the initiation of debiting funds from the payer's card. The action can be performed after C2A Initiate - initiating a debit transaction, the payment must be of type C2A and status WAITING_COMPLETE, and the transaction should be of type SEND and status NEEDS_COMPLETE. After the call, the status of the payment becomes OPEN, and the status of the transaction becomes CANCELED.
Request method - POST
Request path - /api/p2p/payments/c2a/cancel
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.paymentId | string | yes, one of these parameters: params.paymentId, params.operationId, or params.externalId | payment id | "a85ee391-46ca-4766-b376-292bd7efbeea" |
params.operationId | string | operation id | "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014" | |
params.externalId | string | external id of the operation | "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" |
Request body examples
{ "params": { "sessionId": "445fb296-8653-4646-8475-5796c97d16ff", "paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea" } }
or
{ "params": { "sessionId": "445fb296-8653-4646-8475-5796c97d16ff", "externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" } }
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" } }
Add Comment