/ConfirmExt - Ukrcard

/ConfirmExt` використовується для отримання розширеного статусу зареєстрованого замовлення.

Життєвий цикл всіх запитів за замовчуванням у наших системах 20 хвилин.
Тобто якщо через 20 хвилин після оригінального запиту на запит розширеного статусу ви отримуєте будь-яку відповідь, то штатно вона вже не зміниться.
Тому нема ніякого сенсу виконувати протягом декількох днів перезапити статуса.
Рекомендуємо робити перепитування з часом, що збільшується, між перезапитами (5с, 10с, 15с, 30с, 1хв, 1 хв, 2 хв, 3 хв, 5 хв, 10 хв) до закінчення часу життя запиту тобто до 20 хвилин, або раніше, якщо отримано фінальний статус.
Тобто зазвичай перепитування статусів роблять кількістю від 1 до 10.

Request

Header Params

ExtSystemid

string

required

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

<= 50 characters

Example:

ECOM_GOLD_BANK

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

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

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

Example

{
    "pageData": {
        "language": "uk"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

orderParam

object

required

Реєстраційні дані операції

orderStatus

integer

required

Стан операції

>= 0<= 6

orderId

string

required

Унікальний ідентифікатор операції у системі. Автоматично надається системою при обробці запиту на реєстрацію замовлення

>= 36 characters<= 36 characters

Example:

1c01e06f-c3da-4afe-94d4-8de1311c720f

orderVerifyFlag

integer

optional

Не заповнюється

orderAuthParam

object

required

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

orderStatusExtParam

object

required

Розширені дані статусу

errorMessage

string

required

Опис помилки

<= 512 characters

orderId

string

required

currency

string

required

amount

string

required

string

required

date

string

required

authDateTime

string

required

authRefNum

string

required

Reference number

terminalId

string

required

Id терміналу

orderStatus

string

required

orderNumber

string

required

>= 32 characters<= 32 characters

actionCode

string

required

actionCodeDescription

string

required

<= 512 characters

cardAuthInfo

object

required

errorcode

integer

required

orderDescription

string

required

cardAuthInfo

object

optional

Інформаційний блок, що містить інформацію по карті

pan

string

optional

Маскований номер картки, яка використовувалась для оплати. Вказано лише після оплати замовлення

expiration

string

optional

Термін закінчення дії картки у форматі YYYYMM. Вказано лише після оплати замовлення

<= 6 characters

Match pattern:

YYYYMM

cardholderName

string

optional

Ім'я тримача карти

<= 64 characters

approvalCode

string

optional

Код авторизації

<= 10 characters

merchantOrderParams

object

optional

attributes

object

optional

authRefNum

string

optional

Reference number

<= 24 characters

terminalId

string

optional

Id терміналу

refunds

object

optional

Інформація про повернення

referenceNumber

string

optional

Ідентифікатор операції

actionCode

string

optional

Код дії

amount

string

optional

Сума повернення

approvalCode

string

optional

Код підтвердження

date

string

optional

Дата операції

Example

{
    "orderParam": {
        "orderStatus": 2,
        "orderId": "d44311b0-511f-4ad2-9906-45c2c65e9866",
        "orderAuthParam": {
            "approvalCode": "760470",
            "authCode": 2
        }
    },
    "orderStatusExtParam": {
        "errorMessage": "Успешно",
        "orderId": "d44311b0-511f-4ad2-9906-45c2c65e9866",
        "currency": 980,
        "amount": "111790",
        "ip": "10.0.11.30",
        "date": "1710852310691",
        "authDateTime": "1710852310838",
        "authRefNum": "000340671081",
        "terminalId": "I5176114",
        "orderStatus": 2,
        "orderNumber": "0fe7cfd46a6741429107772220075a09",
        "actionCode": 0,
        "actionCodeDescription": "Запрос успешно обработан",
        "cardAuthInfo": {
            "pan": "516780**9258",
            "expiration": "202507",
            "cardholderName": "TEXT",
            "authorizationResponseId": "760470",
            "secureAuthInfo": null
        },
        "bankInfo": {
            "bankName": null,
            "bankCountryCode": null,
            "bankCountryName": "<Неизвестно>"
        },
        "paymentAmountInfo": {
            "approvedAmount": "111790",
            "depositedAmount": "111790",
            "refundedAmount": "0",
            "paymentState": "DEPOSITED"
        }
    }
}