Метод: commit
Метод служит для подтверждения пополнения мобильного телефона путем выпуска карты.
URL
POST https://api-pvk.prostodar.ru/partner/vc/mobile/commit/
Описание
Метод подтверждает выпуск карты для пополнения мобильного телефона посредством ввода OTP-кода. Пользователю предоставляется 3 попытки ввода OTP-кода.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API. После подтверждения выпуска карты пополнение мобильного телефона происходит автоматически (пользователю не приходят реквизиты карты).
Структура запроса
Пример запроса
Формат запроса: POST https://api-pvk.prostodar.ru/partner/vc/mobile/commit/ ?requestId=some_unique_request_id &partnerName=name &partnerPassword=some_unique_password &useAuthByCert=Y &otp=1212 &walletId=ZmM2NmYxZjAtNDg2NS00MDlmLTgzZDMtYWY5ZGZjMWNiYjEy
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
partnerName |
string | Уникальное имя партнера | Да | Нет |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да |
requestId |
string | Уникальный ID запроса | Да | Да |
otp |
string | OTP-код, отправленный пользователю. Примечание: Доступно 3 попытки, после чего операция отменяется. | Да | Да |
walletId |
string | Идентификатор, полученный из успешного запроса create | Да | Да |
useAuthByCert |
string | Параметр, указывающий на шифрование данных (Y/N) | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"message":"Request successfully completed"
}
Примечание: Код состояния 200
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
message |
string | Текстовое описание результата |
Пример ответа с ошибкой
{
"status": "PARTNER_LOGIN_IS_NOT_CORRECT",
"message": "Partner login is not correct"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус ошибки |
message |
string | Текстовое описание ошибки |
Возможные ошибки
| status | message | Описание |
|---|---|---|
| PARTNER_LOGIN_IS_NOT_CORRECT | Partner login is not correct | Партнер с таким логином и паролем не найден |
| NOT_VALID_IP_PARTNER | Not valid IP partner | IP партнера некорректен |
| ACCOUNT_IS_BLOCKED | Account is blocked | Аккаунт заблокирован |
| REQUEST_INCORRECTLY | Request incorrectly | Ошибка в шифровании сертификатом |
| SERVICE_UNAVAILABLE | Service unavailable | Сервис временно недоступен |
| NOT_FOUND_REQUEST_BY_WALLET_ID_AND_REQUEST_ID | Not found by wallet Id and request id | Запрос с таким walletId и requestId не найден |
| VALIDATION_ERROR | Missing 'Название параметра' parameter | Не заполнено обязательное поле |
| MAX_OTP_ATTEMPTS_EXCEEDED_AND_TRANSACTION_CANCELLED | Max OTP attempts exceeded and transaction cancelled | Превышено количество ввода OTP-кода |
| CARD_CREATE_ERROR | Card create error | Ошибка при создании карты |
| BANK_ERROR | Wallet creation failed | Ошибка создания платежа |
| BANK_ERROR | Order creation failed | Ошибка создания платежа |
| BANK_ERROR | Generic error | Внутренняя ошибка банка |
| BANK_ERROR | Bad request | Ошибка при валидации параметров запроса |
| OTP_MISMATCH | Invalid OTP-code | Неверный ОТP-код |
| ALREADY_ISSUED_FOR_THIS_REQUEST | Already issued for this request | По данному запросу уже был получен commit/rollback или был отклонён в связи с неполучением commit. |
| TRANSACTION_IS_EXPIRED | Transaction is expired. Commit request was received after allowed time window | Срок действия транзакции истёк, запрос на подтверждение поступил позже установленного времени |
| UNEXPECTED_PROCESSING_ERROR | Something went wrong. Please contact technical support | Произошла непредвиденная ошибка, необходимо обратиться в техническую поддержку |