/CancelPreauthorization

POST

The /CancelPreauthorization request is used to cancel a preauthorized payment in the case of a two-phase payment.
A merchant can perform this request if it has the relevant permissions in the system.

Request

Header Params

ExtSystemid

string

required

The identifier of the external system (ES) that generated the request. The identifier agrees with UKRKART during the registration of the ES

>= 1 characters<= 50 characters

Example:

ECOM_GOLD_BANK

string

required

External system login received from UKRKARD during registration

>= 1 characters<= 30 characters

Example:

SECURE_LOGIN

password

string

required

External system password received from UKRKARD during registration

>= 1 characters<= 30 characters

Example:

SECURE_PASSWORD

orderNumber

string

required

Number (identifier) of the order in the merchant’s online
store system. It is unique for every store in the system and
is generated on the order registration

>= 1 characters<= 32 characters

Example:

1234

orderId

string

optional

Number generated by wsGate after the registration of the order.

>= 32 characters<= 32 characters

Example:

dbafea6c-3394-4f6a-a0d2-21d3d8e93e42

RegDate

string <date-time>

required

Date/time of the request in yyyy-MM-dd HH:mm:ss format

Example:

2023-09-12 12:16:00

Match pattern:

YYYY-MM-DD hh:mm:ss

x-uws-clientdn

string

required

The specified value must be equal to the value specified in the Common Name (CN) field for the client's SSL certificate

<= 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

External system page data

language

string

optional

The language of the current page session

fmparam

object

required

Block for transmitting a list of additional parameters used to implement the regulator's requirements for transmitting information about the payer in a payment transaction, and used for financial monitoring. The obligation to transmit parameters in the specified tag for each method is specified in the requirements (application) of the acquiring bank for registration of terminals.

ReceiverCNAME

string

optional

Recipient name (legal entity)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

ReceiverEDRPOU

string

optional

Recipient's EDRPOU (legal entity) 8 digits

>= 8 characters<= 8 characters

Match pattern:

^[0-9]

ReceiverIBAN

string

optional

IBAN number (legal entity) of the recipient in the format for Ukraine.
Must start with UA, followed by 2 check digits, 6 characters of the MFO of the corresponding bank, and 19 characters of the bank account number. Total length — 29 characters.
Only IBANs issued by Ukrainian banks are supported.

>= 29 characters<= 29 characters

Match pattern:

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

SenderCNAME

string

optional

Name of the payer (legal entity)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

SenderEDRPOU

string

optional

Payer's Unified State Register of Accounts (legal entity) 8 digits

>= 8 characters<= 8 characters

SenderIBAN

string

optional

IBAN number of the payer (legal entity) in the format for Ukraine.

Must start with UA, followed by 2 check digits, 6 characters of the MFO of the corresponding bank, and 19 characters of the bank account number. Total length — 29 characters.
Only IBANs issued by Ukrainian banks are supported.

>= 29 characters<= 29 characters

Match pattern:

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

SenderPIB

string

optional

Full name of the payer (individual)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

SenderITN

string

optional

Taxpayer's INN (individual) 10 digits
(or passport number and series, if the person does not have a INN)

ReceiverPIB

string

optional

Full name of the recipient (individual)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

ReceiverITN

string

optional

TIN of the recipient (individual) 10 digits
(or passport number and series, if the person does not have a TIN)

TranID

string

optional

Transaction identifier in external systems, can be used as additional information for reconciliations if required by the acquiring bank

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/537337-0-default/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 12:34:37

/Preauthorization

/Completion