Получение информации о платеже

Метод 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

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

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

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

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

Название

Тип данных

Описание

data object Данные ответа

id

string

ID платежа

type string Тип данных

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

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

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

account_id integer ID клиента

discount_amount

string

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

total

string

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

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

comment

string

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

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

document_id

string

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

expiration_date

string

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

payment_method_id

integer

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

requester_ip

string

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

manager_id

integer

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

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

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

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

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

payment_method_name

string

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

closed_at

string

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

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

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

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

invoices object Список актов

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

charges object Список списаний

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

corrections

object

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

data

array

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

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

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

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

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

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

data

object

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

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

included

array

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

Название	Тип данных	Описание
id	string	ID объекта
type	string	Тип данных
attributes	object	Атрибуты (состав данных см. ниже)

Для акта состав данных см. в Получение информации об акте.
Для клиента состав данных см. в Получение информации о клиенте.
Для реселлера состав данных см. в Получение информации о реселлере.
Для списания состав данных см. в Получение информации о списании конечного клиента.

Для заказа:

Название	Тип данных	Описание
created_at	string	Дата и время создания заказа
updated_at	string	Дата и время последнего изменения заказа
account_id	integer	ID клиента
total	string	Общая сумма заказа
payment_id	integer	ID способа оплаты (см. Просмотр списка способов оплаты)
status	string	Статус заказа (список статусов см. в Просмотр информации о заказе)
type	string	Тип заказа (список типов см. в Просмотр информации о заказе)
expiration_date	string	Дата, до которой заказ должен быть оплачен (см. Создание правила обслуживания)
owner_id	integer	ID Владельца клиента
promo_code	string	Промо-код, использованный для получения скидки
document_id	string	Номер заказа
requester_ip	string	IP-адрес заказчика
manager_id	integer	ID менеджера клиента
custom_price	bool	Признак заказа по индивидуальным ценам: true — Заказ подписки по индивидуальным ценам. false — Заказ подписки по ценам, указанным в тарифном плане.
net_cost	string	Себестоимость подписки в заказе
discount_amount	string	Размер скидки по заказу
payment_model	string	Модель оплаты: prepay — Предоплата. postpay — Постоплата.
closed_at	string	Дата завершения заказа
provisioning_date	string	Дата предоставления заказа

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

Название	Тип данных	Описание
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	integer	ID клиента, для которого производится корректировка
status	string	Текущий статус корректировки: approval_required — корректировка создана, но не подтверждена. approved — корректировка подтверждена. declined — корректировка отклонена.
total	string	Сумма корректировки
сomment	bool	Комментарий к корректировке
period_from	string	Всегда null
period_to	string	Всегда null
approved_at	string	Дата подтверждения корректировки (ГГГГ-ММ-ДД)
subscription_id	integer	Всегда null

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

GET /api/v3/resellers/1/payments/9714?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": [
                    {
                        "id": "32",
                        "type": "corrections"
                    },
                    {
                        "id": "34",
                        "type": "corrections"
                    },
                    {
                        "id": "35",
                        "type": "corrections"
                    }
                ]
            },
            "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": {
                ...
            }
        }
    ]
}