Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Метод для отримання основної інформації по платежам (по даті створення) за вказаний період. Даний метод не має обмеження по часовому періоду, але має обмеження: максимум 1000 платежів в одній відповіді.

...

Tip
iconfalse
titleURI
POST  /api/payments/ecom/list

Запит:

Ключ
Опис
Тип
Чи обов'язковий параметр?
Приклад
params



sessionIdid сесії клієнтаstring, uuidтак

"52be10d0-d094-4ede-b201-904783df5f8d"

createdAtFrom

початок часового інтервалу

Доступні формати часових дат:

  1. у timestamp з мілісекундами
  2. ISO 8601
string

так



  1. 1732018674000
  2. 2011-10-05T14:48:00.000Z
createdAtTo

кінець часового інтервалу

Доступні формати часових дат:

  1. у timestamp з мілісекундами
  2. ISO 
stringтак



  1. 1732018674000
  2. 2011-10-05T14:48:00.000Z
orderпорядок сортування списку платежів у відповіді string

ні

У разі відсутності за замовчуванням: ASC

DESC

...

Code Block
titleПриклад запиту за вказаний часовий інтервал (у timestamp в мілісекундах)
collapsetrue
{  
   "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Сума платежу в копійкахinteger50000
extraPayerProvidedData
object
extraPayerProvidedData.phoneномер телефону отриманий при створенні платежуstring"380434343444"
extraPayerProvidedData.emailemail отриманий при створенні платежуstring"kjdskdj@dsdl.cl"
createdAtдата створення платежуstring"2024-11-22T16:03:29.000Z"


Code Block
titleПриклад відповіді
collapsetrue
{
	"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"
			},
			{
			"id": "cf83e0d8-1390-4be4-90f7-a5a7840c0253",
			"externalId": "bee07cf7-81d2-40f4-9c28-84ae20704b35.1732287833655",
			"status": "FINISHED",
			"amount": 40000,
			"extraPayerProvidedData": {
				"phone": "380380687151",
				"email":"wiewieihiu@sldd.cl"
			},
			"createdAt": "2024-11-22T15:03:54.000Z"
			}
		]
	}
}

...