Створення замовлення

{{url}}/ecom/execute_request/hpp/v1/create-order

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

Параметр
Опиc
Формат даних
Обов'язковість
Приклад

merchantRequestId

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

string(36)

Так

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

merchantId

Id мерчанту згенерований в Єкомі

string(36)

Так

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

hppPayType

тип оплати

string

Так

Доступні значення -PURCHASE, A2A

directType

спосіб перенаправлення клієнта на платіжні сторінку

enum

Ні

  • REDIRECT - (по замовчуванню) редірект на сторінку HPP

  • BANK_LINK - редірект в мобільний додаток

expirationTimeMinutes

термін дії посилання

int (4) (значення передається в хвилинах)

Ні

1440

coinAmount

сума замовлення в копійках

long

Так

2000

paymentMethods

методи оплати

enum

Так

Доступні значення - CARD, APPLE_PAY, GOOGLE_PAY

language

мова платіжного віджета. ISO 639-1 2 digits

string (50)

Ні

Доступні значення : uk(за замовчуванням)

en,es,de,pl,fr,tr,it,nl,pt

notificationUrl

url, на який буде відправлено CallBack

string (1000)

Ні

https://merchant.notification_url

notificationEncryption

ознака криптування данних CallBack

string

Ні

Якщо параметр не передано або передано false, то дані в CallBack будуть не закриптовані

successUrl

url, для редіректу на сайт мерчанту при успішному статусі

string (1000)

Так

https://example.com/success

failUrl

url, для редіректу на сайт мерчанту при неуспішному статусі

string (1000)

Так

https://example.com/fail

statusPageType

тип сторінки статусу

enum

Так

Доступні значення:

  1. STATUS_TIMER_PAGE - сторінка за замовчуванням, якщо мерчант не обрав бажаний тип, таймер редірект автоматично 1 хвилина відображення статус сторінки з автоматичним редіректом юзера на сайт мерчанта (редірект урл)

  2. STATUS_REDIRECT_MERCHANT_PAGE - одразу редірект на урл мерчанта

  3. STATUS_PAGE - редірект, на нашу статус сторіншку (завантажити квитанцію …)

purpose

призначення платежу яке заповнює мерчант

string (255)

Ні

За товар

merchantComment

додаткова інформація\коментар мерчанта по замовленню

string(255)

a-zA-Z0-9 ,.;:@#$%'-=+1,256$ min 14, max 255 символів для hppPayType = A2A

Так, якщо hppPayType = A2A

merchant Comment id 1258728c1

priorityBankCode

id пріоритетного застосунку. Для генераціі QR НБУ

string

Ні

PRIVAT_BANK

Доступні значення

paymentCategoryGoal

категорія ціль. Для генераціі QR НБУ

string

Ні

MP2B/OTHR

generateQrNbu

ознака генераціі QR НБУ

boolean

Ні

true|false, default = false

customerData

об'єкт з customer даними

object

Так

senderCustomerId

Id клієнта відправника

string (255)

Так

1258728c1

senderFirstName

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

string (30)

  • значення не може містити виключно цифри

  • не може містити крапки та інші спецсимволи

  • не може містити “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”

  • дозволено приймати тільки літерно-цифрові значення

  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“

  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці

  • Для символу апострофу використовуйте єдиний доступний символ utf8 - ' який в: utf 16 - u0027 utf32 - 00000027

Ні

Іваненко

senderLastName

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

string (30)

  • значення не може містити виключно цифри

  • не може містити крапки та інші спецсимволи

  • дозволено приймати тільки літерно-цифрові значення

  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“

  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці

  • Для символу апострофу використовуйте єдиний доступний символ utf8 - ' який в: utf 16 - u0027 utf32 - 00000027

Ні

Іван

senderMiddleName

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

string (30)

  • значення не може містити виключно цифри

  • не може містити крапки та інші спецсимволи

  • дозволено приймати тільки літерно-цифрові значення

  • може приймати пробіл та дефіс, але НЕ може складатися виключно з “ “ или “-“

  • дефіс чи пробіл може бути всередині, але не може бути на початку чи кінці

  • Для символу апострофу використовуйте єдиний доступний символ utf8 - ' який в: utf 16 - u0027 utf32 - 00000027

