UAPAY - національний платіжний сервіс

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Current »

Метод для ініціювання списання коштів с картки платника. Створює платіж з типом C2A та статусом WAITING_COMPLETE, а також операцію з типом SEND та статусом NEEDS_COMPLETE. Після цього можна викликати C2A Complete - завершення ініціювання списання, C2A СompleteWithoutAcceptance - завершення ініціювання безакцептного списання або C2A Cancel - скасування ініціювання списання.

Якщо протягом 1 години не один із методів не буде викликаний клієнтом, автоматично буде викликано C2A Cancel - скасування ініціювання списання.

Метод запиту - POST

Шлях запиту - /api/p2p/payments/c2a/initiate

Параметри для формування тіла запиту у форматі JSON

Ключ

Тип даних

Обов'язковий?

Опис

Приклад

params.sessionId

string

так

id сесії клієнта

"445fb296-8653-4646-8475-5796c97d16ff"

params.externalId

string

так

унікальний зовнішній id у системі клієнта, який буде присвоєно створеній операції, не більше 255 символів

"ad6cee7f-88ff-4090-ae38-8e6a0f260cd8"

params.amount

number

так

сума платежу, в копійках

10000

params.currency

string

так

цифровий код валюти, стандарт ISO 4217, на даний момент доступна лише гривня - "980"

"980"

params.description

string

ні

опис платежу, не більше 255 символів

"Order №12345"

params.callbackUrl

string

ні

URL на який буде здійснюватись відправка callback, не більше 255 символів

"https://client-domain.ua/receive-postback/12345"

Приклад тіла запиту

{
  "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"
  }
}

Параметри тіла відповіді у форматі JSON

Ключ

Тип даних

Опис

Приклад

data.paymentId

string

id платежу

"a85ee391-46ca-4766-b376-292bd7efbeea"

data.operationId

string

id операції

"bc3c95f1-bf2a-4e61-8c88-8444b1b4e014"

data.externalId

string

зовнішній id операції

"ad6cee7f-88ff-4090-ae38-8e6a0f260cd8"

Приклад тіла відповіді

{
  "status": 1,
  "data": {
    "paymentId": "a85ee391-46ca-4766-b376-292bd7efbeea",
    "operationId": "bc3c95f1-bf2a-4e61-8c88-8444b1b4e014",
    "externalId": "ad6cee7f-88ff-4090-ae38-8e6a0f260cd8"
  }
}

  • No labels