/Preauthorization

POST

/Preauthorization

The Preauthorization request is used to complete 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

Body Params application/json

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 Code 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/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

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

Modified at 2025-06-26 12:33:41

/Payment

/CancelPreauthorization