/Completion

Cloud Mock

https://mock.apidog.com/m1/483896-0-0e2d9b07

POST

/Completion

Maintainer:Not configured

Запит /Completion використовується для завершення попередньо авторизованого платежу у випадку двоетапного платежу.
Продавець може виконати цей запит, якщо він має відповідні дозволи в системі.

Request

Header Params

ExtSystemid

string

required

Ідентифікатор зовнішньої системи (ЗС), яка сформувала запит. Ідентифікатор погоджується з УКРКАРТ під час реєстрації ЗС

>= 1 characters<= 50 characters

Example:

ECOM_GOLD_BANK

string

required

Логін ЗС у системі, отриманий від УКРКАРТ при підключенні

>= 1 characters<= 30 characters

Example:

SECURE_LOGIN

password

string

required

Пароль ЗС у системі, отриманий від УКРКАРТ при підключенні

>= 1 characters<= 30 characters

Example:

SECURE_PASSWORD

orderNumber

string

required

Номер (ідентифікатор) операції у зовнішній системі. Значення має бути унікальним для кожної системи в її межах.

>= 1 characters<= 32 characters

Example:

1234

orderId

string

optional

Унікальний ідентифікатор для операції в системі. Призначається системою при обробці платіжного запиту.

>= 36 characters<= 36 characters

Example:

dbafea6c-3394-4f6a-a0d2-21d3d8e93e42

RegDate

string <date-time>

required

Дата/час запиту у форматі yyyy-MM-dd HH:mm:ss

<= 19 characters

Example:

2023-09-12 12:16:00

Match pattern:

YYYY-MM-DD hh:mm:ss

x-uws-clientdn

string

required

Зазначене значення має дорівнювати значенню, указаному в полі Common Name (CN) для сертифіката SSL клієнта

<= 500 characters

Example:

GOLDENBANK

Content-Type

string

optional

application/json;charset=UTF-8

Example:

application/json;charset=UTF-8

charset

string

optional

UTF-8

Example:

UTF-8

enum<string>

required

application/json

Allowed value:

application/json

Body Params application/json

orderData

object

required

Реєстраційні дані транзакції

amount

number

150000

required

Сума операції в мінімальних одиницях валюти. Можна використовувати операцію перевірки, як-от Debit Verify (відповідність перевірці рахунку Visa та запиту стану рахунку Mastercard) для нульової суми за допомогою автентифікації 3DS. Для цих операцій ви повинні використовувати звичайний метод /Payment з нульовою сумою. Аутентифікація 3DS буде присутня для карт MPS Visa та Mastercard. Для карт NPS Prostir це буде звичайна операція перевірки облікового запису.

<= 10000000000000000000

currency

string

optional

Код валюти транзакції ISO 4217. Якщо не вказано, вважається рівним коду валюти за умовчанням (980 - UAH)

>= 3 characters<= 3 characters

externalFee

string

optional

Сумма комісій в мінімальних одиницях валюти. Може бути використано тільки для методу p2pTransfer

<= 9 characters

description

string

required

Опис платежу

<= 512 characters

pageData

object

required

Дані сторінки зовнішньої системи

language

string

required

Мова поточної сесії сторінки

>= 2 characters<= 2 characters

Example:

returnUrl

string

required

Адреса, на яку треба перенаправити користувача за успішної оплати. Адреса повинна бути вказана повністю, включаючи протокол, що використовується (наприклад, "https://test.ua" замість test.ua). В іншому випадку, користувач буде перенаправлений за адресою за умовчанням

<= 512 characters

failUrl

string

required

