POST/invoice/create

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

Создаёт счёт на оплату и возвращает ссылку на платёжную форму. Перенаправьте клиента по этой ссылке — он выберет метод оплаты и оплатит счёт. О результате вы узнаете из webhook.

Запрос

Заголовки

В заголовке x-api-key передаётся секретный ключ кассы. Подробнее об авторизации
  1. 1.Accept: application/json
  2. 2.Content-Type: application/json
  3. 3.x-api-key: {ShopSecretKey}

Параметры тела запроса

shop_iduuidобязательный
Идентификатор кассы
amountnumberобязательный
Сумма к оплате. Дробная часть — через точку, например 10.28
order_idstring, до 255обязательный
Идентификатор заказа в вашей системе
currencystring, до 10
Валюта платежа, по умолчанию RUB. Список валют
commentstring, до 255
Назначение платежа — клиент увидит его на странице оплаты
success_urlstring, до 255
Куда вернуть клиента после успешной оплаты. Если не передан — берётся из настроек кассы
fail_urlstring, до 255
Куда вернуть клиента, если оплата не прошла. Если не передан — берётся из настроек кассы
hook_urlstring, до 500
Адрес для webhook об оплате. Если не передан — берётся из настроек кассы
custom_fieldsstring (JSON), до 500
Произвольные данные. Вернутся без изменений в webhook и в информации о платеже
expireint, минуты
Время жизни счёта. По умолчанию 300 (5 часов), максимум — 5 дней
include_servicestring[]
Показать клиенту только эти методы оплаты
exclude_servicestring[]
Скрыть эти методы оплаты на странице счёта

Ответ

Поля объекта data:

iduuid
Идентификатор платежа в KassaGO
amountnumber
Сумма счёта
currencystring
Валюта счёта
urlstring
Ссылка на платёжную форму
expiredstring
Когда истекает счёт, формат Y-m-d H:i:s
Возможные коды ошибок: 401, 403, 404, 422, 500. Формат ошибки и расшифровка кодов — в разделе «Ответы и ошибки».