Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Info

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

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

Шлях запиту A method for initiating the transfer of funds to the recipient's card. Creates a payment with type A2C and status WAITING_COMPLETE, and a transaction with type RECEIVE and status NEEDS_COMPLETE. After that, you can perform the action A2C Complete - completion of funds transfer initiation or A2C Cancel - cancellation of funds transfer initiation .

Info

If not one of the methods is called by the client within 1 hour, it will be called automatically A2C Cancel - cancellation of funds transfer initiation .

Request method - POST

Request path - /api/p2p/payments/a2c/initiate

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

...

Ключ

...

Тип даних

...

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

...

Опис

...

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унікальний

зовнішній id у системі клієнта, який буде присвоєно створеній операції, не більше 255 символівunique external id in the client's system that will be assigned to the created operation, no more than 255 characters

"116f3329-63b8-4eef-9e88-272bd8f697ac"

params.amount

number

такyes

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

15000

params.currency

string

так

цифровий код валюти, стандарт yes

digital currency code, ISO 4217 , на даний момент доступна лише гривня standard, currently only hryvnia is available - "980"

"980"

params.description

string

ні

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

description of the payment, no more than 255 characters

"Order №54321"

params.callbackUrl

string

ніno

URL на який буде здійснюватись відправка callback, не більше 255 символівThe URL to which the callback will be sent, no more than 255 characters

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

Приклад тіла запитуAn example of a request body

Code Block
languagejson
{
  "params": {
    "sessionId": "445fb296-8653-4646-8475-5796c97d16ff",
    "externalId": "116f3329-63b8-4eef-9e88-272bd8f697ac",
    "amount": 15000,
    "currency": "980",
    "description": "Order №54321",
    "callbackUrl": "https://client-domain.ua/receive-postback/54321"
  }
}

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

...

Ключ

...

Тип даних

...

Опис

...

Response body parameters in JSON format

Key

Data type

Description

Expample

data.paymentId

string

payment id платежу

"25f2f3d4-0406-499b-bb9c-577596ad9ef6"

data.operationId

string

operation id операції

"d977281d-c4c5-4c81-b457-791767bb0a02"

data.externalId

string

зовнішній external id операціїof the operation

"116f3329-63b8-4eef-9e88-272bd8f697ac"

Приклад тіла відповіді Example of a response body

Code Block
languagejson
{
  "status": 1,
  "data": {
    "paymentId": "25f2f3d4-0406-499b-bb9c-577596ad9ef6",
    "operationId": "d977281d-c4c5-4c81-b457-791767bb0a02",
    "externalId": "116f3329-63b8-4eef-9e88-272bd8f697ac"
  }
}

...