Ні

Іванович

senderEmail

пошта відправника

string (256)

Ні

[email protected]

senderСountry

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

string (3) ISO 3166, 804 (Ukraine)

Ні

804

senderRegion

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

string (255)

Ні

Київська

senderСity

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

string (25)

Ні

Київ

senderStreet

вулиця відправника

string (35)

Ні

Січових стрільців

senderAdditionalAddress

додаткові дані адреси відправника (поверх, номер дому, квартира)

string (255)

Ні

23

senderItn

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

string (20)

Ні

123456789

senderPassport

паспорт відправника

string (255)

Ні

АН123456

senderIp

IPv4 адреса відправника

string (50)

Ні

123.12.12.12

senderPhone

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

string (20)

Ні

380630000000

senderBirthday

день народження відправника

string (50)

Ні

31.12.2000

senderGender

Гендер відправника

string (50)

Ні

Male/Female

senderZipCode

Індекс відправника

string (50)

Ні

49000

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

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

hppOrderId

Id замовлення

string

1764688635274xVtoUo7bDcn

merchantRequestId

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

string

64d9304-0368-11ed-b939-0242ac1221458

hppPayType

тип оплати

string

PURCHASE, A2A

paymentMethods

методи оплати

enum

CARD

orderStatus

статус замовлення

string

SUCCESS, FAIL, PENDING, REQUIRED_3DS, CANCELED, PARTIAL_REFUND

coinAmount

сума замовлення в копійках

long

2000

merchantId

Id мерчанту згенерований в Єкомі

string

37d9304-0368-11ed-b939-0242ac120002

expiredOrderDate

дата та час дії замовлення

string

2024-09-05 18:35:18.210+03:00

redirectUrl

  • посилання на перенаправлення клієнта на hpp сторінку

  • посилання на перенаправлення клієнта в мобільний додаток

string

  • {{url}}/?hpp_id=1728551936236-DAfCP7wrKT

  • {{url}}/?redirectUrl=https%3A%2F%2Fbankalliance.go.link%2Fecomc2a%3Forder_id%3D1762950448860FERkLl76lCp%26adj_t%3D1rknh2ig%26adj_deep_link%3Dbankalliance%253A%252F%252Fecomc2a%253Forder_id%253D1762950448860FERkLl76lCp

createDate

дата та час створення замовлення

string

2024-09-05 18:35:18.210+03:00

statusUrl

url для редіректу на сторінку статусу

string

{{url}}/?hpp_id=1728551936236-DAfCP7wrKT

nbuQrCode

url редіректу для відображення QR НБУ. Default: https://bank.gov.ua/qr/

string

https://bank.gov.ua/qr/QkNECjAwMwoxCklDVAoK0JrQvtCy0LDQu9GM0YHRjNC60LjQuSDQktC70LDQtNC40YHQu9Cw0LIg0KLQtdGB0YIKVUExMjMyMjAwMTAwMDAwMjYyMDYzNjM1MDU1MTMKVUFIMTAuMDAKMzQ2NzgwODE1MApNUDJCL09USFIKMTc2Mjk1MDQ0ODg2MEZFUmtMbDc2bENwCjEzN2Q5MzA0LTAzNjgtMTE9ZWI5MzkKUGF5bWVudCBmb3IgT3JkZXIg4oSWMTIzNDU2CkZGRkYKMjUxMTEyMTQ0MjI4CjI1MTExMjE0MjcyOAoK

Приклад тіла запиту hppPayType = PURCHASE:

Приклад тіла відповіді hppPayType = PURCHASE:

Приклад тіла запиту hppPayType = A2A та priorityBankCode = null:

Приклад тіла відповіді hppPayType = A2A та priorityBankCode = null::

Приклад тіла запиту hppPayType = A2A та priorityBankCode = PRIVAT_BANK:

Приклад тіла відповіді hppPayType = A2A та priorityBankCode = PRIVAT_BANK:

PreviousСтворення замовленняNextОтримання даних по замовленню

Last updated