Адреса, на яку потрібно перенаправити користувача у разі неуспішної оплати. Адреса повинна бути вказана повністю, включаючи протокол, що використовується (наприклад, https://test.ua замість test.ua). В іншому випадку користувач буде перенаправлений за замовчуванням

<= 512 characters

jsonParams

object

optional

Блок передачі додаткових параметрів мерчанта.

merchantIdType

string

optional

Тип документу
Можливі значення:
IDTP01 – Passport
IDTP0010 – Taxpayer ID (ІПН)
IDTP0016 – Company registration number (код ЄДРПОУ)
Приклад використання:
{"name":"merchantIdType","value":"IDTP01"}

merchantIdNumber

string

optional

Дані документу
Приклад використання:
{"name":"merchantIdNumber","value":"ABCDXYZ124"}

fmparam

object

optional

Блок для передачі списку додаткових параметрів, що використовуються для реалізації вимог регулятора щодо передачі інформації про платника в платіжній операції, і використовуватися для фінмоніторингу. Обов'язковість передачі параметрів у зазначеному тегу для кожного методу вказується у вимогах (заявці) банку - еквайра на реєстрацію терміналів.

ReceiverCNAME

string

optional

Назва отримувача (юридична особа)
(Використовуються тільки символи в кодуванні (UTF-8), без використання Unicode-ескейпів!)

ReceiverEDRPOU

string

optional

ЄДРПОУ отримувача (юридична особа) 8 цифр

>= 8 characters<= 8 characters

Match pattern:

^[0-9]

ReceiverIBAN

string

optional

IBAN-номер (юридичної особи) отримувача у форматі для України.
Має починатися з UA, далі - 2 контрольні цифри, 6 символів МФО відповідного банку, та 19 символів номера банківського рахунку. Загальна довжина — 29 символів.
Підтримуються лише IBAN, випущені українськими банками.

>= 29 characters<= 29 characters

Match pattern:

^UA\d{2}\d{6}\d{19}$

SenderCNAME

string

optional

Назва платника (юридична особа)
(Використовуються тільки символи в кодуванні (UTF-8), без використання Unicode-ескейпів!)

SenderEDRPOU

string

optional

ЄДРПОУ платника (юридична особа) 8 цифр

>= 8 characters<= 8 characters

SenderIBAN

string

optional

IBAN-номер платника (юридична особа) у форматі для України.
Має починатися з UA, далі - 2 контрольні цифри, 6 символів МФО відповідного банку, та 19 символів номера банківського рахунку. Загальна довжина — 29 символів.
Підтримуються лише IBAN, випущені українськими банками.

>= 29 characters<= 29 characters

Match pattern:

^UA\d{2}\d{6}\d{19}$

SenderPIB

string

optional

ПІБ платника (фізична особа)
(Використовуються тільки символи в кодуванні (UTF-8), без використання Unicode-ескейпів!)

SenderITN

string

optional

IПН платника (фізична особа) 10 цифр
(або номер та серію паспорту, якщо особа не має IПН)

ReceiverPIB

string

optional

ПІБ – отримувача (фізична особа)

ReceiverITN

string

optional

ІПН отримувача (фізична особа) 10 цифр
(або номер та серію паспорту, якщо особа не має IПН)

TranID

string

optional

Ідентифікатор операції у зовнішніх системах, може використовуватися як додаткова інформація для звірок, якщо цього вимагає банк еквайєр

Example

{
    "orderData": {
        "amount": 10000,
        "currency": 980,
        "description": "Операція #304324"
    },
    "pageData": {
        "language": "uk"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/483896-0-0e2d9b07/Completion' \
--header 'ExtSystemid: ECOM_GOLD_BANK' \
--header 'login: SECURE_LOGIN' \
--header 'password: SECURE_PASSWORD' \
--header 'orderNumber: 1234' \
--header 'orderId: dbafea6c-3394-4f6a-a0d2-21d3d8e93e42' \
--header 'RegDate: 2023-09-12 12:16:00	' \
--header 'x-uws-clientdn: GOLDENBANK' \
--header 'charset;' \
--header 'accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderData": {
        "amount": 10000,
        "currency": 980,
        "description": "Операція #304324"
    },
    "pageData": {
        "language": "uk"
    }
}'

Responses

🟢200OK

application/json

Body

orderParam

object

required

orderStatus

integer

required

orderId

string

required

orderAuthParam

object

required

Example

{
    "orderParam": {
        "orderStatus": 2,
        "orderId": "f390136a-77ad-43e1-9593-3ec72c791834",
        "orderAuthParam": {
            "approvalCode": "107429",
            "authCode": 2
        }
    }
}

Modified at 2025-06-26 12:00:19

/CancelPreauthorization

/ConfirmExt