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

Example

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

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/ConfirmExt' \
--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 '{
    "pageData": {
        "language": "uk"
    }
}'

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

ip

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