Получение списка платежей

Метод Get list of payments используется для получения списка платежей текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/payments

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
page[size]queryintegerОпциональныйПараметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]queryintegerОпциональныйПараметр постраничной навигации. Номер страницы ответа
sortqueryintegerОпциональный

Предназначен для сортировки платежей по указанному параметру:

  • sort={parameter} — сортировка по возрастанию.
  • sort={-parameter} — сортировка по убыванию.

В качестве {parameter} можно указать любое поле

filter[created_at]

query

string

Опциональный

Предназначен для фильтрации платежей по дате и времени создания в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[created_at][gt] — дата и время более, чем указанные.
  • filter[created_at][lt] — дата и время менее, чем указанные.
filter[updated_at]

query

string

Опциональный

Предназначен для фильтрации платежей по дате дате и времени последнего обновления в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[updated_at][gt] — дата и время более, чем указанные.
  • filter[updated_at][lt] — дата и время менее, чем указанные.
filter[closed_at]querystringОпциональный

Предназначен для фильтрации платежей по дате дате и времени завершения в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:

  • filter[closed_at][gt] — дата и время более, чем указанные.
  • filter[closed_at][lt] — дата и время менее, чем указанные.
filter[account_id]

query

string

Опциональный

Предназначен для фильтрации платежей по ID клиента
filter[payment_method_id]

query

string

Опциональный

Предназначен для фильтрации платежей по ID способа оплаты, который был использован при оплате (см. Просмотр списка способов оплаты)
filter[document_id]

query

string

Опциональный

Предназначен для фильтрации платежей по номеру платежа, который указывается в платежном документе клиента

filters[status]

query

string

Опциональный

Фильтрация списка по статусу платежа (список статусов см. в Типы платежей)

includequerystringОпциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:

ОбъектЗначение параметра
Актыinvoices
Заказыorders
Клиентaccount
Способ оплатыpayment_method
Реселлерreseller
Списанияcharges
Корректировкиcorrections

Модель ответа

Название

Тип данных

Описание

dataarrayДанные ответа


id

stringID платежа

typestringТип данных

attributesobjectИнформация о платеже


created_atstringДата и время создания платежа


updated_atstringДата и время последнего изменения платежа


account_idintegerID клиента


discount_amount

stringРазмер скидки по платежу


total

stringОбщая сумма платежа


currency_codestringКод валюты платежа


comment

stringКомментарий к платежу


statusstringСтатус платежа (список статусов см. в Типы платежей)


document_id

string

Номер платежа, указываемый в платежном документе клиента



expiration_date

stringДата истечения платежа по модели Постоплата (ГГГГ-ММ-ДД). Если отсутствует, то возвращается null


payment_method_id

integerID способа оплаты платежа, которым платеж был завершен (см. Просмотр списка способов оплаты). Если отсутствует, то возвращается null


requester_ip

string

IP-адрес плательщика. Если отсутствует, то возвращается null



manager_id

integer

ID персонального менеджера клиента на текущий момент. Если отсутствует, то возвращается null



purposestringНазначение платежа для пополнения баланса клиента. Отображается в форме счета на оплату (см. Ручное создание платежа)


external_totalstringСумма счета на оплату в сторонней ERP-системе. Только для платежа, связанного с актом по модели Постоплата с внешним управлением (см. Подтверждение акта). Если отсутствует, то возвращается null


external_currencystringISO-код валюты счета на оплату в сторонней ERP-системе. Только для платежа, связанного с актом по модели Постоплата с внешним управлением (см. Подтверждение акта). Если отсутствует, то возвращается null


due_datestringКрайняя дата оплаты платежа по модели Постоплата (ГГГГ-ММ-ДД). Рассчитывается как expiration_date минус 1 день. Если отсутствует, то возвращается null


payment_method_name

stringНаименование способа оплаты, которым платеж был завершен. Если отсутствует, то возвращается null


closed_at

stringДата и время завершения платежа

relationshipsobjectПеречень объектов, связанных с платежом


ordersobjectСписок оплачиваемых заказов



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


invoicesobjectСписок актов



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


chargesobjectСписок списаний



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


correctionsobjectСписок корректировок (см. Завершение платежа по номеру)



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


resellerobjectИнформация о реселлере



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


accountobjectИнформация о клиенте



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


