Получение информации о платеже реселлера
Метод Get payment используется для получения информации о платеже текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен сотрудника. API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||||||||||||
| Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | ||||||||||||
| Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | ||||||||||||
| base_url | path | string | Обязательный | URL ActivePlatform | ||||||||||||
| reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | ||||||||||||
| payment_id | path | integer | Обязательный | ID платежа | ||||||||||||
| include | query | string | Опциональный | Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:
|
Модель ответа
Название | Тип данных | Описание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | object | Данные ответа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | ID платежа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | string | Тип данных | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| attributes | object | Информация о платеже | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_at | string | Дата и время создания платежа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| updated_at | string | Дата и время последнего изменения платежа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| account_id | number | ID клиента | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_amount | string | Размер скидки по платежу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | string | Общая сумма платежа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
comment | string | Комментарий к платежу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string | Статус платежа (список статусов см. в Типы платежей) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document_id | string | Номер платежа, указываемый в платежном документе клиента | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expiration_date | string | Дата истечения платежа для автоматически создаваемых платежей для подписок по модели Постоплата. Если отсутствует, то возвращается null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_method_id | number | ID способа оплаты платежа, которым платеж был завершен (см. Просмотр списка способов оплаты). Если отсутствует, то возвращается null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requester_ip | string | IP-адрес плательщика. Если отсутствует, то возвращается null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manager_id | number | ID менеджера, ответственного за обработку платежа. Если отсутствует, то возвращается null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purpose | string | Назначение платежа для пополнения баланса клиента. Отображается в форме счета на оплату (см. Ручное создание платежа) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_method_name | string | Наименование способа оплаты, которым платеж был завершен. Если отсутствует, то возвращается null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
closed_at | string | Дата и время завершения платежа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| relationships | object | Перечень объектов, связанных со платежом | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| orders | object | Список оплачиваемых заказов | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| invoices | object | Список актов | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reseller | object | Информация о реселлере | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | object | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| account | object | Информация о клиенте | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | object | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payment_method | object | Информация о способе оплаты, которым платеж был завершен | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | object | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| included | array | Дополнительная информация о связанных объектах, указанных в запросе:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Пример запроса
GET /api/v3/resellers/1/payments/6465?include=invoices,orders,account,payment_method
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": {
"id": "6465",
"type": "payments",
"attributes": {
"created_at": "2019-10-21T07:02:54.651997+0300",
"updated_at": "2019-10-21T07:03:00.230411+0300",
"account_id": 502,
"discount_amount": "0.0",
"total": "360.0",
"comment": "Payment for order 8128",
"status": "completed",
"document_id": "2005248",
"expiration_date": null,
"payment_method_id": 2,
"requester_ip": "10.0.0.203",
"manager_id": null,
"purpose": "",
"payment_method_name": "Cash",
"closed_at": "2019-10-21T07:03:00.230411+0300"
},
"relationships": {
"orders": {
"data": [
{
"id": "8128",
"type": "change_orders"
}
]
},
"invoices": {
"data": []
},
"reseller": {
"data": {
"id": "1",
"type": "resellers"
}
},
"account": {
"data": {
"id": "502",
"type": "accounts"
}
},
"payment_method": {
"data": {
"id": "2",
"type": "payment_methods"
}
}
}
},
"included": [
{
"id": "8128",
"type": "change_orders",
"attributes": {
"created_at": "2019-10-21T07:02:54.273531+0300",
"updated_at": "2019-10-21T07:03:00.465342+0300",
"account_id": 502,
"total": "360.0",
"payment_id": 6465,
"status": "completed",
"type": "ChangeOrder",
"expiration_date": "2019-10-28",
"owner_id": 864,
"promo_code": null,
"document_id": "CO001022",
"requester_ip": "10.0.0.203",
"manager_id": 214,
"custom_price": false,
"net_cost": null,
"discount_amount": "0.0",
"payment_model": "prepay",
"closed_at": "2019-10-21T07:03:00.465342+0300"
}
},
{
"id": "502",
"type": "accounts",
"attributes": {
"created_at": "2019-08-22T15:11:47.339+03:00",
"updated_at": "2019-10-21T07:03:00.217+03:00",
"reseller_id": 1,
"name": "Vit Ada",
"account_class_id": 1601,
"primary_name": "DepV0304-4",
"first_name": "Vit",
"middle_name": "",
"last_name": "Ada",
"country": "TW",
"region": "MSK",
"city": "Moscow",
"street": "Yamskaya",
"building": "",
"office": "",
"zip": "119002",
"phone": "+74950000001",
"email": "test@example.com",
"status": "active",
"balance": "1293.12",
"usable_balance": "770.45",
"current_debt": 99.26,
"subscription_credit_limit": 100.0,
"financial_blocking_threshold": 100.0,
"account_type_id": 1564,
"manager_id": null,
"owner_id": 864,
"tech_user_id": 864,
"bill_user_id": 864,
"custom_attributes": {},
"manager": null,
"default_payment_model": "postpay",
"account_type": {
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2017-03-20T16:34:28.163+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": null,
"ancestry": "1562",
"use_by_default": false
},
"account_class": {
"id": 1601,
"reseller_id": 1,
"name": "543535",
"created_at": "2018-07-23T17:41:37.677+03:00",
"updated_at": "2019-10-27T10:58:37.566+03:00",
"financial_blocking_threshold": "100.0",
"due_order_period": 7,
"subzero_period": -1,
"stop_subscription_type": "automatically",
"key": "3535535353",
"color": "grey",
"guaranteed_payment_limit": 1000,
"guaranteed_payment_period": 7,
"delete_subscription_type": "automatically",
"denominated": false,
"buy_with_negative_balance": false,
"receipt_day": null,
"payment_model": "postpay",
"default": false,
"due_payment_period": 6,
"subscription_credit_limit": "100.0"
}
},
"relationships": {
"subscriptions": {
"data": [
{
"id": "3005710",
"type": "subscriptions"
},
{
"id": "3005731",
"type": "subscriptions"
},
{
"id": "3005648",
"type": "subscriptions"
}
]
}
}
},
{
"id": "2",
"type": "payment_methods",
"attributes": {
"created_at": "2016-08-25T09:26:12.947229+0300",
"updated_at": "2017-10-03T11:20:32.446864+0300",
"name": "Cash",
"description": "",
"enabled": true,
"plugin_id": "check_cash"
}
}
]
}