Метод для отримання основної інформації по платежам (по даті створення) за вказаний період. Даний метод не має обмеження по часовому періоду, але має обмеження: максимум 1000 платежів в одній відповіді.
Цей метод можна використовувати для синхронізації платежів системи UAPAY з системою мерчанта.
POST /api/payments/ecom/list |
Ключ | Опис | Тип | Чи обов'язковий параметр? | Приклад |
---|---|---|---|---|
params | ||||
sessionId | id сесії клієнта | string, uuid | так | "52be10d0-d094-4ede-b201-904783df5f8d" |
createdAtFrom | початок часового інтервалу Доступні формати часових дат:
| string | так |
|
createdAtTo | кінець часового інтервалу Доступні формати часових дат:
| string | так |
|
order | порядок сортування списку платежів у відповіді | string | ні У разі відсутності за замовчуванням: ASC | DESC |
{ "params":{ "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a", "createdAtFrom": "2011-10-05T14:48:00.000Z", "createdAtTo": "2011-10-20T23:59:59.000Z" } } |
{ "params":{ "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a", "order": "DESC", "createdAtFrom": 1732018674000, "createdAtTo": 1732536978000 } } |
Ключ | Опис | Тип | Приклад |
---|---|---|---|
status | Статус. 0 - помилка, 1 - успіх | integer | 1 |
data | object | ||
payments | array | ||
id | id операції в нашій системі | string, uuid | "004ce685-4948-407a-a11a-57151e8d1bd7" |
externalId | id операції у зовнішній системі | string | "xyz123" |
status | Статус операції | string | значення: "FINISHED", "REJECTED" |
amount | Сума платежу в копійках | integer | 50000 |
extraPayerProvidedData | object | ||
extraPayerProvidedData.phone | номер телефону отриманий при створенні платежу | string | "380434343444" |
extraPayerProvidedData.email | email отриманий при створенні платежу | string | "kjdskdj@dsdl.cl" |
createdAt | дата створення платежу | string | "2024-11-22T16:03:29.000Z" |
reversedAt | дата повернення платежу | string | null | "2024-11-25T18:23:29.000Z" |
{ "status": 1, "data": { "payments": [ { "id": "93774350-2e0a-46cc-b4e2-dd2bd0f5795f", "externalId": "f1489a15-3fcd-4018-b962-4f2432070fbc.1732284818586", "status": "FINISHED", "amount": 40000, "extraPayerProvidedData": { "phone": "380687151551", "email":"wiewieihiu@sldd.cl" }, "createdAt": "2024-11-22T14:13:38.000Z", "reversedAt": null }, { "id": "cf83e0d8-1390-4be4-90f7-a5a7840c0253", "externalId": "bee07cf7-81d2-40f4-9c28-84ae20704b35.1732287833655", "status": "REVERSED", "amount": 40000, "extraPayerProvidedData": { "phone": "380380687151", "email":"wiewieihiu@sldd.cl" }, "createdAt": "2024-11-22T15:03:54.000Z", "reversedAt": "2024-11-25T16:03:29.000Z" } ] } } |