API Reference

v2 (перехід з 29/07)

Postback після оплати

Схема Postback

{
    "id": "bb818bfc-360d-421f-85d9-d29cbc56f895",
    "status": "paid",
    "paytype": "card",
    "created_at": "2025-07-24T12:38:14.409+00:00",
    "metadata": null,
    "client_first_name": "Марія",
    "client_last_name": "Москаленко",
    "client_patronymic": null,
    "client_phone": "+380989554740",
    "client_email": null,
    "client_ip": "10.0.0.2",
    "external_id": "RE123654789",
    "terminal_name": null,
    "RRN": "8415557",
    "processing_result": "Successful",
    "amount": 11,
    "delivery": {
        "recipient_city": "1b009444-4e4a-11ed-a361-48df37b92096",
        "recipient_city_description": "с. Абранка",
        "recipient_warehouse": "cb7a3e6a-4f93-11ed-9eb1-d4f5ef0df2b8",
        "recipient_warehouse_description": "Пункт приймання-видачі (до 30 кг): вул.  б/н 46",
        "recipient_address": "с. Абранка, Пункт приймання-видачі (до 30 кг): вул.  б/н 46"
    },
    "products": [
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        }
    ],
    "card_details": {
        "pan": "413417xxxx0292",
        "card_bank": "OTP BANK JSC",
        "card_country": "UKR",
        "card_type": "VISA"
    }
}

Опис параметрів

ПараметрОпис
idУнікальний ідентифікатор сесії.
statusСтатуси оплати описані тут (paid, holded, тощо).
paytypeТип оплати (cash_on_delivery, card, applepay, тощо).
created_atДата та час створення операції.
metadataДодаткові мета-дані.
client_first_nameІм’я клієнта.
client_last_nameПрізвище клієнта.
client_patronymicПо-батькові клієнта.
client_phoneНомер телефону клієнта.
client_emailЕлектронна пошта клієнта.
client_ipІР-адреса платника.
external_idЗовнішній ідентифікатор замовлення.
terminal_nameІдентифікатор платіжного термінала.
RRN(Reference Retrieval Number) — генерується платіжним провайдером (PSP) і використовується для ідентифікації транзакції.
processing_resultОпис статусу обробки (процесінгу).
amountСума замовлення.
deliveryІнформація про доставку.
recipient_cityІдентифікатор міста отримувача.
recipient_city_descriptionНазва міста отримувача.
recipient_warehouseІдентифікатор відділення отримувача.
recipient_warehouse_descriptionОпис відділення отримувача.
recipient_addressПовна адреса доставки для отримувача.
productsСписок товарів у замовленні.
countКількість одиниць товару.
imageПосилання на зображення товару.
priceЦіна за одиницю товару.
descriptionОпис товару.
card_detailsМасив деталей картки.
panМаскований номер платіжної картки.
card_bankНазва банку-емітента картки.
card_countryЧисловий код країни, в якій було видано картку.
card_typeТип платіжної системи картки.

Postback після створення експрес-накладної

Схема Postback

{
    "id": "bb818bfc-360d-421f-85d9-d29cbc56f895",
    "status": "paid",
    "paytype": "card",
    "created_at": "2025-07-24T12:38:14.409+00:00",
    "metadata": null,
    "client_first_name": "Марія",
    "client_last_name": "Москаленко",
    "client_patronymic": null,
    "client_phone": "+380989554740",
    "client_email": null,
    "client_ip": "10.0.0.2",
    "external_id": "RE123654789",
    "terminal_name": null,
    "RRN": "8415557",
    "processing_result": "Successful",
    "amount": 11,
    "delivery": {
        "express_waybills": [
            "20400468684981"
        ],
        "recipient_city": "1b009444-4e4a-11ed-a361-48df37b92096",
        "recipient_city_description": "с. Абранка",
        "recipient_warehouse": "cb7a3e6a-4f93-11ed-9eb1-d4f5ef0df2b8",
        "recipient_warehouse_description": "Пункт приймання-видачі (до 30 кг): вул.  б/н 46",
        "recipient_address": "с. Абранка, Пункт приймання-видачі (до 30 кг): вул.  б/н 46"
    },
    "products": [
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        }
    ],
    "card_details": {
        "pan": "413417xxxx0292",
        "card_bank": "OTP BANK JSC",
        "card_country": "UKR",
        "card_type": "VISA"
    }
}

Опис параметрів

