Отримання даних по інвойсу (Invoices show)

Метод для показу даних інвойсу

URI

POST api/invoicer/invoices/show

 

Запит:

Ключ

Опис

Тип

Обов'язковість

Приклад

Ключ

Опис

Тип

Обов'язковість

Приклад

params









sessionId

id сесії клієнта

string, uuid

так

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

id

id інвойсу

string, uuid

так

"6e391161-94ff-41a3-bd22-c6d77509bff6"


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

1 2 3 4 5 6 { "params": { "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c", "id": "5ecb426d-185b-40e8-857a-e40c9864e5de" } }


Відповідь:

Ключ

Опис

Тип

Приклад

Ключ

Опис

Тип

Приклад

status

Статус. 0 - помилка, 1 - успіх

integer

1

data







id

id інвойсу

string, uuid

1 "edacfce8-eb97-4f4f-8fa2-0fb044932ac3"

invoiceNumber

номер інвойсу

integer

14

clientId

id клієнта

integer

1

systemType

тип платіжної системи

string

"P2P"|"ECOM"|"BILLER"

amount

сума платежу

integer

100

reusability

параметр багаторазового використання інвойсу

boolean

true

description

опис призначення інвойсу

string

1 "тестовый платеж"

invoiceStatus

статус інвойсу

string

"ACTIVE" или "'INACTIVE'"

redirectUrl

адреса перенаправлення

string

1 "https://uapay.ua"

callbackUrl

адреса відправки пост-відповідей

string

1 "http://ptsv2.com/t/test_server/post"

createdAt

дата створення інвойсу

integer

1 "2018-09-07T16:53:21.000Z"

type

тип інвойсу

string

"PAY", "HOLD", "SUBSCRIBE"

email

електронна пошта, задана при створенні інвойсу

string

"test@uapay.ua"

extraInfo

поле для передачі додаткової інформації щодо інвойсу

object

1 {"base":true,"origin":"invoicer","email":"test@ukr.net"}

serviceData[].{}

масив даних по сервісах (тільки для systemType = "ECOM", крім type = "SUBSCRIBE")

['serviceId','destination','destinationName','account','mfo','okpo','bankName','description','amount']





payments

дані щодо платежів за цим інвойсом

array

"[ ]"

payments[].{}

об'єкт з даними за платежами

['invoiceId','paymentId','number', 'receiptId', 'amount','commission','currency','cardFromMasked','cardToMasked','cardFromId','cardToId','sendOperationId', 'receiveOperationId','paymentStatus','status','paidAt','reversedAt','finishedAt','canceledAt','createdAt','updatedAt', 'chequeLink']





clientName

назва клієнта

string

1 "UAPAY"

cardToId

id карти зарахування

string, uuid

1 "91c78d52-4a28-4c1e-ac5a-079ca5cd029c"

recurringData

дані за рекурентними платежами

object



recurringData.{}.endSubscribeDate

Дата завершення підписки

string

1 "2018-09-12"

recurringData.{}.prevPaymentDate

Дата останнього платежу по інвойсу

string

1 "2018-09-11 09:00:03"

recurringData.{}.nextPaymentDate

Дата наступного платежу по інвойсу

string

1 "2018-09-12"


Возможные статусы платежей:

Статус

Описание

Статус

Описание

FINISHED

Платіж завершено успішно, гроші відправлено одержувачу

HOLDED

Необхідно підтвердження. Для завершення списання коштів потрібно виконати підтвердження.

CANCELED

Процес оплати не завершений та платіж був відхилений (обірвалося з'єднання, платіж зупинений на проміжному етапі з вини платника).

REVERSED

Платіж повернуто, кошти повернулися відправнику.

REJECTED

Платіж не відбувся з технічних причин.

NEEDS_CONFIRMATION

Платіж очікує підтвердження (лукап або 3ds).

PENDING

Платіж знаходиться в стані оплати (проміжний статус)


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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 { "status": 1, "data": { "id": "7757c47c-8d70-4089-ab6e-82515f8f6f07", "invoiceNumber": 1870, "clientId": 1, "clientName": "UAPAY", "description": "Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР;Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР;Информационные услуги", "systemType": "ECOM", "amount": 13500, "reusability": false, "invoiceStatus": "ACTIVE", "type": "PAY", "serviceData": [ { "serviceId": 1, "destination": "Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР", "destinationName": "Казначейство", "description": "Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР", "amount": 7800, "commission": 534 }, { "serviceId": 2, "destination": "Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР", "destinationName": "Онлайн Дом Юстиции", "description": "Адміністративний збір за проведення державної реєстрації змін до відомостей в ЄДР", "amount": 4200, "commission": 30 }, { "serviceId": 4, "destination": "Информационные услуги", "destinationName": "Онлайн Дом Юстиции", "description": "Информационные услуги", "amount": 1500, "commission": 0 } ], "redirectUrl": "http://uapay.ua/", "callbackUrl": "http://example.com/", "extraInfo": { "origin": "invoicer" }, "cardToId": null, "createdAt": "2018-11-30T11:42:39.000Z", "payments": [ { "invoiceId": "7757c47c-8d70-4089-ab6e-82515f8f6f07", "paymentId": "b3b67d90-a0a7-4861-a3bb-b91889452823", "number": 2175, "receiptId": "E76EZFQFK2FE", "amount": 13500, "commission": 564, "currency": "980", "cardFromMasked": "5269615505", "cardFromId": "9ac4999f-79ea-40f0-9227-ef5417573c5b", "paymentStatus": "FINISHED", "status": "FINISHED", "finishedAt": "2018-11-30T11:45:37.000Z", "createdAt": "2018-11-30T11:44:38.000Z", "updatedAt": "2018-11-30T11:45:37.000Z", "chequeLink": "https://api.zero.uapay.ua/api/acquiring/receipts/v2/b3b67d90-a0a7-4861-a3bb-b91889452823.pdf" } ], "recurringData": {} } }