Авторизовать инвойс PIN-кодом
JSON API v3
POST /api/v3/projects/{projectId}/invoices/{invoiceId}/authorize
Авторизует созданный инвойс с помощью PIN-кода (доставляется абоненту по SMS).
В песочнице SMS не отправляется, верный PIN — фиксированный 1234. Прочие значения
дают 422 INVOICE_NOT_AUTHORIZED с числом оставшихся попыток; после трёх неудачных
попыток инвойс отвечает 422 INVOICE_AUTH_ATTEMPTS_EXCEEDED и больше не принимает
авторизацию, в том числе с верным PIN. Верный PIN переводит инвойс в active и
поднимает authorization.; запланированный исход тарификации при этом
наступает как обычно.
Payload подписи v4: {invoice_id}{pin_code}{client_ip}
Параметры запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
projectId | integer (int32) | да | |
invoiceId | string (uuid) | да |
Тело запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
client_ip | string | — | |
pin_code | string | — | PIN-код, введённый клиентом |
additional_parameters | object | — | Дополнительные параметры счёта — произвольные пары «имя — значение» (JSON-эквивалент блока <AdditionalParameters> из XML API). Через них передаются служебные флаги обработки, например NeedSendNotification, и собственные метки продавца. Имена нечувствительны к регистру и должны быть уникальны: Flag и flag в одном объекте — ошибка запроса (400 BAD_REQUEST), а не два параметра. Блок принимают создание счёта (внутри order), а также авторизация, отмена и возврат (на верхнем уровне тела): переданные значения дописываются к уже сохранённым у счёта, совпадающие по имени — перезаписываются. |
Пример запроса
{
"pin_code": "1234"
}Пример ответа
{
"success": true,
"data": {
"invoice_id": "0d0f3c58-9b1e-4a77-9a0c-000000000001",
"status": "Authorize"
}
}Коды ответов
| Код | Описание |
|---|---|
200 | Инвойс авторизован |
400 | Ошибка валидации или бизнес-ошибка запроса |
401 | Ошибка аутентификации (отсутствует/неверна подпись или временная метка) |
403 | Доступ к проекту запрещён или IP не в белом списке |
404 | Инвойс не найден |
422 | Ошибка бизнес-валидации |
500 | Непредвиденная ошибка платформы |
503 | Сервис временно недоступен |