UAPAY - національний платіжний сервіс
Створення інвойсу (Invoice create)
Метод для створення інвойсу
URI
POST api/invoicer/invoices/create
Запит:
Ключ | Опис | Тип | Обов'язковість | Приклад |
---|---|---|---|---|
params | ||||
sessionId | id сесії клієнта | string, uuid | так | "613f7045-03a2-4bbb-8ff8-e2202e71d41f" |
systemType | тип системи оплати | string | так | "ECOM" або "P2P" |
data | ||||
externalId | зовнішній id (ідентифікатор в системі партнера) | string | так | "1500383075" |
type | тип операції | string | так | "PAY", "HOLD", "SUBSCRIBE" |
cardTo{}.id | id картки | string, uuid | так (якщо systemType = "P2P") | "b8220f46-8c28-4068-9488-2e1b37359b06" |
reusability | параметр багаторазового використання інвойсу | boolean | ні | true/false |
description | опис призначення інвойсу | string | так | "тестовый платiж" |
amount | сума платежу (у копійках) | integer | так (якщо type = "SUBSCRIBE") | 100 |
recurringInterval | інтервал проведення рекурентних платежів (в днях, до 366) | integer | так (якщо type = "SUBSCRIBE") | 1 |
expiresAt | дата закінчення дії рекуретних платежів (повинна бути більшою за поточну дату) | string | так (якщо type = "SUBSCRIBE") | "2030-01-01" |
redirectUrl | адреса перенаправлення; якщо не передавати - не буде виводитися користувачу кнопка “Перейти на сайт“ | string | ні | |
extraInfo | поле для передачі додаткової інформації щодо інвойсу | json | ні | "extraInfo":"{\"phoneFrom\":\"380971112233\",\"phoneTo\":\"380631112233\",\"cardToId\":\"216f8390-9abc-428d-89d6-7be50183afb5\"}" |
електронна пошта, на яку автоматично відправиться квитанція після успішної оплати, тільки для reusability = false | string | ні | "test@uapay.ua" | |
callbackUrl | адреса для відправки callback, деталі тут | string | ні | |
payExpiresAt | дата терміну дії оплати інвойсу (повинна бути більшою за поточну дату) | integer
string | ні | 1899712055 або "2021-07-28 15:00:00" |
services |
|
| ні |
|
serviceId | ід сервісу | integer | ні |
|
destination | опис призначення платежу | string | ні | "Призначення платежа 1" |
destinationName | додатковий опис, на користь кого здійснюється оплата | string | ні | "Отримувач1" |
description | опис замовлення, відображається в квитанції | string | ні | "Опис призначення замовлення" |
amount | сума в копійках | integer | ні | 1000 |
Приклад запиту з типом ECOM
{
"params": {
"sessionId": "613f7045-03a2-4bbb-8ff8-e2202e71d41f",
"systemType": "ECOM"
},
"data": {
"externalId": "1500383075",
"reusability": false,
"description": "тестовый платiж",
"amount": 100,
"redirectUrl": "https://uapay.ua",
"type": "PAY",
"extraInfo":"{\"phoneFrom\":\"380971112233\",\"phoneTo\":\"380631112233\",\"cardToId\":\"216f8390-9abc-428d-89d6-7be50183afb5\"}"
}
}
Приклад запиту з типом ECOM (мультисервiс)
{
"params": {
"sessionId": "613f7045-03a2-4bbb-8ff8-e2202e71d41f",
"systemType": "ECOM"
},
"data": {
"externalId": "1500383075",
"reusability": false,
"description": "Опис призначення замовлення",
"redirectUrl": "https://uapay.ua",
"type": "PAY",
"services": [
{
"serviceId": 1,
"destination": "Призначення платежа 1",
"destinationName": "Отримувач1",
"description": "Опис призначення замовлення (відображається в квитанції)",
"amount": 1000
},
{
"serviceId": 2,
"destination": "Призначення платежа 2",
"destinationName": "Отримувач2",
"description": "Опис призначення замовлення (відображається в квитанції)",
"amount": 2000
}
]
}
}
Приклад запиту з типом ECOM (динамічний)
{
"params": {
"sessionId": "613f7045-03a2-4bbb-8ff8-e2202e71d41f",
"systemType": "ECOM"
},
"data": {
"externalId": "1500383075",
"reusability": false,
"description": "тестовый платiж",
"redirectUrl": "https://uapay.ua",
"type": "PAY",
"services": [
{
"serviceId": 1,
"iban": "UA461234560000026002001304675",
"okpo": "12345678",
"destination": "Адміністративний збір1",
"destinationName": "Отримувач1",
"bankName": "ПАТ Банк",
"description": "Адміністративний збір1",
"amount": 1000
}
]
}
}
Приклад запиту з типом ECOM (рекурентний платіж, type = "SUBSCRIBE")
Приклад запиту з типом ECOM (відкрита сума)
Приклад запиту з типом P2P
Відповідь:
Ключ | Опис | Тип | Приклад |
---|---|---|---|
status | Статус. 0 - помилка, 1 - успіх | integer | 1 |
data | |||
id | id інвойсу | string, uuid | "d754517b-7138-46c3-9ce2-f4857910b120" |
paymentPageUrl | адреса сторінки платежу | string | "https://payment.demo.uapay.ua/i/d754517b-7138-46c3-9ce2-f4857910b120" |
paymentPageUrlQR | адреса QR коду сторінки | string | "https://api.demo.uapay.ua/api/qr/invoicer/d754517b-7138-46c3-9ce2-f4857910b120" |
Приклад вiдповiдi
UAPAY - національний платіжний сервіс
pay@uapay.ua