Метод: transfer
Метод служит для осуществления перевода на банковскую карту.
URL
POST https://api-pvk.prostodar.ru/partner/brs/transfer/
Описание
Метод позволяет выполнить перевод денежных средств на указанную банковскую карту. Для выполнения запроса необходимо указать данные партнера и платежные данные.
Структура запроса
Пример запроса
Формат запроса:
POST https://api-pvk.prostodar.ru/partner/brs/transfer/ ?requestId=some_unique_request_id &partnerName=name &partnerPassword=some_unique_password &card=5555555555554444 &sum=1000.00 &idPerson=idPerson &useAuthByCert=Y
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование | Цвет |
|---|---|---|---|---|---|
requestId |
string | Уникальный идентификатор запроса, состоящий из префикса и произвольного идентификатора | Да | Да | |
partnerName |
string | Уникальное имя партнера | Да | Нет | |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да | |
card |
string | Номер карты для перевода | Да | Да | |
sum |
float | Сумма перевода в рублях | Да | Да | |
idPerson |
string | Уникальный идентификатор лица, в адрес которого осуществлен выпуск вознаграждения | Да, если используется совместно с сервисом верификации ПД | Да | |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"message": "request successfully completed",
"paymentId": "8654854"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
message |
string | Текстовое описание результата |
paymentId |
string | Внешний идентификатор транзакции |
Пример ответа с ошибкой
{
"status": "PARTNER_LOGIN_IS_NOT_CORRECT",
"message": "Partner name or password is not correct"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
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 |
Attempt to exceed the transfer limit | Попытка превышения лимита переводов (месячный лимит на одну карту 250 000 руб) |
BRS_ERROR |
Transaction to this card is prohibited. | Перевод на данную карту запрещен. |
BRS_ERROR |
Not specified or incorrect paymentid | Не указан или некорректный paymentid |
BRS_ERROR |
Transaction amount not specified or incorrect | Не указана или некорректна сумма операции |
BRS_ERROR |
Invalid card number | Неверный номер карты |
BRS_ERROR |
Bank denied | Отказано банком |
FIELD_IDPERSON_IS_NOT_CORRECT |
The field idPerson must be filled in | Поле idPerson должно быть заполнено. Актуально, когда данный сервис используется совместно с сервисом верификации ПД. |