payment_methodobjectИнформация о способе оплаты, которым платеж был завершен



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
includedarray

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
attributesobjectАтрибуты (состав данных см. ниже)
    • Для акта состав данных см. в Получение информации об акте.
    • Для клиента состав данных см. в Получение информации о клиенте.
    • Для реселлера состав данных см. в Получение информации о реселлере.
    • Для списания состав данных см. в Получение информации о списании конечного клиента.

    • Для заказа:

      НазваниеТип данныхОписание

      created_at

      		stringДата и время создания заказа

      updated_at

      		stringДата и время последнего изменения заказа

      account_id

      		integerID клиента

      total

      		stringОбщая сумма заказа

      payment_id

      		integerID способа оплаты (см. Просмотр списка способов оплаты)

      status

      		stringСтатус заказа (список статусов см. в Просмотр информации о заказе)

      type

      		stringТип заказа (список типов см. в Просмотр информации о заказе)

      expiration_date

      		stringДата, до которой заказ должен быть оплачен (см. Создание правила обслуживания)

      owner_id

      		integerID Владельца клиента

      promo_code

      		stringПромо-код, использованный для получения скидки

      document_id

      		stringНомер заказа

      requester_ip

      		stringIP-адрес заказчика

      manager_id

      		integerID менеджера клиента

      custom_price

      		boolПризнак заказа по индивидуальным ценам:

      net_cost

      		stringСебестоимость подписки в заказе

      discount_amount

      		stringРазмер скидки по заказу

      payment_model

      		stringМодель оплаты:
      • prepay — Предоплата.
      • postpay — Постоплата.

      closed_at

      		stringДата завершения заказа
      provisioning_datestringДата предоставления заказа

    • Для способа оплаты:

      НазваниеТип данныхОписание

      created_at

      		stringДата и время создания способа оплаты

      updated_at

      		stringДата и время последнего изменения способа оплаты

      name

      		stringНазвание способа оплаты

      description

      		stringОписание способа оплаты

      enabled

      		boolСтатус способа оплаты:
      • true — доступен в Панели управления Клиента и Панели управления Оператора.
      • false — недоступен для проведения оплаты.

      plugin_id

      		stringНазвание платежного модуля (см. Просмотр списка модулей), который используется для проведения оплаты
    • Для корректировки (см. Завершение платежа по номеру):

      Название

      Тип данных

      Описание

      created_at

      		stringДата и время создания корректировки

      updated_at

      		stringДата и время последнего обновления корректировки

      account_id

      		integerID клиента, для которого производится корректировка

      status

      		stringТекущий статус корректировки:
      • approval_required — корректировка создана, но не подтверждена.
      • approved — корректировка подтверждена.
      • declined — корректировка отклонена.

      total

      		stringСумма корректировки
      bool

      Комментарий к корректировке

      period_from

      		stringВсегда null

      period_to

      		stringВсегда null
      approved_atstringДата подтверждения корректировки (ГГГГ-ММ-ДД)

      subscription_id

      		integerВсегда null
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

Пример запроса

GET /api/v3/resellers/1/payments?page[size]=2&page[number]=7&filter[created_at][gt]=2022-03-22&include=invoices,orders,account,payment_method,reseller,charges
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
    "data": [
        {
            "id": "9714",
            "type": "payments",
            "attributes": {
                "created_at": "2022-03-22T16:37:21.321874+0300",
                "updated_at": "2022-03-22T16:37:30.163316+0300",
                "account_id": 1349,
                "discount_amount": "0.0",
                "total": "715.76",
				"currency_code": "USD",
                "comment": "Payment for order 14759",
                "status": "completed",
                "document_id": "2007136",
                "expiration_date": null,
                "payment_method_id": 3,
                "requester_ip": "10.20.30.40",
                "manager_id": null,
                "purpose": "",
                "external_total": null,
                "external_currency": null,
                "due_date": null,
                "payment_method_name": "Bank Transfer",
                "closed_at": "2022-03-22T16:37:30.163316+0300"
            },
            "relationships": {
                "orders": {
                    "data": [
                        {
                            "id": "14759",
                            "type": "prolong_orders"
                        }
                    ]
                },
                "invoices": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "94591",
                            "type": "charges"
                        }
                    ]
                },
                "corrections": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "1349",
                        "type": "accounts"
                    }
                },
                "payment_method": {
                    "data": {
                        "id": "3",
                        "type": "payment_methods"
                    }
                }
            }
        },
        {
            "id": "9715",
            "type": "payments",
            "attributes": {
                "created_at": "2022-03-22T16:51:34.290462+0300",
                "updated_at": "2022-03-22T16:53:35.452802+0300",
                "account_id": 1349,
                "discount_amount": "0.0",
                "total": "511.26",
				"currency_code": "USD",
                "comment": "Payment for order 14760",
                "status": "completed",
                "document_id": "2007137",
                "expiration_date": null,
                "payment_method_id": 3,
                "requester_ip": "10.20.30.40",
                "manager_id": null,
                "purpose": "",
                "external_total": null,
                "external_currency": null,
                "due_date": null, 
                "payment_method_name": "Bank Transfer",
                "closed_at": "2022-03-22T16:53:35.452802+0300"
            },
            "relationships": {
                "orders": {
                    "data": [
                        {
                            "id": "14760",
                            "type": "renewal_orders"
                        }
                    ]
                },
                "invoices": {
                    "data": []
                },
                "charges": {
                    "data": [
                        {
                            "id": "94592",
                            "type": "charges"
                        },
                        {
                            "id": "94593",
                            "type": "charges"
                        }
                    ]
                },
                "corrections": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "1349",
                        "type": "accounts"
                    }
                },
                "payment_method": {
                    "data": {
                        "id": "3",
                        "type": "payment_methods"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "14759",
            "type": "prolong_orders",
            "attributes": {
                ...
            }
        },
        {
            "id": "94591",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "1",
            "type": "resellers",
            "attributes": {
                ...
            }
        },
        {
            "id": "1349",
            "type": "accounts",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "3",
            "type": "payment_methods",
            "attributes": {
                ...
            }
        },
        {
            "id": "14760",
            "type": "renewal_orders",
            "attributes": {
                ...
            }
        },
        {
            "id": "94592",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        },
        {
            "id": "94593",
            "type": "charges",
            "attributes": {
                ...
            },
            "relationships": {
                ...
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=7&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=6&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=8&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/payments?filter%5Bcreated_at%5D%5Bgt%5D=2022-03-22&include=invoices%2Corders%2Caccount%2Cpayment_method%2Creseller%2Ccharges&page%5Bnumber%5D=153&page%5Bsize%5D=2"
    }
}