payment/state
Запрос расширенного статуса платежной сессии.
- Метод:
POST
- Адрес ресурса:
/api/v1/payment/state
Параметры запроса
Наменование | Тип | Обязательно | Описание |
---|---|---|---|
payment_id | Строка | Да | Идентификатор платежа в системе эквайринга |
Параметры ответа
Наменование | Тип | Обязательно | Описание |
---|---|---|---|
status | Строка | Да | Статус запроса - success, error |
payment_id | Строка | Да(при успешном запросе) | Идентификатор платежа в системе эквайринга |
order_id | Строка | Да(при успешном запросе) | Идентификатор заказа в системе продавца |
state | Строка | Да(при успешном запросе) | Состояние платежа |
error | Строка | Нет | Тип ошибки |
errors | Строка[] | Нет | Описание ошибки(ошибок) |
Состояния платежа
Наменование | Описание |
---|---|
created | Платеж зарегистрирован |
preauth | Предавторизованная сумма удержана |
completed | Платеж успешно завершен |
canceled | Платеж отменен |
refunded | Произведена операция возврата |
rejected | Платеж отклонен |
Пример запроса и ответа
Запрос
curl \
-H "Authorization: Bearer hEjM719pNaX6Xp-rF_bCoT564vKQH7GzGL2CZ1iv9mI" \
-H "Signature: 6vWcMfbZEk54Ql2D3fKV1R0SRepUPgwMacFPwfz2H7MEK+h...M9dFWPXkLu4hHb4c64KsyTBp82L2Pm9ggHTjf+A==" \
-H "Content-Type: application/json" \
-d '{ "payment_id": "1" }' \
-X POST https://pay.primorsky.online/api/v1/payment/state
Ответ
{
"status": "success",
"payment_id": "1",
"order_id": "1",
"state": "rejected"
}
Ответ(ошибка)
{
"status": "error",
"error": "NOT_FOUND",
"error_messages": ["платежная сессия не найдена"]
}