Метод для ініціювання повернення коштів на картку платника. В рамках успішного списання по платежу з типом C2A статусом FINISHED та операцією списання з типом SEND статусом FINISHED створює операцію повернення з типом RETURN та статусом NEEDS_COMPLETE, статус платежу C2A переходить в WAITING_COMPLETE. Після цього можна викликати C2A Reverse Complete - завершення ініціювання повернення або C2A Reverse Cancel - скасування ініціювання повернення .
| Info |
|---|
Якщо протягом 1 години не один із методів не буде викликаний клієнтом, автоматично буде викликано C2A Reverse Cancel - скасування ініціювання повернення . |
Метод запиту - POST
Шлях запиту - /api/p2p/payments/c2a/reverse/initiate
Параметри для формування тіла запиту у форматі JSON
Ключ | Тип даних | Обов'язковий? | Опис | Приклад |
|---|---|---|---|---|
params.sessionId | string | так | "445fb296-8653-4646-8475-5796c97d16ff" | |
params.paymentId | string | так, один із цих параметрів: params.paymentId, params.operationId або params.externalId | id платежу | "a85ee391-46ca-4766-b376-292bd7efbeea" |
params.operationId | string | id операції списання | "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014" | |
params.externalId | string | зовнішній id операції списання | "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8" | |
params.reverseExternalId | string | так | унікальний зовнішній id повернення у системі клієнта, який буде присвоєно створеній операції, не більше 255 символів | "3b604870-7361-4125-9a41-03c12e8bc31b" |
Приклади тіла запиту
| Code Block | ||
|---|---|---|
| ||
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |
або
| Code Block | ||
|---|---|---|
| ||
{
"params": {
"sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
"externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |
Параметри тіла відповіді у форматі JSON
Ключ | Тип даних | Опис | Приклад |
|---|---|---|---|
data.paymentId | string | id платежу | "a85ee391-46ca-4766-b376-292bd7efbeea" |
data.reverseOperationId | string | id операції повернення | "2a01fd7c-f9ca-444e-a800-d6ce59b87e96" |
data.reverseExternalId | string | зовнішній id операції повернення | "3b604870-7361-4125-9a41-03c12e8bc31b" |
Приклад тіла відповіді
| Code Block | ||
|---|---|---|
| ||
{
"status": 1,
"data": {
"paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
"reverseOperationId": "2a01fd7c-f9ca-444e-a800-d6ce59b87e96",
"reverseExternalId": "3b604870-7361-4125-9a41-03c12e8bc31b"
}
} |