/Confirm

Developing

Cloud Mock

https://mock.apidog.com/m1/483896-0-default

POST

/Confirm

Maintainer:Not configured

Запит /Confirm використовується для отримання статусу зареєстрованого замовлення.

Request

Header Params

ExtSystemid

string

required

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

Example:

ECOM_GOLD_BANK

string

required

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

Example:

SECURE_LOGIN

password

string

required

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

Example:

SECURE_PASSWORD

orderNumber

string

required

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

Example:

1234

orderId

string

optional

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

Example:

dbafea6c-3394-4f6a-a0d2-21d3d8e93e42

RegDate

string

required

Дата/час запиту у форматі yyyy-MM-dd HH:mm:ss

Example:

2023-09-12 12:16:00

x-uws-clientdn

string

required

Зазначене значення має дорівнювати значенню, указаному в полі Common Name (CN) для сертифіката SSL клієнта

Example:

GOLDENBANK

Content-Type

string

optional

application/json;charset=UTF-8

Example:

application/json

charset

string

optional

UTF-8

Example:

UTF-8

string

required

application/json

Example:

application/json

Body Params application/json

pageData

object

required

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

language

string

optional

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

Example

{
  "pageData": {
    "language": "ua"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/483896-0-default/Confirm' \
--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: UTF-8' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"pageData":{"language":"ua"}}'

Responses

🟢200Success

application/json

Body

orderParam

object

required

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

orderStatus

integer

required

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

orderId

string

required

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

orderVerifyFlag

integer

required

Ознака способу автентифікації операції
0 - 3Ds автентифікація;
1 - Аутентифікація через otp пароль тільки для НПС «ПРОСТІР»
null або параметр відсутній - відсутня 3D аутентифікація

orderAuthParam

object

required

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

fee

object | null

optional

Дані про комісію. Може бути відсутнім,

feeAmount

string

optional

Сумма комісії.

Example:

"feeAmount": "7880"

feeCurrency

string

optional

Валюта комісії.

Example:

"feeCurrency": "980"

auth3DData

object

required

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

acsurl

string

required

Адреса ACS емітента, на який необхідно виконати переадресацію браузера клієнта для проходження процедури 3-D Secure аутентифікації.

paReq

null

required

PaReq - повідомлення, згенероване EPG. Дане повідомлення має бути надіслано ACS url для проходження процедури 3-D Secure аутентифікації емітентом.

creq

string

required

Challenge Request message (cReq).
Повідомлення EMV 3-D Secure, що надсилається 3DS SDK або сервером 3DS, в якому від власника картки в ACS надсилається додаткова інформація для підтримки процесу аутентифікації. Він повинен бути присутнім для 3-D Secure 2, якщо потрібна перевірка власника картки.

tokenifo

object

required

Інформація по операції за участю токена

tokenid

integer

required

Внутрішній ідентифікатор
JWT платіжного токену

tokenexpiry

string

required

ISO-8601 timestamp (yyyy-mm-ddThh:mm:ss). Строк дії JWTтокену. Приклад: 2099-12-31T00:00:00.

Match pattern:

yyyy-mm-ddThh:mm:ss

token

string

optional

JWT платіжний токен

<= 1000 characters

Examples

SuccessException

{
  "orderParam": {
    "orderStatus": 2,
    "orderId": "28730d8f-7d8f-42fc-876d-98ec89215703",
    "orderAuthParam": {
      "approvalCode": "156032",
      "authCode": 2
    }
  },
  "fee": {
    "feeAmount": "220",
    "feeCurrency": "980"
  },
  "auth3DData": {
    "acsurl": null,
    "paReq": null,
    "creq": null
  },
  "tokeninfo": {
    "tokenid": "294685",
    "tokenexpiry": "2024-10-19T16:07:06",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJwYW5DbGllbnQiLCJpZCI6IjY3MGUzMGJhNzMyYjc0YmVmMmZkNjM3OCIsInBhbl9tYXNrIjoiNTEyNzQzKioqKioqMjg5MCIsImV4cGRhdGUiOiIyOTA3IiwiY29uZl9kYXRhIjoiMWViMDUwYjJhNDE5OTI2YTRjZDk1MzdjM2M4NTczODc1ODE2YTgwYmY3ZjIzMWU2OTQ1OWEzNDliZjI2MTU4YzBlMDM4ODVhMjE5YzYyNWViNThiYzVkNmMyZjIxOTFkYTkzMWJlMDE5NmNlMTIzY2IzOWU5ODgzYzZhYTFiNjgxZDhhZWZkY2I4YTk2YzRiNDA5MzI1Y2JlYTFjNzYyNDUzNDgzZTViZDJmOTdiMjk1YjViY2ZmMDUxZGQxODM3OTRmNWYwNDdmYWEyZDU4MmJiOGViMWU2ZTNlNTk2ZjVjYjQ5MzMwZDJkN2E0NGJhMTQ0MDdmODYyYjJhYjZkOSIsInN1YiI6IjI5NDY4NSNNeSBjYXJkIGZvciBaUCM1MTI3IyMjIyMjMjg5MCMiLCJleHAiOjE3MjkzNDMyMjZ9.GhQVizQxLRy-0rB-CN5ePOtTF8-6zN6rqDoKgpDnskI"
  }
}

/p2pTransfer

/ConfirmExt