Метод: status
Метод служит для получения статуса транзакции.
URL
POST https://api.prostodar.ru/partner/sbp/status
Описание
Метод позволяет получить текущий статус перевода по СБП. Возвращается идентификатор транзакции и ее статус.
Для выполнения запроса требуется передать:
Авторизационные данные — уникальное имя партнера и API пароль.
- Шифрование данных — использование открытого ключа RSA для безопасной передачи параметров.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API.
Структура запроса
Пример запроса
Формат запроса: POST https://api.prostodar.ru/partner/sbp/status
Тело запроса:
{
"id":"Smth id",
"partnerName": "Smth name",
"partnerPassword": "Smth password",
"useAuthByCert": "Y"
}
Параметры запроса
Параметр | Тип | Описание | Обязательный | Шифрование |
---|---|---|---|---|
Id |
string | Уникальный идентификатор транзакции в системе партнера. | Да | Да |
partnerName |
string | Уникальное имя партнера | Да | Нет |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"id": "smth id",
"description_status": "Успешно",
}
Примечание: Код состояния 200
Параметры успешного ответа
Параметр | Тип | Описание |
---|---|---|
id |
string | Идентификатор транзакции в системе партнера |
description_status |
string | Описание статуса транзакции |
Возможные ответы, когда статус транзакции не определен
Код состояния | Значение description_status |
---|---|
202 | Статус операции не определен, выполните запрос позже |
Пример ответа с ошибкой
{
"description_status": "Сервис временно недоступен. Повторите операцию позднее.",
}
Параметры ответа с ошибкой
Параметр | Тип | Описание |
---|---|---|
description_status | string | Текстовое описание ошибки |
Возможные ошибки
Код состояния | Значение description_status |
---|---|
400 | Нет операции с таким id |
400 | Нет идентификатора получателя. Необходимо заполнить person_id. |
403 | Пользователь не прошел авторизацию. Доступ к ресурсу ограничен. |
422 | При обращении к методу не был указан обязательный реквизит наименование_реквизита, повторите запрос с корректными данными |
422 | Параметр название_параметра ожидается в зашифрованном виде. |
500 | Сервис временно недоступен. Повторите операцию позднее. |
500 | Операция завершилась отказом по СБП |
500 | Ошибка на стороне api.prostodar обратитесь в техническую поддержку |
503 | Ошибка на стороне СБП\Банка. Повторите операцию позднее |
503 | Технологические работы в Банке получателя. Повторите операцию позднее |