Получение статуса валютного платежного поручения
/v1/pay-doc-cur/{externalId}/state
Возвращает статус ранее созданного валютного платежного поручения. Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор документа (externalId), указанный при его создании.
Для доступа к этому методу в параметре scope ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR.
Запрос
Path Parameters
Уникальный идентификатор документа, присвоенный партнером
"Успешное выполнение запроса"
Значения поля bankStatus:
| Код состояния документа | Статуса |
|---|---|
| Промежуточные статусы/Продолжать опрашивать | |
ACCEPTED | Принят |
ACCEPTED_BY_ABS | Принят АБС |
ACCEPTED_BY_CFE | Принят ВК |
ACCEPTED_RZK | Акцептован СБК |
CARD2 | Картотека №2 |
CORRESPONDENT_APPROVE_WAITING | Ожидает подтверждения контрагента |
CREATED | Создан |
CHECKERROR | Ошибка контроля |
CREATED_BANK | Создан Банком |
CHECKERROR_BANK | Ошибка контроля, Банк |
DELAYED | Приостановлен |
DELIVERED | Доставлен |
EXPORTED | Выгружен |
FRAUDSMS | Требуется подтверждение СМС-паролем |
FRAUDREVIEW | На проверке у специалиста банка |
FRAUDSENT | Отправлен во ФРОД |
FRAUDALLOW | Одобрен ФРОД |
FRAUDDENY | Отвергнут ФРОД |
IMPORTED | Импортирован |
IMPORTED_BANK | Импортирован Банком |
NEED_REVIEW | Необходимы исправления |
PROCESSING | В обработке |
PUBLISHED_BY_BANK | Издан Банком |
PARTSIGNED | Частично подписан |
PROCESSING_RZK | Обрабатывается СБК |
PROCESSED | Обраб отан |
READY_TO_SEND | Ждет отправки |
RETURNED | Возвращен |
RATE_CONFIRMATION | На подтверждении курса |
SIGNED | Подписан |
SENDING | Отправляется |
SENDED | Отправлен |
SENDING_TO_RZK | Отправляется в СБК |
SIGNED_BANK | Подписан Банком |
SENT_TO_ADMIN | Передан администратору |
TEMPLATE | Шаблон документа |
TRIED | Проверен |
TO_PROCESSING_RZK | К отправке в СБК |
TO_SIGN_IN_RZK | Подписывается в СБК |
TRIED_BY_CFE | Проверяется ВК |
USER_RESERVED | Зарезервированы логины |
VALIDEDS | ЭП/АСП верна |
| Окончательные статусы/Прекратить опрос | |
CLOSED | Закрыт |
DELETED | Удален |
EXPORTED_TO_1C | Выгружен в реестр |
INVALIDEDS | ЭП/АСП не верна |
PROCESSERROR | Отказан |
REQUISITEERROR | Ошибка реквизитов |
REFUSEDBYBANK | Отвергнут Банком |
REFUSEDBYABS | Отказан АБС |
RECALL | Отозван |
RECALL_BY_BANK | Отозван Банком |
REFUSED_BY_CFE | Отказан ВК |
UNABLE_TO_DECRYPT | Ошибка шифрования |
UNABLE_TO_RECEIVE | Ошибка при приеме |
| Окончательные(Успешные) статусы/Прекратить опрос | |
IMPLEMENTED | Исполнен |
- application/json
- Схема
- Пример из схемы
Schema
Статус документа
Возможные значения: <= 255 characters
Банковский комментарий к статусу документа
Комментарий, специфичный для документа, полученного по данному каналу
{
"bankStatus": "PROCESSING",
"bankComment": "До кумент в обработке",
"channelInfo": "string"
}
"Ошибка в запросе"
| Cause | Message | Description |
|---|---|---|
| DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос. |
| VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Не авторизован"
| Cause | Message | Description |
|---|---|---|
| UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Операция не может быть выполнена: доступ к ресурсу запрещен"
| Cause | Message | Description |
|---|---|---|
| ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция PAY_DOC_RU. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщ ение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
Данные не найдены
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Превышен лимит запросов"
| Cause | Message | Description |
|---|---|---|
| TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Внутренняя ошибка сервера"
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Сервис временно недоступен"
| Cause | Message | Description |
|---|---|---|
| UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}