Obtaining data on an array of invoices (Invoices show list)

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

URI

POST /api/invoicer/invoices/show/list

Request:

Key	Description	Type	Is a parameter required?	Example

Key	Description	Type	Is a parameter required?	Example
params
sessionId	client session id	string, uuid	yes	"52be10d0-d094-4ede-b201-904783df5f8d"
externalIds	Id array in the external system	massif string	If no id	["73737fa2-7130-8366-ab17-65ebbb359821", "ce0c225b-b142-0ad0-3802-172b7598ea55"]
ids	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

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

Example of a request for an external payment id

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

Reply:

Key	Description	Type	Example

Key	Description	Type	Example
status	Status. 0 - error, 1 - success	integer	1
data
invoices[].{}	array of data on invoices	array
Id	invoice id	string, uuid	`"edacfce8-eb97-4f4f-8fa2-0fb044932ac3"`
externalId	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
invoiceStatus	invoice status	string	"ACTIVE" или "'INACTIVE'"
redirectUrl	redirecting address	string
callbackUrl	post reply address	string
createdAt	the date of creation of the invoice	integer
type	invoice type	string	"PAY", "HOLD", "SUBSCRIBE"
email	e-mail specified when creating the invoice	string	"test@uapay.ua"
extraInfo	field for transmitting additional information about the invoice	object
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
cardToId	enrollment card id	string, uuid

Платіжна документація

Obtaining data on an array of invoices (Invoices show list)

URI

Request:

Example of a request for invoice id

Example of a request for an external payment id

Reply:

Example of an answer