Получение списка способов оплаты

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

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

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого запрашивается список способов оплаты

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID способа оплаты
	type		string	Тип данных
	attributes		object	Информация о способе оплаты
		name	string	Название способа оплаты
		icon_url	string	Ссылка на иконку способа оплаты
		description	string	Описание способа оплаты
		integration_type	string	Тип интеграции (см. ): payment_plugin — платежный модуль. external_payment_gateway — коннектор платежного шлюза.
		plugin_id	string	ID модуля, если `integration_type = payment_plugin`
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1938/payment_methods' \
--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": "1",
            "type": "payment_methods",
            "attributes": {
                "name": "Cash",
                "icon_url": null,
                "description": "CheckCash plugin payment method",
                "integration_type": "payment_plugin",
                "plugin_id": "check_cash"
            }
        },
        {
            "id": "2",
            "type": "payment_methods",
            "attributes": {
                "name": "Pay online",
                "icon_url": "https://storage.test.activeplatform.com/public/images/payment_method/2/Credit-card_2x.png",
                "description": "Online payment by card",
                "integration_type": "external_payment_gateway",
                "plugin_id": null
            }
        }
    ],
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}