Создание Платежа

Метод Create a Payment используется для создания Платежа.

 

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

Аргументы

Название

Тип параметров

Тип данных

Обязательный/Опциональный

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

account_id

form

integer

Обязательный

ID аккаунта

manager_id

form

integer

Опциональный

ID менеджера

total

form

decimal

Обязательный

Общая сумма платежа

comment

form

string

Обязательный

Комментарий

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

Название

Тип данных

Описание

id

integer

ID заказа.

account_id

integer

ID клиента, который произвел оплату.

totalfloatОбщая сумма платежа.
commentstringКомментарий к платежу.

created_at

date

Дата и время создания платежа.

updated_at

date

Дата и время последнего изменения платежа.

statusstring

Статус платежа:

  • waiting for payment - платеж был добавлен, но не подтвержден;
  • completed - платеж был успешно обработан (подтвержден);
  • receipt creating - счет на оплату формируется Сотрудником вручную (см. Обработка Платежа с ручным методом выставления Счета);
  • receipt sent - счет на оплату сформирован Сотрудником вручную и отправлен клиенту;
  • cancelled - платеж был отменен.
payment_method_idintegerID способа оплаты платежа.
document_idstringНомер платежа, указываемый в платежном документе клиента (формируется с маской (формат идентификатора), см. Системные настройки в ActivePlatform. Руководство по Панели управления Оператора)

requester IP

stringIP-адрес плательщика.

manager_id

integerID менеджера, ответственного за обработку платежа.

denominated

 

Внутренний параметр, который использовался в период проведения деноминации белорусского рубля:

  • true - сумма платежа в валюте BYN;
  • false - сумма платежа в валюте BYR.
expiration_datedata Дата истечения платежа, для автоматически создаваемых платежей с платежным методом "Пост-оплата". В текущей версии ActivePlatform не используется.

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

POST http://billing.activeplatform.com:80/api/vendor/v1/payments.json?api_token=654321
{  
 "account_id": 2000532,
 "total": 100,
 "comment": "Наличные"
}

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

{
  "id": 2007039,
  "account_id": 2000532,
  "total": "100.0",
  "comment": "Наличные",
  "created_at": "2016-10-04T10:52:17.813+03:00",
  "updated_at": "2016-10-04T10:52:17.813+03:00",
  "status": "waiting_for_payment",
  "payment_method_id": null,
  "document_id": "P006131",
  "requester_ip": "178.159.242.50",
  "manager_id": null,
  "denominated": false,
  "expiration_date": null
}