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

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

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

Двухбуквенный код языка данных в ответе

Authorization 

header

string

Обязательный

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

Обязательный

Доменное имя реселлера

account_id

path

integer

Обязательный

ID аккаунта, для которого запрашивается список платежей

page[size]

query

integer

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

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

integer

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

Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)

filter[document_id][like]

query

string

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

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

filter[payment_status]

query

string

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

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

• pending_billing — Ожидание счета.

• waiting_for_payment — Ожидает оплаты.

• expired — Просрочен.

• completed — Завершен.

• paid_from_balance — Оплачен с баланса.

• processing — Обрабатывается.

• invoice_creation — Счет формируется.

• invoice_sent — Счет отправлен.

filter[created_at]

query

string

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

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

• filter[created_at][gt] — дата больше, чем указанная.

• filter[created_at][lt] — дата меньше, чем указанная.

• filter[created_at][gteq] — дата больше, чем указанная, или равна.

• filter[created_at][lteq] — дата меньше, чем указанная, или равна.

filter[сlosed_at]

query

string

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

Предназначен для фильтрации списка по дате завершения платежа в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:

• filter[сlosed_at][gt] — дата больше, чем указанная.

• filter[сlosed_at][lt] — дата меньше, чем указанная.

• filter[сlosed_at][gteq] — дата больше, чем указанная, или равна.

• filter[сlosed_at][lteq] — дата меньше, чем указанная, или равна.

filter[id]

query

integer

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

Предназначен для фильтрации списка по ID платежа

sort

query

string

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

Предназначен для сортировки элементов списка по указанному параметру. Доступные значения:

• sort=created_at — сортировка по возрастанию значений created_at.

• sort=-created_at — сортировка по убыванию значений created_at.

include

query

string

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

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

data

array of objects

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

id

string

ID платежа

type

string

Тип данных

attributes

object

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

created_at

string

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

document_id

string

Номер платежа

status

string

Статус платежа (подробнее о статусах см.

):

• pending_billing — Ожидание счета.

• waiting_for_payment — Ожидает оплаты.

• expired — Просрочен.

• completed — Завершен.

• paid_from_balance — Оплачен с баланса.

• processing — Обрабатывается.

• invoice_creation — Счет формируется.

• invoice_sent — Счет отправлен.

total

number

Сумма к оплате

amount_paid_from_balance

number

Часть суммы, оплаченная с баланса (см.

)

initial_total

number

Изначальная сумма платежа

reseller_currency_iso_code

string

Код валюты

payment_model

string

Модель оплаты:

• prepay — Предоплата. Для платежа на пополнение баланса всегда модель оплаты Предоплата.

• postpay — Постоплата.

is_topup

bool

Признак платежа для пополнения баланса:

• true — платеж для пополнения баланса.

• false — платеж другого типа (см. ).

purpose

string

Назначение платежа

is_joined

bool

Признак объединенного платежа:

• true — объединенный платеж.

• false — отдельный платеж.

topup_sum

number

Сумма для пополнения баланса

due_date

string

closed_at

string

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

payment_method_attributes

object

Информация о связанном способе оплаты

id

integer

ID способа оплаты

name

string

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

plugin_id

string

ID платежного модуля, на основе которого создан способ оплаты

invoice_data

array of objects

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

name

string

Название инвойса

url_for_download

string

Ссылка для скачивания

external_id

integer

Внешний ID

external_invoice_type

string

Тип внешнего инвойса

full_name

string

Полное название внешнего инвойса

external_total

number

Сумма внешнего инвойса. Может отличаться от суммы платежа

external_total_with_currency

string

Сумма внешнего инвойса с указанием валюты. Валюта может отличаться от валюты реселлера

external_invoice_generation

bool

Признак использования внешнего управления инвойсами (только для платежей по модели Постоплата):

• true — внешняя система управляет инвойсами (см. ).

• false — платформа управляет инвойсами (актами по модели Постоплата).

orders

array of objects

• Список заказов, связанных с платежом по модели Предоплата.

• Пустой массив для платежей на пополнение баланса и платежей по модели Постоплата. См. charges

id

integer

ID заказа

document_id

string

Номер заказа

type

string

Тип заказа:

• SalesOrder — заказ на покупку.

• SwitchPlanOrder — заказ на переключение тарифного плана. См. также subtype.

• RenewalOrder — заказ на продление.

• ProlongOrder — заказ на пролонгацию.

• ChangeOrder — заказ на изменение количества ресурсов.

subtype

string

Подтип заказа:

• immediate_switch — немедленное переключение. Только для заказа на переключение тарифного плана.

• delayed_switch — отложенное переключение. Только для заказа на переключение тарифного плана.

• null — для всех остальных типов заказа.

total

number

