Page Comparison

Method for displaying invoice payment data

Tip

icon

false

title

URI

POST api/invoicer/payments/show

Request:

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"

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

Code Block

theme

language	js	Confluence
title	Приклад запиту
linenumbers	true
collapse	true

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

Відповідь:

Key	Description	Type

Приклад

Example
status

Статус

Status. 0 -

помилка

error, 1 -

успіх

success	integer	1
data
invoiceId	invoice id

інвойсу

string, uuid

Code Block
"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

Code Block
"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

Code Block
"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"

cardFromMasked

маска карти відправника

sender card mask

string

Code Block
"4444444444"

cardToId

ІД карти отримувача

Recipient card ID

string

Code Block
"c0eb5ebd-99cb-4f98-9d1b-00eb320c18e6"

cardToMasked

маска карти отримувача

recipient card mask

string

Code Block
"4444443333"

chequeLink

посилання на квитанцію

receipt link	string	"api.uapay.ua/api/receipts/08eff720-9432-4951-a698-94e24db59e66"
createdAt

дата створення платежу

date of creating a payment

integer

Code Block
"2018-09-11T08:21:39.000Z"

updatedAt

дата оновленя платежу

date of updating a payment

integer

Code Block
"2018-09-11T08:21:39.000Z"

paidAt

дата зняття грошових коштів

date of cash withdrawal

integer

Code Block
"2018-09-11T08:21:39.000Z"

reversedAt

дата повернення грошових коштів

date of refund

integer

Code Block
"2018-09-11T08:21:39.000Z"

finishedAt

дата зарахування грошових коштів

date of crediting funds

integer

Code Block
"2018-09-11T08:21:39.000Z"

canceledAt

дата скасування платежу

date of payment cancellation

integer

Code Block
"2018-09-11T08:21:39.000Z"

invoice

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

invoice data	object
invoice.id

ідентифікатор інвойсу

invoice ID

string, uuid

Code Block
"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

Code Block
"тестовый платеж"

invoice.status

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

invoice status	string	"ACTIVE"
invoice.redirectUrl

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

redirecting address

string

Code Block
"https://uapay.ua"

invoice.callbackUrl

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

callback address

string

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

invoice.externalId

зовнішній ідентифікатор

external identifier

string, uuid

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

invoice.systemType

тип системи оплати

type of payment system	string	"P2P"\|"ECOM"\|"BILLER"
invoice.cardToId

ідентифікатор платіжної картки

payment card ID

string, uuid

Code Block
"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

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

invoice.updatedAt

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

date of updating payment

string

Code Block
"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

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

Example of an answer

Code Block

language	js
theme	Confluence
title	Приклад відповіді
linenumbers	true
collapse	true

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

...

Versions Compared

Old Version 3

New Version Current

Key

URI

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

Example of an answer