Метод: check
Метод служит для уточнения параметра paymentId. Необходим, если процессинг не отдал ответ при платеже или система партнера не получила его.
URL
POST https://api-pvk.prostodar.ru/partner/brs/check/
Описание
Метод позволяет получить внешний идентификатор транзакции (paymentId), который был сформирован для транзакции с заданным requestId. Для выполнения запроса необходимо указать уникальный идентификатор запроса и авторизационные данные партнера.
Структура запроса
Пример запроса
Формат запроса:
POST https://api-pvk.prostodar.ru/partner/brs/check/ ?requestId=some_unique_request_id &partnerName=mts &partnerPassword=some_unique_password &useAuthByCert=Y
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование | Цвет |
|---|---|---|---|---|---|
requestId |
string | Уникальный идентификатор запроса, состоящий из трехзначного числового префикса и буквенно-цифрового идентификатора | Да | Да | |
partnerName |
string | Уникальное имя партнера | Да | Нет | |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да | |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"paymentId": "8654854"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
paymentId |
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 |
Ошибка банка. Подробнее о причинах отмены платежа: Таблица причин отмены платежа |