Получение статуса исходящего платежного требования
/v1/payment-requests/outgoing/{externalId}/state
Запрос на получение статуса исходящего платежного требования.
Должен содержать токен доступа (access_token
) пользователя в параметре Authorization заголовка и идентификатор документа (externalId
) в параметрах запроса.
Для доступа к этому методу в параметре scope
ссылки авторизации пользователя должен быть указан сервис PAYMENT_REQUEST_OUT
.
Запрос
Path Parameters
Внешний UUID исходящего платежного требования
Header Parameters
Access token организации-клиента, полученный через SSO
"Успешный код возврата"
bankStatus | Наименование статуса | Назначение кода состояния |
---|---|---|
Промежуточные статусы/Продолжать опрашивать | ||
ACCEPTED | Принят | Электронный документ принят на стороне Банка |
ACCEPTED_BY_ABS | Принят АБС | Электронный документ был принят к обработке в АБС Банка |
CARD2 | Картотека 2 | Электронный документ передан в картотеку в ожидание средств на счету клиента |
CREATED | Создан | Документ записан в БД, проверки не выполнялись |
DELAYED | Приостановлен | Обработка электронного документа была приостановлена |
DELIVERED | Доставлен | Запрос доставлен в ДБО и взят в обработку |
EXPORTED | Выгружен | Электронный документ выгружен Банком в АБС |
FRAUDALLOW | Одобрен ФРОД | Проверка во ФРОДЕ прошла успешно, переход на «Принят» |
FRAUDDENY | Отвергнут ФРОД | Документ отказан на основе проверки в АС Fraud-мониторинг, переходим в «Отвергнут банком» |
FRAUDREVIEW | На проверке у специалиста Банка | Со стороны ФРОД-анализа получен статус документа «На проверке у специалиста Банка» |
FRAUDSENT | Отправлен во ФРОД | Документ отправлен на проверку в АС Fraud-мониторинг |
FRAUDSMS | Требуется подтверждение sms-паролем | Со стороны ФРОД-анализа получен статус документа «Требуется подтверждение sms-паролем» |
PARTSIGNED | Частично подписан | ЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей |
PROCESSING | В обработке | Клиент сформировал «Заявление об акцепте/частичном акцепте/отказе от акцепта» |
REQUESTED_RECALL | Запрошен отзыв | Документ отозван |
SENDED_TO_PAYER | Отправлен плательщику | Документ отправлен плательщику, который является клиентом Сбербанка |
SIGNED | Подписан | ЭД подписан предусмотренным для него комплектом подписей |
SUBMITTED | Представлен | Электронный документ принят ВК |
Окончательные статусы/Прекратить опрос | ||
CHECKERROR | Ошибка контроля | ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками |
CHECKERROR_BANK | Ошибка контроля, Банк | ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками |
DECLINED_BY_PAYER | Отвергнут плательщиком | Документ отвергнут плательщиком |
INVALIDEDS | ЭПАСП не верна | Проверка ЭП под ЭД на стороне Банка дала отрицательный результат |
RECALL | Отозван | Электронный документ был отозван Клиентом по запросу |
REFUSED_BY_RZK | Отказан контролирующей организацией | ЭД не прошел проверки контролирующей организацией |
REFUSEDBYBANK | Отвергнут банком или Отклонен банком | Электронный документ отвергнут банком |
REQUISITEERROR | Ошибка реквизитов | В ЭД указаны ошибочные реквизиты |
REFUSEDBYABS | Отказан АБС | ЭД не прошел проверки в АБС |
NONEACCEPTANCE | Отказ от акцепта | Получатель отказался от акцепта. |
Окончательные(Успешные) статусы/Прекратить опрос | ||
IMPLEMENTED | Исполнен | Электронный документ исполнен Банком |
SENDED_TO_PAYER | Отправлен плательщику | Документ отправлен плательщику, который не является клиентом Сбербанка |
- application/json
- Схема
- Пример из схемы
Schema
Статус документа
Возможные значения: <= 255 characters
Банковский комментарий к статусу документа
Комментарий, специфичный для документа, полученного по данному каналу
Hash от ключевых полей документа
{
"bankStatus": "PROCESSING",
"bankComment": "Документ в обработке",
"channelInfo": "string",
"crucialFieldsHash": "string"
}
Ошибка в запросе или его жизненном цикле
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
Причина или основание сообщения
Сообщение
Уникальный идентификатор ошибки (UUID)
Внутренний код ошибки.
Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.
{
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"cause": "string",
"message": "string",
"referenceId": "string",
"internalErrorCode": "string"
}
Не авторизован
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Операция не может быть выполнена: доступ к ресурсу запрещен
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Не найдено
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Превышен лимит запросов
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Внутренняя ошибка сервера
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Сервис временно недоступен
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}