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

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

Метод для отримання основної інформації за масивом інвойсів. (В одному запиті не може міститись більш 100 (сто) платежів).

URI

POST /api/invoicer/invoices/show/list

Запит:

Ключ
Опис
Тип
Чи обов'язковий параметр?
Приклад
params



sessionIdid сесії клієнтаstring, uuidтак

"52be10d0-d094-4ede-b201-904783df5f8d"

externalIdsмасив Id у зовнішній системімасив stringякщо немає  id

["73737fa2-7130-8366-ab17-65ebbb359821",
"ce0c225b-b142-0ad0-3802-172b7598ea55"]

idsмасив  Id інвойсів в системі UAPAYмасив string, uuidякщо немає externalId["000c6d12-0d2e-4402-bf62-c474c92fc842",
"9251607b-e652-4d11-8f3c-91fc4b2b1427"]


Приклад запиту по id інвойса
{  
   "params":{  
      "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a",
      "ids":[  
         "000c6d12-0d2e-4402-bf62-c474c92fc842",
         "9251607b-e652-4d11-8f3c-91fc4b2b1427"
      ]
   }
}


Приклад запиту по зовнішньому id платежу
{  
   "params":{  
      "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a",
      "externalIds":[  
         "73737fa2-7130-8366-ab17-65ebbb359821",
         "ce0c225b-b142-0ad0-3802-172b7598ea55"
      ]
   }
}

Відповідь:


Ключ
Опис
Тип
Приклад
status

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

integer

1

data


invoices[].{}масив даних за інвойсамиarray

Id

id інвойсуstring, uuid
"edacfce8-eb97-4f4f-8fa2-0fb044932ac3"
externalIdid операції у зовнішній системіstring"004ce685-4948-407a-a11a-57151e8d1bd7"
invoiceNumberномер інвойсуinteger14
clientIdid клієнтаinteger1
systemTypeтип платіжної системиstring"P2P"|"ECOM"|"BILLER"
amountсума платежуinteger100
reusabilityпараметр багаторазового використання інвойсуbooleantrue
descriptionопис призначення інвойсуstring
"тестовый платеж"
invoiceStatusстатус інвойсуstring"ACTIVE" или "'INACTIVE'"
redirectUrlадреса перенаправленняstring
"https://uapay.ua"
callbackUrlадреса відправки пост-відповідейstring
"http://ptsv2.com/t/test_server/post"
createdAtдата створення інвойсуinteger
"2018-09-07T16:53:21.000Z"
typeтип інвойсуstring"PAY", "HOLD", "SUBSCRIBE"
emailелектронна пошта, задана при створенні інвойсуstring"test@uapay.ua"
extraInfoполе для передачі додаткової інформації щодо інвойсуobject
{"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
"UAPAY"
cardToIdid карти зарахуванняstring, uuid
"91c78d52-4a28-4c1e-ac5a-079ca5cd029c"



Приклад відповіді
{
    "status": 1,
    "data": {
        "invoices": [
            {
                "id": "0004cf22-3a80-475c-bee4-96d6417358a7",
                "externalId": "1500383075",
                "invoiceNumber": 723,
                "clientId": 1,
                "clientName": "UAPAY",
                "description": "Ліцензія",
                "tag": null,
                "systemType": "ECOM",
                "amount": 100,
                "reusability": true,
                "invoiceStatus": "ACTIVE",
                "type": "PAY",
                "serviceData": {},
                "redirectUrl": "https://uapay.ua",
                "callbackUrl": "http://ptsv2.com/t/test_server/post",
                "extraInfo": {},
                "cardToId": null,
                "createdAt": "2018-11-07T12:13:06.000Z",
                "payments": [
                    {
                        "invoiceId": "0004cf22-3a80-475c-bee4-96d6417358a7",
                        "paymentId": "e90c8459-3e79-4c86-a3fd-18e0b0cb841b",
                        "number": 948,
                        "receiptId": "E76EZFQFK2FE",
                        "amount": 100,
                        "commission": 1,
                        "currency": "980",
                        "cardFromMasked": "5269615505",
                        "cardFromId": "9ac4999f-79ea-40f0-9227-ef5417573c5b",
                        "paymentStatus": "FINISHED",
                        "status": "FINISHED",
                        "finishedAt": "2018-11-07T10:21:30.000Z",
                        "createdAt": "2018-11-07T12:19:24.000Z",
                        "updatedAt": "2018-11-07T12:21:30.000Z",
                        "chequeLink": "https://uapay.ua/api/acquiring/receipts/v2/e90c8459-3e79-4c86-a3fd-18e0b0cb841b.pdf"
                    }
                ],
                "recurringData": {}
            },
            {
                "error": {
                    "code": "WRONG_ID",
                    "details": {
                        "id": "10eaaf72-9bbe-45e1-8bf4-d6641fb3ebfc"
                    }
                }
            }
        ]
    }
}
            


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