For the complete documentation index, see llms.txt. This page is also available as Markdown.

CallBack

Система надсилає callback на URL, який був вказаний при створенні підписки, у трьох випадках:

Подія

Коли надсилається

Зміна статусу підписки

Після зміни статусу підписки на фінальний

Інітний платіж

Після завершення першого платежу (успіх/помилка)

Recurring списання

Після кожного автоматичного або ручного списання

Вихідні параметри:

Параметр
Опис
Формат даних
Приклад

ecomOrderId

Унікальний ідентифікатор ордера в системі ecom

UUID (string)

"216d0a89-0153-49e3-a120-442d6c64d094"

coinAmount

Сума ордера в мінімальних одиницях валюти (копійках). Для SUBSCRIPTION-ордерів = 0, оскільки сума визначається версією плану

integer

0

merchantId

Унікальний ідентифікатор мерчанта

UUID (string)

"137d9304-0368-11ed-b939-0242ac120002"

statusUrl

URL для перевірки статусу ордера (для SUBSCRIPTION не використовується)

string | null

null

hppOrderId

Внутрішній ідентифікатор ордера в HPP-системі

string

"1783608520205P81ch623POH"

redirectUrl

URL для редіректу клієнта після оплати

string | null

null

notificationUrl

URL мерчанта, на який надсилається callback

string (URL)

"https://webhook.site/6f05f573-..."

notificationEncryption

Прапорець, чи зашифровано тіло callback

boolean

false

hppPayType

Тип платіжного флоу ордера

enum: SUBSCRIPTION

"SUBSCRIPTION"

hppDirectType

Тип взаємодії з HPP

enum: REDIRECT, DIRECT

"REDIRECT"

merchantRequestId

Ідентифікатор запиту від мерчанта (ідемпотентність ордера)

UUID (string)

"64fe98ab-9731-48aa-b855-78c28e797aef"

createDate

Дата та час створення ордера

ISO 8601 datetime з timezone

"2026-07-09 17:48:40.26+03:00"

paymentMethods

Дозволені методи оплати (для SUBSCRIPTION визначаються при інітному платежі)

array | null

null

orderStatus

Поточний статус ордера

enum: PENDING, SUCCESS

"PENDING"

expiredOrderDate

Дата закінчення терміну дії ордера (+10 років для підписок)

ISO 8601 datetime з timezone

"2036-07-06 18:03:40.20+03:00"

operation.type

Тип операції

enum: PURCHASE

"PURCHASE"

operation.rrn

Retrieval Reference Number — унікальний номер транзакції в платіжній мережі

string (12 цифр)

"619015619077"

operation.purpose

Призначення платежу

string

"Payment for food"

operation.comment

Коментар до операції

string

"testing Nick"

operation.coinAmount

Сума конкретного платежу в копійках

integer

100 (= 1.00 грн)

operation.merchantId

Ідентифікатор мерчанта

UUID (string)

"137d9304-0368-11ed-b939-0242ac120002"

operation.operationId

Внутрішній ідентифікатор операції в HPP

string

"1783609267213ROxtSXOXgFm"

operation.ecomOperationId

Унікальний ідентифікатор операції в ecom (задається мерчантом)

UUID (string)

"2b8c65e4-edef-4d62-becc-8fe8c166b0cc"

operation.merchantName

Назва мерчанта/терміналу

string

"KB test terminal"

operation.approvalCode

Код авторизації від банку-емітента

string (6 символів)

"007747"

operation.status

Статус операції

enum: SUCCESS, FAIL, IN_PROGRESS

"SUCCESS"

operation.transactionType

Тип транзакції (35 = EcomPurchase)

integer

35

operation.merchantRequestId

Ідентифікатор запиту мерчанта для цієї операції (ідемпотентність платежу)

UUID (string)

"8f989505-d8ee-402e-ae78-..."

operation.transactionCurrency

Код валюти транзакції за ISO 4217 (числовий)

string (3 цифри)

"980" (= UAH)

operation.creationDateTime

Дата та час створення операції

yyyy.MM.dd HH🇲🇲ss.SSS

"2026.07.09 18:01:07.271"

operation.modificationDateTime

Дата та час останньої зміни статусу

yyyy.MM.dd HH🇲🇲ss.SSS

"2026.07.09 18:02:13.061"

operation.processingDateTime

Дата та час обробки транзакції процесингом

yyyy.MM.dd HH🇲🇲ss.SSS

"2026.07.09 18:01:08.000"

operation.transactionResponseInfo.actionCode

Код дії від процесингу ("0" = успіх)

string

"0"

operation.transactionResponseInfo.responseCode

Код відповіді від процесингу ("00" = approved)