ПараметрОпис
idУнікальний ідентифікатор сесії.
statusСтатуси оплати описані тут (paid, holded, тощо).
paytypeТип оплати (cash_on_delivery, card, applepay, тощо).
created_atДата та час створення операції.
metadataДодаткові мета-дані.
client_first_nameІм’я клієнта.
client_last_nameПрізвище клієнта.
client_patronymicПо-батькові клієнта.
client_phoneНомер телефону клієнта.
client_emailЕлектронна пошта клієнта.
client_ipІР-адреса платника.
external_idЗовнішній ідентифікатор замовлення.
terminal_nameІдентифікатор платіжного термінала.
RRN(Reference Retrieval Number) — генерується платіжним провайдером (PSP) і використовується для ідентифікації транзакції.
processing_resultОпис статусу обробки (процесінгу).
amountСума замовлення.
deliveryІнформація про доставку.
express_waybillsСписок номерів експрес-накладних.
recipient_cityІдентифікатор міста отримувача.
recipient_city_descriptionНазва міста отримувача.
recipient_warehouseІдентифікатор відділення отримувача.
recipient_warehouse_descriptionОпис відділення отримувача.
recipient_addressПовна адреса доставки для отримувача.
productsСписок товарів у замовленні.
countКількість одиниць товару.
imageПосилання на зображення товару.
priceЦіна за одиницю товару.
descriptionОпис товару.
card_detailsМасив деталей картки.
panМаскований номер платіжної картки.
card_bankНазва банку-емітента картки.
card_countryЧисловий код країни, в якій було видано картку.
card_typeТип платіжної системи картки.

Postback після невдалого створення експрес-накладної

Схема Postback

{
    "id": "abdf53cc-0036-44b8-a0a2-c30e7c669a78",
    "status": "paid",
    "paytype": "card",
    "created_at": "2025-07-24T12:39:49.196+00:00",
    "metadata": null,
    "client_first_name": "Марія",
    "client_last_name": "Москаленко",
    "client_patronymic": null,
    "client_phone": "+380989554740",
    "client_email": null,
    "client_ip": "10.0.0.2",
    "external_id": "RE123654789",
    "terminal_name": null,
    "RRN": "8415564",
    "processing_result": "Successful",
    "amount": 11,
    "delivery": {
        "ew_fail_reason": [
            "API key expired"
        ],
        "recipient_city": "f4d95497-de39-11ea-80fb-b8830365bd04",
        "recipient_city_description": "с. Абрикосівка (Хмельницька обл.)",
        "recipient_warehouse": "4b7ce154-e14a-11ea-b39d-b8830365bd14",
        "recipient_warehouse_description": "Пункт приймання-видачі (до 30 кг): вул. Центральна, 32",
        "recipient_address": "с. Абрикосівка (Хмельницька обл.), Пункт приймання-видачі (до 30 кг): вул. Центральна, 32"
    },
    "products": [
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        },
        {
            "count": 1,
            "image": "https://images.unsplash.com/photo-1503236823255-94609f598e71?q=80&w=2069&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
            "price": 1700,
            "description": "Eveline Cosmetics Wonder Match тональний крем з гіалуроновою кислотою та термальною водою для бездоганного покриття"
        }
    ],
    "card_details": {
        "pan": "413417xxxx0292",
        "card_bank": "OTP BANK JSC",
        "card_country": "UKR",
        "card_type": "VISA"
    }
}

Опис параметрів

ПараметрОпис
idУнікальний ідентифікатор сесії.
statusСтатуси оплати описані тут (paid, holded, тощо).
paytypeТип оплати (cash_on_delivery, card, applepay, тощо).
created_atДата та час створення операції.
metadataДодаткові мета-дані.
client_first_nameІм’я клієнта.
client_last_nameПрізвище клієнта.
client_patronymicПо-батькові клієнта.
client_phoneНомер телефону клієнта.
client_emailЕлектронна пошта клієнта.
client_ipІР-адреса платника.
external_idЗовнішній ідентифікатор замовлення.
terminal_nameІдентифікатор платіжного термінала.
RRN(Reference Retrieval Number) — генерується платіжним провайдером (PSP) і використовується для ідентифікації транзакції.
processing_resultОпис статусу обробки (процесінгу).
amountСума замовлення.
deliveryІнформація про доставку.
ew_fail_reasonСписок можливих причин відмови створення ЕН.
recipient_cityІдентифікатор міста отримувача.
recipient_city_descriptionНазва міста отримувача.
recipient_warehouseІдентифікатор відділення отримувача.
recipient_warehouse_descriptionОпис відділення отримувача.
recipient_addressПовна адреса доставки для отримувача.
productsСписок товарів у замовленні.
countКількість одиниць товару.
imageПосилання на зображення товару.
priceЦіна за одиницю товару.
descriptionОпис товару.
card_detailsМасив деталей картки.
panМаскований номер платіжної картки.
card_bankНазва банку-емітента картки.
card_countryЧисловий код країни, в якій було видано картку.
card_typeТип платіжної системи картки.