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	`"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"`
cardFromMasked	sender card mask	string	`"4444444444"`
cardToId	Recipient card ID	string	`"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"`
cardToMasked	recipient card mask	string	`"4444443333"`
chequeLink	receipt link	string	"api.uapay.ua/api/receipts/08eff720-9432-4951-a698-94e24db59e66"
createdAt	date of creating a payment	integer	`"2018-09-11T08:21:39.000Z"`
updatedAt	date of updating a payment	integer	`"2018-09-11T08:21:39.000Z"`
paidAt	date of cash withdrawal	integer	`"2018-09-11T08:21:39.000Z"`
reversedAt	date of refund	integer	`"2018-09-11T08:21:39.000Z"`
finishedAt	date of crediting funds	integer	`"2018-09-11T08:21:39.000Z"`
canceledAt	date of payment cancellation	integer	`"2018-09-11T08:21:39.000Z"`
invoice	invoice data	object
invoice.id	invoice ID	string, uuid	`"edacfce8-eb97-4f4f-8fa2-0fb044932ac3"`
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	`"https://uapay.ua"`
invoice.callbackUrl	callback address	string	`"http://ptsv2.com/t/test_server/post"`
invoice.externalId	external identifier	string, uuid	`"edacfce8-eb97-4f4f-8fa2-0fb044932ac3"`
invoice.systemType	type of payment system	string	"P2P"\|"ECOM"\|"BILLER"
invoice.cardToId	payment card ID	string, uuid	`"91c78d52-4a28-4c1e-ac5a-079ca5cd029c"`
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	`"2018-09-07T16:53:21.000Z"`
invoice.updatedAt	date of updating payment	string	`"2018-09-07T16:53:21.000Z"`
invoice.email	e-mail specified when creating the invoice	string	"test@uapay.ua"
invoice.extraInfo	field for additional information about the invoice	object	`{"base":true,"origin":"invoicer","email":"test@ukr.net"}`

Example of an answer

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

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

Receiving payment data (Invoices payments show)

URI

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

Example of an answer

Related content