Отримання даних по платежу (Invoices payments show)

UAPAY - національний платіжний сервіс

Отримання даних по платежу (Invoices payments show)

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

URI

POST api/invoicer/payments/show



Запит:

Ключ

Опис

Тип

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

Приклад

Ключ

Опис

Тип

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

Приклад

params









sessionId

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

string, uuid

так

"000ab70b-ef76-4385-a0f5-a98693c716f1"

paymentId

id платежу

string, uuid

так

"08eff720-9432-4951-a698-94e24db59e66"





Приклад запиту
{ "params": { "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c", "paymentId": "1c584ff0-b560-455f-a197-1ecaf3632fc4" } }





Відповідь:

Ключ

Опис

Тип

Приклад

Ключ

Опис

Тип

Приклад

status

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

integer

1

data







invoiceId

id інвойсу

string, uuid

"48cae638-2f4b-434c-aafa-a4b9ced4b486"

paymentId

id платежу

string, uuid

"08eff720-9432-4951-a698-94e24db59e66"

number

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

integer

14

receiptId

номер квитанції

string

"Q1URF9TQMKDE"

clientId

id клієнта

integer

1

systemType

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

string

"P2P"/"ECOM"

amount

сума платежу

integer

100

commission

комісія

integer

0

email

адреса електронної пошти для відправлення чеку

string

"invoice_test@uapay.ua"

status

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

string

"NEW"|"PAID"|"FINISHED"|"REVERSED"|"CANCELED"

paymentStatus

статус платежу в платіжній системі

string

"OPEN"|"PAYED"|"FINISHED"|"REVERSED"|"RETURNED"|"CLOSED"|"PENDING"|"REJECTED"|"HOLDED"|"CANCELED"|"NEEDS_CONFIRMATION"

cardFromId

ІД карти відпавника

string

"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"

cardFromMasked

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

string

"4444444444"

cardToId

ІД карти отримувача

string

"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"

cardToMasked

маска карти отримувача

string

"4444443333"

chequeLink

посилання на квитанцію

string

"api.uapay.ua/api/receipts/08eff720-9432-4951-a698-94e24db59e66"

createdAt

дата створення платежу

integer

"2018-09-11T08:21:39.000Z"

updatedAt

дата оновленя платежу

integer

"2018-09-11T08:21:39.000Z"

paidAt

дата зняття грошових коштів

integer

"2018-09-11T08:21:39.000Z"

reversedAt

дата повернення грошових коштів

integer

"2018-09-11T08:21:39.000Z"

finishedAt

дата зарахування грошових коштів

integer

"2018-09-11T08:21:39.000Z"

canceledAt

дата скасування платежу

integer

"2018-09-11T08:21:39.000Z"

extraPayerProvidedData

додаткові дані платника

object



extraPayerProvidedData.phone

номер телефону отриманий при створенні платежу

string

"380434343444"

extraPayerProvidedData.email

email отриманий при створенні платежу

string

"kjdskdj@dsdl.cl"

rrn

RRN платежу

string

"001014048213"

approvalCode

Код авторизації

string

"984019"

cardSchema

Тип картки

string

"visa", "mastercard", "prostir"

merchantId

ID мерчанта

string

"01002003DS00001"

terminalId

ID терміналу

string

"232535b6-2095-413e-ba57-12516d4df89a"

invoice

дані за інвойсом

object



invoice.id

ідентифікатор інвойсу

string, uuid

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

invoice.number

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

integer

14

invoice.clientId

ідентифікатор клієнта інвойсу

integer

1

invoice.amount

сума інвойсу

integer

100

invoice.description

опис інвойсу

string

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

invoice.status

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

string

"ACTIVE"

invoice.redirectUrl

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

string

"https://uapay.ua"

invoice.callbackUrl

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

string

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

invoice.externalId

зовнішній ідентифікатор

string, uuid

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

invoice.systemType

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

string

"P2P"|"ECOM"|"BILLER"

invoice.cardToId

ідентифікатор платіжної картки

string, uuid

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

invoice.reusability

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

boolean

true

invoice.serviceData

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

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

array



invoice.type

тип операції

string

"PAY", "HOLD", "SUBSCRIBE"

invoice.createdAt

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

string

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

invoice.updatedAt

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

string

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

invoice.email

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

string

"test@uapay.ua"

invoice.extraInfo

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

object

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





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

{ "status": 1, "data": { "invoiceId": "0e2a35e5-7cc8-49a2-bb12-3d9e684292f8", "paymentId": "e408a23f-982d-4557-97bb-96183056db22", "number": 2235, "receiptId": "Q1URF9TQMKDE", "amount": 100, "commission": 303, "cardFromId": "9457a090-7528-422e-8ec3-3d3d71c689ce", "cardFromMasked": "5355175521", "paymentStatus": "FINISHED", "status": "FINISHED", "createdAt": "2018-11-30T14:36:05.000Z", "updatedAt": "2018-11-30T14:36:26.000Z", "cardToId": null, "cardToMasked": null, "email": "pikcel.0512@gmail.com", "systemType": "ECOM", "clientId": 1, "chequeLink": "https://api.zero.uapay.ua/api/acquiring/receipts/v2/e408a23f-982d-4557-97bb-96183056db22.pdf", "paidAt": null, "reversedAt": null, "finishedAt": "2018-11-30T14:36:26.000Z", "canceledAt": null, "extraPayerProvidedData": { "phone": "380434343444", "email": "kjdskdj@dsdl.cl" }, "rrn": "001014048213", "approvalCode": "984019", "cardSchema": "mastercard", "merchantId": "01002003DS00001", "terminalId": "232535b6-2095-413e-ba57-12516d4df89a" "invoice": { "id": "0e2a35e5-7cc8-49a2-bb12-3d9e684292f8", "number": 1960, "clientId": 1, "amount": 100, "description": "test payment Anton", "status": "ACTIVE", "redirectUrl": "http://uapay.ua/", "callbackUrl": "http://example.com/", "externalId": "1", "systemType": "ECOM", "cardToId": null, "reusability": false, "serviceData": {}, "type": "PAY", "createdAt": 1543588513000, "updatedAt": 1543588513000, "extraInfo": { "origin": "invoicer" } } } }



UAPAY - національний платіжний сервіс
pay@uapay.ua