Сумма заказа в валюте реселлера

subscription

object

Информация о подписке, для которой оформлен заказ

id

integer

ID подписки

name

string

Название подписки

billing_type

string

Тип биллинга тарифного плана, на который заказана подписка (см.

)

payment_model

string

Модель оплаты подписки:

• prepay — Предоплата.

• postpay — Постоплата.

detail_items

array of objects

Список позиций в заказе

description

string

Описание позиции

quantity_float

string

Количество заказанных единиц услуги или ресурса

duration_float

string

Оплачиваемый период в месяцах

unit_price

string

Цена за единицу услуги или ресурса с указанием валюты реселлера

discount_amount

string

Скидка с указанием валюты реселлера

amount

string

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

charges

array of objects

• Пустой массив для платежей на пополнение баланса и платежей по модели Предоплата.

• Список списаний, сформированных по заказам. Используется для отображения детальной информации о платежах по модели Постоплата вместо orders

id

integer

ID списания

created_at

string

Дата создания списания

type

string

Тип списания

description

string

Описание

quantity_float

string

Количество заказанных единиц услуги или ресурса

duration_float

string

Оплачиваемый период в месяцах

operate_from

string

Дата начала оплачиваемого периода

operate_to

string

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

unit_price

string

Цена за единицу услуги или ресурса с указанием валюты реселлера

discount_amount

string

Скидка с указанием валюты реселлера

amount

string

Сумма списания с указанием валюты реселлера

total

number

Сумма списания в валюте реселлера

reseller_currency_iso_code

string

Код валюты реселлера

item_target_data

object

Информация о сущности из заказа, для которой сформировано списание

target_id

integer

ID сущности

target_type

string

Тип сущности

type

string

Тип списания

description

string

Название сущности

subscription

object

Информация о подписке, для которой сформировано списание

id

integer

ID подписки

name

string

Название подписки

billing_type

string

Тип биллинга тарифного плана, на который заказана подписка (см.

)

payment_model

string

Модель оплаты подписки:

• prepay — Предоплата.

• postpay — Постоплата.

available_operations

object

Доступные действия над платежом

cancel

bool

Отмена (см. Отмена платежа):

• true — действие доступно.

• false — действие недоступно.

recreate

bool

Изменение (см. Изменение платежа):

• true — действие доступно.

• false — действие недоступно.

pay

bool

Оплата с помощью способа оплаты (см. Оплата платежа с помощью способа оплаты):

• true — действие доступно.

• false — действие недоступно.

pay_from_balance

bool

Оплата с баланса аккаунта (см. Оплата платежа с баланса аккаунта):

• true — действие доступно.

• false — действие недоступно.

partial_pay

bool

Частичная оплата с баланса аккаунта (см. Частичная оплата платежа с баланса):

• true — действие доступно.

• false — действие недоступно.

separate

bool

Разъединение (см. Разъединение платежей):

• true — действие доступно.

• false — действие недоступно.

join

bool

Объединение (см. Объединение платежей):

• true — действие доступно.

• false — действие недоступно.

autopay_from_balance

bool

processing_error

Информация об ошибках обработки платежа во внешней системе

taxes_total

object

Итоговые данные налогов (см.

). Для платежа на пополнение баланса — null

total

string

Сумма все налогов по всем списаниям с указанием валюты реселлера

taxes

array of objects

Итоговые данные каждого налога

name

string

Название налога

rate

number

Ставка налога в процентах

amount

number

Сумма налога по всем списаниям в валюте реселлера

origin_id

integer

ID налога в налоговом модуле

amount_with_currency

string

Сумма налога по всем списаниям с указанием валюты реселлера

relationships

object

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

charges

object

Информация о списаниях

data

array of objects

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

included

array of objects

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

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

• Для налогов — о каждом налоге, использованном при создании списания (см. ):

  Название			Тип данных	Описание
  id			string	ID налога
  type			string	Тип данных
  attributes			object	Информация о налоге
  	created_at		string	Дата и время создания налога
  	updated_at		string	Дата и время последнего изменения налога
  	charge_id		integer	ID списания, для которого рассчитан налог
  	origin_id		integer	ID налога в налоговом модуле
  	name		string	Название налога
  	code		string	Код налога
  	rate		number	Размер налога в процентах
  	amount		number	Сумма налога в валюте реселлера, рассчитанная для net_amount списания

links

object

Ссылки для постраничной навигации

self

string

Текущая страница

first

string

Первая страница

prev

string

Предыдущая страница (при наличии)

next

string

Следующая страница (при наличии)

last

string

Последняя страница

meta

object

Дополнительная информация

current_page

integer

Номер текущей страницы

page_count

integer

Общее число страниц

server_current_time

string

Текущие дата и время сервера