Получение списка транзакций

Метод используется для получения многостраничного списка транзакций по балансу аккаунта, к которому есть доступ у текущего пользователя.

GET {reseller_domain}/internal_api/accounts/{account_id}/balance_transactions

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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[total]	query	number	Опциональный	Предназначен для фильтрации списка по сумме транзакции. Для указания диапазона используются следующие фильтры: filter[total][gt] — сумма больше, чем указанная. filter[total][lt] — сумма меньше, чем указанная.
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID транзакции
	type		string	Тип данных
	attributes		object	Информация о транзакции
		created_at	string	Дата и время создания транзакции
		description	string	Описание и тип операции, вызвавшей транзакцию: Описание списания. Пополнение баланса. Обещанный платеж. Корректировка баланса.
		total	number	Сумма транзакции
		reseller_currency_iso_code	string	Код валюты реселлера
		balance	number	Свободные средства на балансе аккаунта после завершения транзакции
links			object	Ссылки для постраничной навигации
	self		string	Текущая страница
	first		string	Первая страница
	prev		string	Предыдущая страница (при наличии)
	next		string	Следующая страница (при наличии)
	last		string	Последняя страница
meta			object	Дополнительная информация
	current_page		integer	Номер текущей страницы
	page_count		integer	Общее число страниц
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1938/balance_transactions' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": [
        {
            "id": "40439",
            "type": "balance_transactions",
            "attributes": {
                "created_at": "2022-12-04T01:06:38.804587+0300",
                "description": "Prolongation resource (recurring fee) \"Licenses\" for Subscription #3009331 \"Office\" from 28.11.2022 to 30.11.2022",
                "total": -45.5,
                "reseller_currency_iso_code": "USD",
                "balance": 1963.02
            }
        },
        {
            "id": "40286",
            "type": "balance_transactions",
            "attributes": {
                "created_at": "2022-11-28T16:10:44.353288+0300",
                "description": "Top up",
                "total": 2000.0,
                "reseller_currency_iso_code": "USD",
                "balance": 2008.52
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1707/balance_transactions?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1707/balance_transactions?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1707/balance_transactions?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}