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

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

Owned by Ihor Balimasov
Last updated: 157 47, 2020 by Galina Savenko (Unlicensed)
3 min read

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

URI

POST api/invoicer/payments/show


Запит:

КлючОписТипОбов'язковістьПриклад
params



sessionIdid сесії клієнтаstring, uuidтак"000ab70b-ef76-4385-a0f5-a98693c716f1"
paymentIdid платежу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"
paymentIdid платежуstring, uuid"08eff720-9432-4951-a698-94e24db59e66"
numberномер інвойсуinteger14
receiptIdномер квитанціїstring"Q1URF9TQMKDE"
clientIdid клієнтаinteger1
systemTypeтип платіжної системиstring"P2P"/"ECOM"
amountсума платежуinteger100
commissionкомісіяinteger0
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"
invoiceдані за інвойсомobject
invoice.idідентифікатор інвойсуstring, uuid
"edacfce8-eb97-4f4f-8fa2-0fb044932ac3"
invoice.numberномер інвойсуinteger14
invoice.clientIdідентифікатор клієнта інвойсуinteger1
invoice.amountсума інвойсуinteger100
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параметр багаторазового використання інвойсуbooleantrue
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,
        "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