Підготувати платіж та відправити на підпис

HEADER PARAMETERS:
  • accept

    required

    string

    Тип відповіді, який очікує клієнт.

  • x-token

    required

    string

    Токен доступу до API

  • idempotency-key

    required

    string

    Параметр потрібен для підтримки ідемпотентності. Якщо виникає будь-яка помилка мережі, то запит з однаковим параметром idempotency-key можна повторювати не боячись створити другий платіж. Клієнт має генерувати унікальне значення параметру для кожного унікального платежу. Алгоритм створення такого ключа клієнт реалізує на свій розсуд, але зі своєї сторони рекомендуємо використовувати UUID v4

REQUEST BODY SCHEMA: application/json
  • senderIban

    required

    string

    IBAN рахунку з якого треба зробити платіж

  • receiver

    required

    object (PaymentRequestReceiver)

    receiver {
  • destination

    required

    string >= 6 characters <= 420 characters

    Призначення платежу. Для бюджетних платежів призначення має бути спеціального формату: {payCode з запиту} {additionalInfo з запиту} ЄДРПОУ {ЄДРПОУ вашої компанії}

  • amount

    required

    integer <int64> >= 1 <= 10000000000

    Сума операції в мінімальних одиницях валюти (копійках, центах)

  • currency

    required

    string

    Код валюти операції відповідно ISO 4217. На даний момент єдина можлива валюта - 980 (гривня)

  • payCode

    string >= 3 characters <= 3 characters

    Код оплати (необхідний для створення бюджетного платежу)

  • additionalInfo

    string

    Додаткова інформація платежу (потрібна для створення бюджетного платежу)

post

/ext/v1/payment/prepare

Request samples
Payload

200 OK

400 Bad Request (invalid request parameters)

403 Forbidden

406 Not Acceptable (invalid Accept header)

Response samples
200
400
403
406