Получение статуса рублевого платежного поручения

Обновлено 28 марта 2025

GET

/v1/payments/{externalId}/state

Возвращает статус ранее сформированного черновика платежного поручения. В случае, если у Клиента отключена услуга на формирование платежных поручений (или срок соглашения истек), вы все равно сможете получить статус готовых документов.

Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка.

Для доступа к этому методу в параметре scope ссылки авторизации пользователя должен быть указан один из сервисов:

PAY_DOC_RU
PAY_DOC_RU_INVOICE
PAY_DOC_RU_INVOICE_ANY
PAY_DOC_RU_INVOICE_BUDGET

При исполнении запроса в тестовом контуре статус «Исполнено» не будет возвращен. Для подтверждения завершения платежа, поручение по которому все еще находится в статусе ожидания, пожалуйста, свяжитесь с поддержкой supportdbo2@sberbank.ru, указав externalid в обращении.

Запрос

Path Parameters

externalId

string

required

Внешний UUID платежного поручения

Ответы

"Успешный запрос статуса"

bankStatus	Наименование статуса	Назначение кода состояния
Промежуточный/Продолжать опрашивать
`ACCEPTED`	Принят	Электронный документ принят на стороне Банка
`ACCEPTED_BY_ABS`	Принят АБС или Принят	Электронный документ был принят к обработке в АБС Банка
`CARD2`	Картотека 2 или Ожидает оплаты	АБС обнаружено, что на счете плательщика недостаточно средств для иcполнения документа
`CREATED`	Создан	Документ записан в БД, проверки не выполнялись
`CHECKERROR`	Ошибка контроля	ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками
`DELAYED`	Приостановлен	Обработка электронного документа была приостановлена
`DELIVERED`	Доставлен	Запрос доставлен в ДБО и взят в обработку
`DELIVERED_RZK`	Доставлен в СБК	Электронный документ отправлен в СБК и получен квиток о доставке
`FRAUDALLOW`	Одобрен ФРОД	Проверка во ФРОДЕ прошла успешно, переход на «Принят»
`FRAUDREVIEW`	На проверке у специалиста Банка	Со стороны ФРОД-анализа получен статус документа «На проверке у специалиста Банка»
`FRAUDSENT`	Отправлен во ФРОД	Документ отправлен на проверку в АС Fraud-мониторинг
`FRAUDSMS`	Требуется подтверждение sms-паролем	Со стороны ФРОД-анализа получен статус документа «Требуется подтверждение sms-паролем»
`NOT_ACCEPTED_RZK`	Не принят СБК	Электронный документ не прошел логические контроли СБК
`PARTSIGNED`	Частично подписан	ЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей
`PROCESSING_RZK`	Обрабатывается СБК	ЭД успешно прошел проверки ЭП и логические проверки СБК
`REQUESTED_RECALL`	Запрошен отзыв	Документ отозван
`RZK_SIGN_ERROR`	Ошибка ЭП СБК	Проверка подписи под ЭД на стороне СБК дала отрицательный результат
`SENDING_TO_RZK`	Отправляется в СБК	Электронный документ отправлен в СБК, но не получен квиток о доставке
`SIGNED`	Подписан	ЭД подписан предусмотренным для него комплектом подписей.
`TO_PROCESSING_RZK`	К отправке в СБК	ЭД подписан предусмотренным для него комплектом о доставке
Окончательный (Не успешный)/Прекратить опрос
`DELETED`	Удален	Электронный документа удален из числа действующих документов
`INVALIDEDS`	ЭП/АСП не верна Подпись неверна	Проверка ЭП под ЭД на стороне Банка дала отрицательный результат
`RECALL`	Отозван	Электронный документ был отозван Клиентом по запросу
`REFUSEDBYBANK`	Отвергнут банком или Отклонен банком	Электронный документ отвергнут банком
`REFUSEDBYABS`	Отказан АБС	Электронный документ не прошел проверки в АБС
`REQUISITEERROR`	Ошибка реквизитов	В ЭД указаны ошибочные реквизиты
`REFUSED_BY_RZK`	Отказан контролирующей организацией	Электронный документ не прошел проверки контролирующей организацией
`FRAUDDENY`	Отвергнут ФРОД	Документ отказан на основе проверки в АС Fraud-мониторинг, переходим в «Отвергнут банком»
Окончательный (Успешный)/Прекратить опрос
`IMPLEMENTED`	Исполнен	Электронный документ исполнен Банком

application/json

Схема
Пример из схемы

Schema

bankStatus

string

Статус документа

bankComment

string

Возможные значения: <= 255 characters

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

crucialFieldsHash

string

Hash от ключевых полей документа

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string",
  "crucialFieldsHash": "string"
}

"Ошибка в запросе"

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

"Не авторизован"

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "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

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

Данные не найдены

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

"Превышен лимит запросов"

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

"Внутренняя ошибка сервера"

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

"Сервис временно недоступен"

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

application/json

Схема
Пример из схемы

Schema

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

cause

string

Причина или основание сообщения

message

string

Сообщение

referenceId

string

Уникальный идентификатор ошибки (UUID)

internalErrorCode

string

Внутренний код ошибки.

Указывайте его при обращении в поддержку вместе с ответом по возникшей ошибке.

{
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ],
  "cause": "string",
  "message": "string",
  "referenceId": "string",
  "internalErrorCode": "string"
}

Это полезный материал?

Получение статуса рублевого платежного поручения

Запрос﻿

Path Parameters

Ответы﻿

Запрос

Ответы