Оплата платежа с помощью способа оплаты

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

Если указан способ оплаты на основе платежного модуля (например, CheckCash plugin), метод возвращает ссылку на платежную страницу с одноразовым токеном, который модуль сформировал для текущего пользователя.

Если указан способ оплаты на основе коннектора платежного шлюза, метод возвращает форму для оплаты в виде объекта FormData, которую затем можно подтвердить для запуска процесса оплаты платежа во внешней системе.

GET {reseller_domain}/internal_api/accounts/{account_id}/payments/{payment_id}/pay

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого оплачивается платеж
payment_id	path	integer	Обязательный	ID платежа
payment_method_id	query	integer	Обязательный	ID способа оплаты (см. Получение списка способов оплаты )

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID платежа
	type		string	Тип данных
	attributes		object	Информация о платежной странице
		type	string	Тип данных в зависимости от способа оплаты: redirect_link — указан способ оплаты на основе платежного модуля. formdata — указан способ оплаты на основе коннектора платежного шлюза.
		value	string	Значение в зависимости от типа данных: Если `type = redirect_link`, ссылка на платежную страницу с одноразовым токеном, который платежный модуль сформировал для текущего пользователя. Если `type = formdata`, форма платежной страницы, включая URL и метод для отправки формы. Параметры формы зависят от внешней системы.
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1938/payments/13303/pay?payment_method_id=1' \
--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": "13303",
        "type": "pay",
        "attributes": {
            "type": "redirect_link",
            "value": "https://test.activeplatform.com/plugin_check_cash/instructions?account_id=1938&payment_id=13303&payment_method_id=1&u_token=payment_plugin_token"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}