/Preauthorization

Cloud Mock

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

POST

/Preauthorization

Maintainer:Not configured

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

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

sender

object

required

Реквізити відправника/платника

pan

string

required

Номер картки відправника/платника (карта з якої здійснюється переклад/купівля). Не використовується для A2C

<= 20 characters

expiry

string

required

Дата закінчення терміну дії картки відправника/платника (карти з якої провадиться переказ/купівля). Формат дати YYMM. Не використовується для A2C

<= 4 characters

Example:

2412

Match pattern:

YYMM

cvc

string

required

CVV2/CVC2 картки відправника/платника. Не використовується для A2C

>= 3 characters<= 3 characters

Example:

123

Match pattern:

^\d+$

senderCardName

string

optional

Ім'я відправника/платника (передані значення необхідно вказувати окремо 'FirstName [MidName,] LastName', з розділенням ' ' пробілом.). Необхідно виключити використання як роздільників всередині значень, що передаються в поточному тегу/параметрі, символи: кома ‘,’ та двокрапка ‘:’. Не використовується для A2C.

<= 25 characters

senderAddress

string

optional

Адреса відправника. Необхідно виключити використання як роздільників всередині значень, що передаються в поточному тегу/параметрі, символи: кома ',' і двокрапка ':'. Не використовується для A2C, Payment

<= 35 characters

senderCity

string

optional

Місто відправника. Необхідно виключити використання як роздільників всередині значень, що передаються в поточному тегу/параметрі, символи: кома ',' і двокрапка ':'. Не використовується для A2C, Payment.

<= 25 characters

Example:

Kyiv

senderCountry

string

optional

Країна відправника. Не використовується для A2C, Payment.

>= 3 characters<= 3 characters

Example:

804

senderPostalCode

string

optional

Поштовий код відправника. Не використовується для A2C, Payment.

<= 8 characters

Example:

M79019

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

browserParams

object

required

Властивості браузера користувача

javascriptEnabled

string

required

Параметр, який вказує, чи активовано підтримку Javascript для браузера власника картки

Example:

true

userAgent

string

required

Рядок агента браузера користувача

Example:

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.3

colorDepth

string

required

Глибина кольору екрана пристрою користувача

<= 3 characters

Example:

screenHeight

string

required

Висота екрану пристрою власника картки

screenWidth

string

required

Ширина екрану пристрою власника картки

javaEnabled

boolean

required

Параметр, який вказує, чи активовано підтримку Java для браузера власника картки

Default:

true

browserLanguage

string

required

Мова браузера користувача

Example:

uk-UA

browserTimeZone

string

required

Часовий пояс браузера користувача

Example:

Europe/Kiev

browserAcceptHeader

string

required

Параметр, що інформує сервер, на який браузер відправляє запит, ті формати файлів (MIME-типи) які прийнятні для браузера як відповідь

Example:

*/*

browserIpAddress

string

required

IP-адреса браузера власника картки

>= 3 characters<= 5 characters

Example:

192.139.102.100

browserTimeZoneOffset

string

required

Зсув часового поясу браузера користувача

>= 3 characters<= 5 characters

Example:

-120

fingerprint

string

optional

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

string

optional

Операционная система, используемая устройством держателя карти

osversion

string

optional

Версія операційної системи, яка використовується на пристрої держателя карти

mobile

string

optional

Параметр, який визначає пристрій власника карти мобільного

screenPrint

string

optional

Інформація про роздільну здатність екрана пристрою власника картки

plugins

string

optional

Список модулів, що підключаються, встановлених у браузері пристрою власника картки.

deviceType

string

optional

Тип пристрою, на якому запущено браузер (мобільний телефон, комп'ютер, планшет тощо).

device

string

optional

Інформація про пристрій утримувача картки (модель, версія тощо).

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

Назва отримувача (юридична особа)

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

Назва платника (юридична особа)

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

ПІБ платника (фізична особа)

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"
    },
    "sender": {
        "pan": "5248721588681850",
        "expiry": "2606",
        "cvc": "576",
        "senderCardName": "V1"
    },
    "pageData": {
        "language": "uk",
        "returnUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/pilot/finish.html",
        "failUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/pilot/finish.html"
    },
    "browserParams": {
        "browserTimeZone": "Europe/Kiev",
        "browserTimeZoneOffset": "-120",
        "browserLanguage": "ru-RU",
        "userAgent": "Mozilla/5.0 (Linux; Android 11; CPH2109 Build/RKQ1.200903.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/95.0.4638.74 Mobile Safari/537.36",
        "browserAcceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
        "browserIpAddress": "78.27.183.109",
        "screenWidth": "320",
        "screenHeight": "712",
        "javaEnabled": "false",
        "colorDepth": "24"
    }
}

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/Preauthorization' \
--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"
    },
    "sender": {
        "pan": "5248721588681850",
        "expiry": "2606",
        "cvc": "576",
        "senderCardName": "V1"
    },
    "pageData": {
        "language": "uk",
        "returnUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/pilot/finish.html",
        "failUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/pilot/finish.html"
    },
    "browserParams": {
        "browserTimeZone": "Europe/Kiev",
        "browserTimeZoneOffset": "-120",
        "browserLanguage": "ru-RU",
        "userAgent": "Mozilla/5.0 (Linux; Android 11; CPH2109 Build/RKQ1.200903.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/95.0.4638.74 Mobile Safari/537.36",
        "browserAcceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
        "browserIpAddress": "78.27.183.109",
        "screenWidth": "320",
        "screenHeight": "712",
        "javaEnabled": "false",
        "colorDepth": "24"
    }
}'

Responses

🟢200OK

application/json

Body

orderParam

object

required

orderStatus

integer

required

orderId

string

required

orderVerifyFlag

integer

required

orderAuthParam

object

required

fee

null

required

auth3DData

object

required

paReq

null

required

acsurl

string

required

creq

string

required

Example

{
    "orderParam": {
        "orderStatus": 0,
        "orderId": "677a1413-e59d-44d6-9a28-d2bc7208c27a",
        "orderVerifyFlag": 0,
        "orderAuthParam": {}
    },
    "fee": null,
    "auth3DData": {
        "paReq": null,
        "acsurl": "https://testacs.ukrcard.ua/acs/api/3ds2/creqbrw",
        "creq": "eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6ImQ1NjVkN2IwLTc5MzMtNDQ3Yi1hMTY4LWFhYjI4OTBhODUzMiIsImFjc1RyYW5zSUQiOiI5MmNkMDdkNy0xZWRmLTRlNGEtOTM4Ny1iNzNlOTQ1YWMwNTEiLCJjaGFsbGVuZ2VXaW5kb3dTaXplIjoiMDQiLCJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMS4wIn0="
    }
}

/Payment

/CancelPreauthorization