Отмена Платежа

Метод Cancel the Payment позволяет отменить Платеж. В результате выполнения метода Платеж получит статус Отменен (Cancelled).

Проведение данной операции возможно для Платежей со статусом Ожидает оплаты.

DELETE /api/vendor/v1/payments/{id}.json?api_token={api_token}

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
id	path	integer	Обязательный	ID платежа.
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора).

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

Название	Тип данных	Описание
id	integer	ID заказа.
document_id	string	Номер платежа, указываемый в платежном документе клиента (формируется с маской (формат идентификатора), см. Системные настройки в ActivePlatform. Руководство по Панели управления Оператора).
status		Статус платежа: waiting for payment - платеж был добавлен, но не подтвержден; completed - платеж был успешно обработан (подтвержден); receipt creating - счет на оплату формируется Сотрудником вручную (см. Обработка Платежа с ручным методом выставления Счета); receipt sent - счет на оплату сформирован Сотрудником вручную и отправлен клиенту; cancelled - платеж был отменен.
account_id	integer	ID клиента, которому принадлежит платеж
created_at	date	Дата и время создания платежа.
updated_at	date	Дата и время последнего изменения платежа.
total	float	Общая сумма платежа.
comment	string	Комментарий к платежу.
requester IP	string	IP-адрес плательщика.
manager_id	integer	ID менеджера, ответственного за обработку платежа.
payment_method_id	integer	ID способа оплаты платежа.
payment_method_name	string	Наименование способа оплаты.
orders	array	Список заказов связанных с данным платежом (см. Получение списка Заказов)

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

DELETE http://billing.activeplatform.com:80/api/vendor/v1/payments/2007039.json?api_token=654321

Пример ответа

{
  "id": 2007039,
  "document_id": "P006131",
  "status": "cancelled",
  "account_id": 2000532,
  "created_at": "2016-10-04T10:52:17.813+03:00",
  "updated_at": "2016-10-04T11:11:32.490+03:00",
  "total": 100,
  "comment": "Наличные",
  "requester_ip": "178.159.242.50",
  "manager_id": null,
  "payment_method_id": null,
  "payment_method_name": null,
  "orders": []
}