/Verify - Ukrcard

Request

Header Params

ExtSystemid

string

required

Ідентифікатор зовнішньої системи, яка сформувала запит. Ідентифікатор погоджується з УКРКАРТ під час реєстрації ЗС

<= 50 characters

Example:

ECOM_GOLD_BANK

login

string

required

Логін ЗС у системі, отриманий від УКРКАРТ при підключенні

<= 30 characters

Example:

SECURE_LOGIN

password

string

required

Пароль ЗС у системі, отриманий від УКРКАРТ при підключенні

>= 5 characters<= 30 characters

Example:

SECURE_PASSWORD

orderNumber

string

required

Номер (ідентифікатор) операції у зовнішній системі. Значення має бути унікальним для кожної системи в її межах.

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

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

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

language

string

optional

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

returnUrl

string

optional

Адреса, на яку треба перенаправити користувача за успішної оплати. Адреса повинна бути вказана повністю, включаючи протокол, що використовується (наприклад, "https://test.ua" замість test.ua). В іншому випадку, користувач буде перенаправлений за адресою за умовчанням

failUrl

string

required

Адреса, на яку потрібно перенаправити користувача у разі неуспішної оплати. Адреса повинна бути вказана повністю, включаючи протокол, що використовується (наприклад, https://test.ua замість test.ua). В іншому випадку користувач буде перенаправлений за замовчуванням

verifyData

object

optional

Додаткові параметри операції. Використовується, якщо ЗС необхідно передавати специфічні параметри в ПЦ

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/483896-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"
  }
}