/Verify - Ukrcard en

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

<= 50 characters

Example:

ECOM_GOLD_BANK

login

string

required

External system login received from UKRKARD during registration

<= 30 characters

Example:

SECURE_LOGIN

password

string

required

External system password received from UKRKARD during registration

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

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

accept

enum<string>

required

application/json

Allowed value:

application/json

Content-Type

string

optional

application/json;charset=UTF-8

charset

string

optional

UTF-8

Body Params application/json

pageData

object

required

External system page data

language

string

optional

The language of the current page session

returnUrl

string

optional

URL to which the customer is redirected after a successful payment. The address must be specified in full, including the protocol used (for example, "https://test.ua" instead of test.ua). Otherwise, the user will be redirected to the default address

failUrl

string

required

Web address to which the customer is redirected if the payment fails. The address must be specified in full, including the protocol used (for example, https://test.ua instead of test.ua). Otherwise, the user will be redirected by default

verifyData

object

optional

Additional parameters of the operation. It is used if it is necessary to transfer specific parameters to the gate from the control system

paRes

string

optional

code

string

required

Example

{
    "sender": {
        "cvc": "***",
        "senderCardName": "Nicoleta Diaconu",
        "expiry": "2408",
        "pan": "51260000005678"
    },
    "orderData": {
        "amount": 30000,
        "description": "7777.md",
        "currency": 498
    },
    "pageData": {
        "language": "uk",
        "returnUrl": "https://paynet.md/acquiring/acquiringresult?id=8646997",
        "failUrl": "https://paynet.md/acquiring/acquiringresult?id=8646997"
    },
    "jsonParams": {
        "disableEmail": "true",
        "disablePhone": "true"
    },
    "browserParams": {
        "javascriptEnabled": true,
        "userAgent": "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Mobile Safari/537.36",
        "colorDepth": 24,
        "screenHeight": 892,
        "screenWidth": 412,
        "javaEnabled": false,
        "browserLanguage": "ro-MD",
        "browserTimeZone": "Europe/Chisinau",
        "browserAcceptHeader": "*/*",
        "browserIpAddress": "94.139.152.182",
        "browserTimeZoneOffset": 120
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mock.apidog.com/m1/537337-0-default/Verify' \
--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 'accept;' \
--header 'charset;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sender": {
        "cvc": "***",
        "senderCardName": "Nicoleta Diaconu",
        "expiry": "2408",
        "pan": "51260000005678"
    },
    "orderData": {
        "amount": 30000,
        "description": "7777.md",
        "currency": 498
    },
    "pageData": {
        "language": "uk",
        "returnUrl": "https://paynet.md/acquiring/acquiringresult?id=8646997",
        "failUrl": "https://paynet.md/acquiring/acquiringresult?id=8646997"
    },
    "jsonParams": {
        "disableEmail": "true",
        "disablePhone": "true"
    },
    "browserParams": {
        "javascriptEnabled": true,
        "userAgent": "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Mobile Safari/537.36",
        "colorDepth": 24,
        "screenHeight": 892,
        "screenWidth": 412,
        "javaEnabled": false,
        "browserLanguage": "ro-MD",
        "browserTimeZone": "Europe/Chisinau",
        "browserAcceptHeader": "*/*",
        "browserIpAddress": "94.139.152.182",
        "browserTimeZoneOffset": 120
    }
}'

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

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

fee

object | null

required

Дані про комісію. Може бути відсутнім, якщо не заповнений Param у разі перекладу p2p для якого не запитується комісія

feeAmount

string

optional

feeCurrency

string

optional

auth3DData

object

required

Дані, необхідні для виконання процедури 3-D Secure аутентифікації емітентом. Може бути відсутнім, якщо orderVerifyFlag = 1

acsurl

string

required

paReq

null

required

creq

string

required

Example

{
    "orderParam": {
        "orderStatus": 0,
        "orderId": "1c01e06f-c3da-4afe-94d4-8de1311c",
        "orderVerifyFlag": 0,
        "orderAuthParam": {
            "authCode": 0
        }
    },
    "fee": null,
    "auth3DData": {
        "acsurl": "https://acs.hu.bpcbt.com/acs/api/3ds2/creqbrw/9ccb9883-2d8a-4f45-8a20-9bf65560a394",
        "paReq": null,
        "creq": "eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjljY2I5ODgzLTJkOGEtNGY0NS04YTIwLTliZjY1NTYwYTM5NCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsIm1lc3NhZ2VWZXJzaW9uIjoiMi4yLjAiLCJhY3NUcmFuc0lEIjoiNGYyNjVkZGEtYmZjNC00ZTdjLWJiNGEtNTg4NzJkZWJkYWQ1IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjAyIn0"
    }
}