UAPAY - національний платіжний сервіс

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

Метод для формування звіту по транзакціям

URI

POST api/report/client/request/create

Запит:

Ключ

Опис

Тип

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

Приклад

params





sessionId

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

string, uuid

так

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

email

електронна адреса отримувача

string

так

"test@uapay.ua"

filter

об"єкт параметрів для фільтрації

object



createdAt*

дата створення

object

ні

{ "$gte": 1517176800000,
"$lte": 1538341199999 }

paymentTypes

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

array

ні

["ECOM", "P2P", "A2C"]

statuses

статуси платежів

array

ні

["PENDING", "REJECTED", "NEEDS_CONFIRMATION", "FINISHED", "REVERSED", "HOLDED", "CANCELED", "OPEN", "PAYED", "PARTLY_RECEIVED", "RETURNED", "CLOSED"]

paymentNumbers

номер платежу

array

ні

[111,222, 333]

amount*

сума платежу

object

ні

{ "$gte": 1,
"$lte": 10000 }

isChargeback

помітка "charge back"

boolean

ні

false

* можливі правила для фільтру: '$ne', '$eq', '$lte', '$lt', '$gt', '$gte'


Приклад запиту
{
   "params": {
     "sessionId": "04888043-c0c4-42e7-867f-c007abfec9fc",
     "email": "test@uapay.ua",
     "filter": {
        "createdAt":{
                        "$gte": 1517176800000, 
                        "$lte": 1538341199999
        }, 
        "paymentTypes": ["ECOM", "P2P", "A2C"], 
        "statuses": ["PENDING", "REJECTED", "NEEDS_CONFIRMATION", "FINISHED", "REVERSED", "HOLDED", "CANCELED", "OPEN", "PAYED", "PARTLY_RECEIVED", "RETURNED", "CLOSED"],
        "paymentNumbers": [111, 222, 333],
        "amount": {
                        "$gte": 1, 
                        "$lte": 10000
        },
        "isChargeback": false
     }
   }
}

Відповідь:

Ключ

Опис

Тип

Приклад

status

Статус. 0 - помилка, 1 - успіх

integer

1

data




reportRequestId

id заявки для відправки запиту

string, uuid

"2ae8cf14-c041-443f-af55-02ea529176aa"


Приклад відповіді
{
    "status": 1,
    "data": {
        "reportRequestId": "2ae8cf14-c041-443f-af55-02ea529176aa"
    }
}


  • No labels