Метод для ініціювання повернення коштів на картку платника. В рамках успішного списання по платежу з типом C2A статусом FINISHED та операцією списання з типом SEND статусом FINISHED створює операцію повернення з типом RETURN та статусом NEEDS_COMPLETE, статус платежу C2A переходить в WAITING_COMPLETE. Після цього можна викликати This is a method for initiating a refund to the payer's card. As part of a successful write-off for a payment with a C2A status of FINISHED and a write-off operation with a SEND type of a FINISHED status, a return operation with a RETURN type and a NEEDS_COMPLETE status is created, and the C2A payment status changes to WAITING_COMPLETE. After that, you can perform the action Test C2A Reverse Complete - завершення ініціювання повернення або or Test C2A Reverse Cancel - скасування ініціювання повернення .
| Info |
|---|
Якщо протягом 1 години не один із методів не буде викликаний клієнтом, автоматично буде викликано If not one of the methods is called by the client within 1 hour, it will be called automaticallyTest C2A Reverse Cancel - скасування ініціювання повернення . |
Метод запиту Request method - POST
Шлях запиту Request path - /api/p2p/payments/c2a/reverse/initiate
Параметри для формування тіла запиту у форматі JSON
...
Ключ
...
Тип даних
...
Обов'язковий?
...
Опис
...
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 | debit operation id операції списання | "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014" | ||
params.externalId | stringзовнішній | id операції списанняthe external id of the write-off operation | "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" | ||
params.reverseExternalId | string | так | унікальний зовнішній id повернення у системі клієнта, який буде присвоєно створеній операції, не більше 255 символівyes | unique external return id in the client's system, which will be assigned to the created operation, no more than 255 characters | "3b604870-7361-4125-9a41-03c12e8bc31b" |
Приклади тіла запитуRequest body examples
| Code Block | ||
|---|---|---|
| ||
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |
абоor
| Code Block | ||
|---|---|---|
| ||
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |
Параметри тіла відповіді у форматі JSON
...
Ключ
...
Тип даних
...
Опис
...
Response body parameters in JSON format
Key | Data type | Description | Example |
|---|---|---|---|
data.paymentId | string | payment id платежу | "a85ee391-46ca-4766-b376-292bd7efbeea" |
data.reverseOperationId | string | return operation id операції повернення | "2a01fd7c-f9ca-444e-a800-d6ce59b87e96" |
data.reverseExternalId | stringзовнішній | id операції поверненняthe external id of the return operation | "3b604870-7361-4125-9a41-03c12e8bc31b" |
Приклад тіла відповіді Example of a response body
| Code Block | ||
|---|---|---|
| ||
{
"status": 1,
"data": {
"paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
"reverseOperationId": "2a01fd7c-f9ca-444e-a800-d6ce59b87e96",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |
...