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