Receiving payment data (Invoices payments show)

Method for displaying invoice payment data

URI

POST api/invoicer/payments/show

Request:

Key	Description	Type	Mandatory	Example

Key	Description	Type	Mandatory	Example
params
sessionId	client session id	string, uuid	так	"000ab70b-ef76-4385-a0f5-a98693c716f1"
paymentId	payment id	string, uuid	так	"08eff720-9432-4951-a698-94e24db59e66"

Приклад запиту

{
   "params": {
      "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c",
      "paymentId": "1c584ff0-b560-455f-a197-1ecaf3632fc4"
   }
}

Відповідь:

Key	Description	Type	Example

Key	Description	Type	Example
status	Status. 0 - error, 1 - success	integer	1
data
invoiceId	invoice id	string, uuid	`"48cae638-2f4b-434c-aafa-a4b9ced4b486"`
paymentId	payment id	string, uuid	"08eff720-9432-4951-a698-94e24db59e66"
number	invoice number	integer	14
receiptId	receipt number	string	"Q1URF9TQMKDE"
clientId	customer id	integer	1
systemType	type of payment system	string	"P2P"/"ECOM"
amount	payment amount	integer	100
commission	commission	integer	0
email	the email address to send the check	string	`"invoice_test@uapay.ua"`
status	invoice payment status	string	"NEW"\|"PAID"\|"FINISHED"\|"REVERSED"\|"CANCELED"
paymentStatus	payment status in the payment system	string	"OPEN"\|"PAYED"\|"FINISHED"\|"REVERSED"\|"RETURNED"\|"CLOSED"\|"PENDING"\|"REJECTED"\|"HOLDED"\|"CANCELED"\|"NEEDS_CONFIRMATION"
cardFromId	Sender card ID	string
cardFromMasked	sender card mask	string
cardToId	Recipient card ID	string
cardToMasked	recipient card mask	string
chequeLink	receipt link	string	"api.uapay.ua/api/receipts/08eff720-9432-4951-a698-94e24db59e66"
createdAt	date of creating a payment	integer
updatedAt	date of updating a payment	integer
paidAt	date of cash withdrawal	integer
reversedAt	date of refund	integer
finishedAt	date of crediting funds	integer
canceledAt	date of payment cancellation	integer
invoice	invoice data	object
invoice.id	invoice ID	string, uuid
invoice.number	invoice number	integer	14
invoice.clientId	invoice client ID	integer	1
invoice.amount	the amount of the invoice	integer	100
invoice.description	invoice description	string
invoice.status	invoice status	string	"ACTIVE"
invoice.redirectUrl	redirecting address	string
invoice.callbackUrl	callback address	string
invoice.externalId	external identifier	string, uuid
invoice.systemType	type of payment system	string	"P2P"\|"ECOM"\|"BILLER"
invoice.cardToId	payment card ID	string, uuid
invoice.reusability	reusable invoice parameter	boolean	true
invoice.serviceData	an array of data on services (only for systemType = "ECOM", except type = "SUBSCRIBE") ['serviceId','destination','destinationName','account','mfo','okpo','bankName','description','amount']	array
invoice.type	type of operation	string	"PAY", "HOLD", "SUBSCRIBE"
invoice.createdAt	date of creating a payment	string
invoice.updatedAt	date of updating payment	string
invoice.email	e-mail specified when creating the invoice	string	"test@uapay.ua"
invoice.extraInfo	field for additional information about the invoice	object

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

Receiving payment data (Invoices payments show)

URI

Приклад запиту

Example of an answer