Page Comparison

...

A method for obtaining basic information on an array of invoices. (One request cannot contain more than 100 (one hundred) payments).

title

Tip

icon

false

URI

POST /api/invoicer/invoices/show/list

...

Request:

Ключ

Key

Опис

Description

Тип

Чи обов'язковий параметр

Type	Is a parameter required?

Приклад

Example
params
sessionId

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

client session id

string, uuid

так

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

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

Id array in the external system	massif string	If no id	["73737fa2-7130-8366-ab17-65ebbb359821", "ce0c225b-b142-0ad0-3802-172b7598ea55"]
ids

масив Id інвойсів в системі UAPAYмасив string, uuidякщо немає externalId

Id invoices array in the UAPAY system

massif string, uuid

If no external Id

["000c6d12-0d2e-4402-bf62-c474c92fc842",
"9251607b-e652-4d11-8f3c-91fc4b2b1427"]

Example of a request for invoice id

collapse

Code Block

title

Приклад запиту по id інвойса

true

{  
   "params":{  
      "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a",
      "ids":[  
         "000c6d12-0d2e-4402-bf62-c474c92fc842",
         "9251607b-e652-4d11-8f3c-91fc4b2b1427"
      ]
   }
}

Code Block

title	Приклад запиту по зовнішньому id платежу
collapse	true

Example of a request for an external payment id

Code Block
{ "params":{ "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a", "externalIds":[ "73737fa2-7130-8366-ab17-65ebbb359821", "ce0c225b-b142-0ad0-3802-172b7598ea55" ] } }

...

Reply:

Ключ

Key

Опис

Description

Тип

Type

Приклад

Example
status

Статус

Status. 0 -

помилка

error, 1 -

успіх

success	integer	1
data
invoices[].{}

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

array of data on invoices	array
Id

id інвойсу

invoice id

string, uuid

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

externalId

id операції у зовнішній системі

Id array of the operations in the external system	string	"004ce685-4948-407a-a11a-57151e8d1bd7"
invoiceNumber

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

invoice number	integer	14
clientId	customer id

клієнта

	integer	1
systemType

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

type of payment system	string	"P2P"\|"ECOM"\|"BILLER"
amount

сума платежу

payment amount	integer	100
reusability

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

reusable invoice parameter	boolean	true
description

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

description of the purpose of the invoice

string

Code Block
"

тестовый

test

платеж

payment"

invoiceStatus

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

invoice status	string	"ACTIVE" или "'INACTIVE'"
redirectUrl

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

redirecting address

string

Code Block
"https://uapay.ua"

callbackUrl

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

post reply address

string

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

createdAt

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

the date of creation of the invoice

integer

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

type

тип інвойсу

invoice type	string	"PAY", "HOLD", "SUBSCRIBE"
email

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

e-mail specified when creating the invoice	string	"test@uapay.ua"
extraInfo

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

field for transmitting additional information about the invoice

object

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

serviceData[].{}

масив даних по сервісах (тільки для

an array of data on services (only for systemType = "ECOM",

крім

except type = "SUBSCRIBE")

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

payments

данные по платежах данного инвойса

data on payments of this invoice	array	"[ ]"
payments[].{}

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

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

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

client name

string

Code Block
"UAPAY"

cardToId

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

enrollment card id

string, uuid

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

Example of an answer

true

Code Block
title	Приклад відповіді
collapse

{ "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" } } } ] } }

...

Versions Compared

Old Version 3

New Version Current

Key

URI

Request:

Example of a request for invoice id

Example of a request for an external payment id

Reply:

Example of an answer