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

{{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

coinAmount

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

long

Так

2000

paymentMethods

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

enum

Так

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

language

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

string (50)

Ні

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

notificationUrl

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

string (1000)

Ні

https://merchant.notification_url

notificationEncryption

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

string

Ні

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

successUrl

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

string (1000)

Так

failUrl

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

string (1000)

Так

statusPageType

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

enum

Так

доступні значення - statusPage

purpose

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

string (255)

Ні

За товар

merchantComment

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

string(255)

a-zA-Z0-9 ,.;:@#$%'-=+1,256$

Ні

merchant Comment id 1258728c1

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)

Ні

senderСountry

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

string (3) ISO 3166, 804 (Ukraine)

Ні

804

senderRegion

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

string (255)

Ні

Київська

senderСity

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

string (25)

Ні

Київ

senderStreet

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

string (35)

Ні

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

senderAdditionalAddress

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

string (255)

Ні

senderItn

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

string (20)

Ні

123456789

senderPassport

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

string (255)

Ні

АН123456

senderIp

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

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

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

merchantRequestId

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

string

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

hppPayType

тип оплати

string

PURCHASE

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

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

string

createDate

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

string

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

statusUrl

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

string

Приклад тіла запиту

{
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "hppPayType": "PURCHASE",
    "failUrl": "https://example.com/fail",
    "successUrl": "https://example.com/success",
    "merchantRequestId": "137d9304-0368-11ed-b939-0241ac220104",
    "statusPageType": "STATUS_PAGE",
    "paymentMethods": [
        "CARD"
    ],
    "customerData": {
        "senderCustomerId": "Id ",
        "senderEmail": "aaaa@gmail.com",
        "senderMiddleName": "s",
        "senderRegion": "senderRegion",
        "senderCountry": "804",
        "senderAdditionalAddress": "senderAdditionalAddress",
        "senderStreet": "senderStret",
        "senderCity": "senderCity",
        "senderIp": "255.255.244.255",
        "senderBirthday": "22081989",
        "senderGender": "Female",
        "senderZipCode": "12345",
        "senderPassport": "passport",
        "senderItn": "5555557777",
        "senderPhone": "380957388888"
    },
    "coinAmount": 1000,
    "purpose": "Payment for Order №123456",
    "language": "uk",
    "notificationUrl": "https://example.com/notify"
}

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

{
    "coinAmount": 1000,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "statusUrl": "http://pgi-status-ecom-release.develop.bankalliance.ua/?hpp_id=1728551936236-DAfCP7wrKT",
    "hppOrderId": "1728551936236-DAfCP7wrKT",
    "redirectUrl": "http://pgi-ecom-release.develop.bankalliance.ua/?hpp_id=1728551936236-DAfCP7wrKT",
    "hppPayType": "PURCHASE",
    "merchantRequestId": "137d9304-0368-11ed-b939-0241ac220104",
    "orderStatus": "PENDING",
    "paymentMethods": [
        "CARD"
    ],
    "createDate": "2024-10-10 12:18:56.19+03:00",
    "expiredOrderDate": "2024-10-10 12:33:56.23+03:00"
}

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

Last updated 2 months ago