Метод: brs_get_status
Метод служит для проверки статуса перевода средств на банковскую карту.
URL
POST https://api.prostodar.ru/partner/brs_get_status/
Описание
Метод позволяет получить текущий статус перевода на банковскую карту.
Для выполнения запроса необходимо передать:
- Идентификатор платежа — уникальный номер, связанный с переводом.
- Авторизационные данные партнера — имя партнера и пароль, обеспечивающие доступ к API.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API.
Структура запроса
Пример запроса
Формат запроса:
POST https://api.prostodar.ru/partner/brs_get_status/ ?partnerName=name &partnerPassword=password &paymentId=123456 &useAuthByCert=Y
Параметры запроса
Параметр | Тип | Описание | Обязательный | Шифрование | |
---|---|---|---|---|---|
partnerName |
int | Уникальное имя партнера | Да | Нет | |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да | |
paymentId |
string | Уникальный идентификатор платежа | Да | Да | |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"payment_status": "finished",
"payment_date_status": "2023-10-01 10:45:00",
"message":""
}
Параметры успешного ответа
Параметр | Тип | Описание |
---|---|---|
status |
string | Статус прохождения запроса |
payment_status |
string | Статус платежа (список статусов) |
payment_date_status |
string | Дата и время изменения статуса платежа |
message |
string | Причина отмены платежа (список причин отмены платежа) |
Пример ответа с ошибкой
{
"status": "REQUEST_INCORRECTLY",
"message": "Invalid authorization is used"
}
Параметры ответа с ошибкой
Параметр | Тип | Описание |
---|---|---|
status |
string | Статус ошибки |
message |
string | Текстовое описание ошибки |
Возможные ошибки
Статус | Текстовое описание ошибки | Описание |
---|---|---|
PARTNER_LOGIN_IS_NOT_CORRECT |
Partner name or password is not correct | Партнер с таким логином и паролем не найден |
NOT_VALID_IP_PARTNER |
Partner IP is not correct | IP партнера некорректен |
ACCOUNT_IS_BLOCKED |
Account is blocked | Аккаунт заблокирован |
REQUEST_INCORRECTLY |
Invalid authorization is used | Ошибка в шифровании сертификатом |
REQUEST_ID_ALREADY_EXISTS |
Request id already exists | Запрос с таким идентификатором уже существует |
NO_MONEY |
There are no funds on the balance sheet | Недостаточно средств для операции |
SERVICE_UNAVAILABLE |
Service is temporarily unavailable. | Сервис временно недоступен |
BRS_ERROR |
Ошибка банка. Подробнее о причинах отмены платежа: Таблица причин отмены платежа |