string (2 символи)

"00"

operation.transactionResponseInfo.description

Текстовий опис результату

string

"approved"

operation.bankCode

Код банку-еквайера

string

"BANK_ALLIANCE"

operation.paymentSystem

Платіжна система картки

string

"MasterCard"

operation.productType

Тип продукту операції

enum: PURCHASE

"PURCHASE"

operation.paymentServiceType

Тип платіжного сервісу

enum: CARD, TOKEN, APPLE_PAY, GOOGLE_PAY

"CARD"

operation.notificationEncryption

Чи зашифровано тіло callback на рівні операції

boolean

false

operation.notificationSignature

Чи підписано callback (для верифікації автентичності)

boolean

true

operation.hppOrderId

Ідентифікатор ордера, до якого належить операція

string

"1783608520205P81ch623POH"

operation.processingTerminalId

Ідентифікатор терміналу в процесингу

string

"AE001001"

operation.processingMerchantId

Ідентифікатор мерчанта в процесингу

string

"AE001001"

operation.creatorSystem

Система-ініціатор операції

string

"HPP"

operation.merchantComment

Коментар мерчанта при створенні операції

string

"Helllo World. Lets rock123"

operation.cardNumberMask

Маскований номер картки

string (PAN masked)

"53759310••••0349"

operation.desiredThreeDSMode

Бажаний режим 3DS (вказаний при створенні)

enum: MUST, MUST_NOT, OPTIONAL

"MUST_NOT"

operation.threeDSMode

Фактичний режим 3DS, який був застосований

enum: MUST, MUST_NOT, OPTIONAL

"MUST_NOT"

operation.senderCustomerId

Ідентифікатор клієнта в системі мерчанта

string

"Nikos"

operation.senderFirstName

Ім'я відправника

string

"Богдан"

operation.senderLastName

Прізвище відправника

string

"Карпусь"

operation.senderMiddleName

По батькові відправника

string

"Олександрович"

operation.senderEmail

Email відправника

string

"qtest@testor.com"

operation.senderCountry

Код країни за ISO 3166-1 (числовий)

string (3 цифри)

"804" (= Україна)

operation.senderRegion

Область / регіон

string

"Kiyivska"

operation.senderCity

Місто

string

"Kiyv"

operation.senderStreet

Вулиця

string

"khreshatuk"

operation.senderAdditionalAddress

Додаткова адреса

string

"Ukraine, Lviv, Arsenalna st."

operation.senderItn

ІПН (індивідуальний податковий номер)

string (10 цифр)

"3667709657"

operation.senderPassport

Серія та номер паспорта

string

"HE111999"

operation.senderIp

IP-адреса клієнта

string (IPv4)

"192.168.2.1"

operation.senderPhone

Номер телефону (без "+")

string

"380931234567"

operation.senderBirthday

Дата народження

string (dd.MM.yyyy)

"32.13.2050"

operation.senderGender

Стать

string

"Male"

operation.senderZipCode

Поштовий індекс

string

"18900"

operation.senderPaymentSystem

Платіжна система картки відправника

string

"MasterCard"

operation.senderCardNumberMask

Маскований номер картки відправника

string (PAN masked)

"53759310••••0349"

operation.senderBankCode

Код банку-емітента картки відправника

string

"BANK_ALLIANCE"

operation.externalCardToken

Токен картки для наступних recurring-списань

string

"cjy62IyteD4KMX9j-tGlxCYW"

operation.receiptUrl

URL для генерації квитанції за операцією

string (URL)

"https://defe-api.develop.bankalliance.ua/generate_receipt/..."

operation.scheduledPaymentId

Унікальний ідентифікатор запланованого платежу з графіку

UUID (string)

"64917dd4-ca06-44db-9eb2-99aba73ce2b9"

operation.paymentMethodType

Метод оплати, яким було проведено платіж

enum: CARD, TOKEN, APPLE_PAY_ENCRYPTED, APPLE_PAY_DECRYPTED, GOOGLE_PAY_ENCRYPTED, GOOGLE_PAY_DECRYPTED

"CARD"

operation.categorySubcategoryIndicator

Тип підписки за класифікацією МПС (Mastercard / Visa). Визначає категорію recurring-платежу

enum: C103, M103

"C103"

operation.recurringTransactionType

Тип recurring-транзакції: O — Original (інітний), M — Merchant-initiated (автоматичне списання)

enum: O, M

"O"

operation.isInitial

Прапорець, чи є цей платіж інітним (першим) у підписці

boolean

true

tryMode

Режим обробки платежів ордера

enum: MULTI_PAYMENT

"MULTI_PAYMENT"

Приклад відповіді

Останнє оновлення