Получение списка обещанных платежей

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

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

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

Авторизация

Требуется авторизация с помощью 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 по умолчанию)
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID обещанного платежа
	type		string	Тип данных
	attributes		object	Информация об обещанном платеже
		document_id	string	Номер обещанного платежа
		created_at	string	Дата и время создания обещанного платежа
		expiration_date	string	Дата истечения обещанного платежа (ГГГГ-ММ-ДД)
		revoke_date	string	Дата отзыва обещанного платежа (ГГГГ-ММ-ДД)
		status	string	Статус обещанного платежа (см. ): provided — Предоставлен — обещанный платеж создан, баланс аккаунта увеличен на его сумму. revoked — Отозван — обещанный платеж отозван вручную менеджером, или автоматически в дату истечения, или в результате пополнения баланса аккаунта на сумму, равную или большую сумме обещанного платежа. revoked_because_of_top_up — Отозван в связи с пополнением баланса — обещанный платеж отозван автоматически в результате пополнения баланса аккаунта на сумму, меньшую суммы обещанного платежа. provided_because_of_top_up — Предоставлен в связи с пополнением баланса — новый обещанный создан автоматически в результате пополнения баланса аккаунта на сумму, меньшую суммы обещанного платежа.
		total	number	Сумма обещанного платежа в валюте реселлера
		reseller_currency_iso_code	string	Код валюты реселлера
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/guaranteed_payments' \
--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": "199",
            "type": "guaranteed_payments",
            "attributes": {
                "document_id": "GP000185",
                "created_at": "2023-01-25T10:26:30.344585+0300",
                "expiration_date": "2023-02-01",
                "revoke_date": "2023-01-25",
                "status": "revoked_because_of_top_up",
                "total": 500,
                "reseller_currency_iso_code": "USD"
            }
        },
        {
            "id": "200",
            "type": "guaranteed_payments",
            "attributes": {
                "document_id": "GP000186",
                "created_at": "2023-01-25T10:27:09.250290+0300",
                "expiration_date": "2023-02-01",
                "revoke_date": null,
                "status": "provided_because_of_top_up",
                "total": 200,
                "reseller_currency_iso_code": "USD"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1938/guaranteed_payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1938/guaranteed_payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1938/guaranteed_payments?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"
    }
}