Метод используется для оплаты платежа с баланса аккаунта, к которому есть доступ у текущего пользователя.
В результате вызова метода платеж переходит в статус Оплачен с баланса, кроме следующих случаев, когда оплата с баланса невозможна:
-
Выполняется попытка оплатить с баланса платеж на пополнение баланса.
-
На балансе недостаточно средств с учетом порога срабатывания финансовой блокировки и возможности оплачивать платеж с отрицательным балансом.
-
Правило предоставления тарифного плана подписки, связанной с платежом, не допускает оплату с обещанным платежом, и при этом аккаунту предоставлен обещанный платеж.
-
Статус платежа отличается от Ожидает оплаты и Просрочен.
-
Платеж ранее был частично оплачен с баланса (см. Частичная оплата платежа с баланса).
Метод возвращает пустой ответ. Код ответа 204 No content.
PATCH {reseller_domain}/internal_api/accounts/{account_id}/payments/{payment_id}/pay_from_balance
В этой статье:
Авторизация
Требуется авторизация с помощью 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 пользователя. Формат: |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
account_id |
path |
integer |
Обязательный |
ID аккаунта, для которого оплачивается платеж |
|
payment_id |
path |
integer |
Обязательный |
ID платежа |
Пример запроса
curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/1938/payments/13301/pay_from_balance' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'AccessTokenExample'