/CancelPreauthorization

Cloud Mock

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

POST

Maintainer:Not configured

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

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

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

>= 32 characters<= 32 characters

Example:

dbafea6c-3394-4f6a-a0d2-21d3d8e93e42

RegDate

string <date-time>

required

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

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

pageData

object

required

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

language

string

optional

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

fmparam

object

required

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

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

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

ReceiverITN

string

optional

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

TranID

string

optional

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

Example

{
    "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/CancelPreauthorization' \
--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 '{
    "pageData": {
        "language": "uk"
    }
}'

Responses

🟢200OK

application/json

Body

orderParam

object

required

Реєстраційні дані операції

orderStatus

integer

required

Стан операції

orderId

string

required

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

Example:

1c01e06f-c3da-4afe-94d4-8de1311c720f

orderVerifyFlag

integer

required

Ознака способу автентифікації операції
- 0 - 3Ds автентифікація;
- 1 Аутентифікація через otp пароль тільки для НПС «ПРОСТІР»
- null або параметр відсутня - відсутня 3D аутентифікація

orderAuthParam

object

required

Авторизаційні параметри

Example

{
    "orderParam": {
        "orderStatus": 3,
        "orderId": "f67365e0-2139-49c6-a307-1e8e31c34d8c",
        "orderAuthParam": {
            "approvalCode": "111644",
            "authCode": 3
        }
    }
}

Modified at 2025-06-26 11:59:37

/Preauthorization

/Completion