Отримання даних по платежам

POST /ecom/jws/scheduled_payments/payments/scheduled/search_v1

Отримання списку запланованих/виконаних рекурентних платежів із можливістю фільтрації по плану, статусу та датах створення.

Вхідні параметри

Параметр	Опис	Формат даних	Обовʼязковість	Приклад
merchantId	id мерчанта	uuid(36)	так	137d9304-0368-11ed-b939-0242ac120002
filters	Список фільтрів.	array
filters.operator	Оператор для фільтрування. IN GTE LTE EQUALS LIKE – фільтр LIKE передається без параметра field.	string		EQUALS
filters.value	Значення для параметра, назва параметра вказується в field	string		FAIL
filters.field	Параметр, для якого застосовується фільтр	string		state

Параметри, які доступні для фільтраціі

Параметр	Опис	Формат даних	Обовʼязковість	Приклад
id	Id платежу	uuid
orderId	Id підписки	string	ні	1783610230256tRdmRqfsGJj
planId	id плану	string	ні	a9562240-10ca-42d7-8d90-bbd1ace3dc5a
status	статус платежу	string	ні	WAITING
executionAt	дата проведення платежу	TIMESTAMPZ	ні	2024.09.19 15:29:25.675

Вихідні параметри:

Параметр	Опис	Формат даних	Приклад
currentPage
payments	обʼєкт операціі	object
id	Id операціі	uuid	13c06c89-936c-4d7c-8164-0baabc35cb06
planId	Id плану	string	a9562240-10ca-42d7-8d90-bbd1ace3dc5a
planName	Назва підписки	string	Premium subscription
versionId	Id версіі	int	4
versionStatus	статус версіі	string	ACTIVE
paymentNumber	номер платежу по плану, номер платежу в рамках ордеру	int	3
status	статус платежу	string	WAITING
orderId	Id підписки	string	1783610230256tRdmRqfsGJj
executionAt	дата виконання проведення	TIMESTAMPZ	2026-08-12 18:17:49.89+03:00
retryExecutionAt	наступна дата ретраю	TIMESTAMPZ	2026-08-12 18:17:49.89+03:00
retryNumber	кількість ретраїв	int	2
coinAmount	сума платежу	long	2000
currency	валюта платежу	string	980
recurringTransactionType	Індикатор транзакції:	string	O – Перша транзакція C – Наступна CIT-транзакція M – Наступна MIT-транзакція
categorySubcategoryIndicator	категорія підписки	string	M103

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

{
   "merchantId":"137d9304-0368-11ed-b939-0242ac120002",
   "filters":[
      {
         "operator":"EQUALS",
         "value":"{{planId}}",
         "field":"planId"
      }
   ]
}

Приклад відповіді

{
  "currentPage": 0,
  "payments": [
    {
      "id": "f9c67467-aade-4af6-9c11-25677dc654b1",
      "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
      "planName": "Тест 2",
      "versionId": 1,
      "versionStatus": "ACTIVE",
      "paymentNumber": 4,
      "status": "WAITING",
      "coinAmount": 100,
      "currency": "980",
      "executionAt": "2026-07-12 18:17:49.89+03:00",
      "recurringTransactionType": "M",
      "categorySubcategoryIndicator": "M103",
      "orderId": "1783610230256tRdmRqfsGJj"
    },
    {
      "id": "f43432e4-6f4f-4ed9-b433-97993c34b365",
      "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
      "planName": "тест 2",
      "versionId": 1,
      "versionStatus": "ACTIVE",
      "paymentNumber": 3,
      "status": "WAITING",
      "coinAmount": 100,
      "currency": "980",
      "executionAt": "2026-07-11 18:17:49.89+03:00",
      "recurringTransactionType": "M",
      "categorySubcategoryIndicator": "M103",
      "orderId": "1783610230256tRdmRqfsGJj"
    },
    {
      "id": "bac1571f-8200-4b32-9736-c45aa6eb3afc",
      "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
      "planName": "тест 2",
      "versionId": 1,
      "versionStatus": "ACTIVE",
      "paymentNumber": 3,
      "status": "WAITING",
      "coinAmount": 100,
      "currency": "980",
      "executionAt": "2026-07-11 18:12:55.74+03:00",
      "recurringTransactionType": "M",
      "categorySubcategoryIndicator": "M103",
      "orderId": "1783609541721181tI5zJ3ad"
    },
    {
      "id": "ef8a7b40-e361-474c-a162-87c217c652cc",
      "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
      "planName": "тест 2",
      "versionId": 1,
      "versionStatus": "ACTIVE",
      "paymentNumber": 3,
      "status": "WAITING",
      "coinAmount": 100,
      "currency": "980",
      "executionAt": "2026-07-11 18:01:06.89+03:00",
      "recurringTransactionType": "M",
      "categorySubcategoryIndicator": "M103",
      "orderId": "1783608520205P81ch623POH"
    },
    {
      "id": "1ff757b0-aa91-4cc2-a8b0-f20609d40b04",
      "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
      "planName": "тест 2",
      "versionId": 1,
      "versionStatus": "ACTIVE",
      "paymentNumber": 2,
      "status": "WAITING",
      "coinAmount": 100,
      "currency": "980",
      "executionAt": "2026-07-10 18:17:49.89+03:00",
      "recurringTransactionType": "M",
      "categorySubcategoryIndicator": "M103",
      "orderId": "1783610230256tRdmRqfsGJj"
    }
  ]
}