Метод: create
Метод служит для пополнения мобильного телефона путем выпуска целевой виртуальной карты (далее – выпуск карты).
URL
POST https://api-pvk.prostodar.ru/partner/vc/mobile/create/
Описание
Метод позволяет инициировать пополнение мобильного телефона. При успешном запросе на указанный номер телефона отправляется OTP-код, необходимый для подтверждения операции.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API. Запрос commit с подтверждением должен быть отправлен не позднее чем через 50 минут после выполнения запроса к методу create, иначе операция будет отменена.
Структура запроса
Пример запроса
Формат запроса: POST https://api-pvk.prostodar.ru/partner/vc/mobile/create/ ?requestId=some_unique_request_id &partnerName=name &partnerPassword=some_unique_password &phoneNumber=1234567890 &sum=1023.00 &offerAccepted=true &idPerson=idPerson &useAuthByCert=Y
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
partnerName |
string | Уникальное имя партнера | Да | Нет |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да |
requestId |
string | Уникальный ID запроса | Да | Да |
idPerson |
string | Идентификатор пользователя в системе партнера | Опционально | Да |
phoneNumber |
string | Номер телефона в формате 10 цифр | Да | Да |
sum |
float | Сумма в рублях с десятичными копейками | Да | Да |
offerAccepted |
string | Подтверждение согласия с условиями (true / false) | Да | Да |
useAuthByCert |
string | Параметр, указывающий на шифрование данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"message": "Request successfully completed",
"walletId": "ZmM2NmYxZjAtNDg2NS00MDlmLTgzZDMtYWY5ZGZjMWNiYjEy"
}
Примечание: Код состояния 200
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
message |
string | Текстовое описание результата |
walletId |
string | Идентификатор, полученный из успешного запроса create |
Пример ответа с ошибкой
{
"status": "NO_MONEY",
"message": "No money"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
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 | Ошибка в шифровании сертификатом |
| REQUEST_ID_ALREADY_EXISTS | Request ID already exists | Запрос с таким идентификатором уже существует |
| NO_MONEY | No money | Недостаточно средств для операции |
| SERVICE_UNAVAILABLE | Service unavailable | Сервис временно недоступен |
| CARD_CREATE_ERROR | Card create error | Ошибка при создании карты |
| AMOUNT_EXCEEDS_LIMIT | Amount exceeds limit | Сумма операции превышает допустимый лимит |
| INVALID_PHONE_NUMBER | Invalid phone number | Неверный формат номера телефона |
| VALIDATION_ERROR | Missing 'Название параметра' parameter | Не заполнено обязательное поле |
| DAILY_LIMIT_EXCEEDED | Daily limit exceeded | Превышен дневной лимит |
| TRANSACTIONS_AMOUNT_EXCEEDED | This client has exceeded the number of transactions for the given period | Для этого пользователя превышено количество транзакций за заданный период |
| AMOUNT_WILL_BE_EXCEEDED | Exceeded the total amount for the client for the specified period | Превышена общая сумма для пользователя за заданный период |
| AMOUNT_IS_NOT_IN_RANGE | The amount is not in the range | Указанная сумма меньше минимально допустимого значения |
| BANK_ERROR | Wallet creation failed | Ошибка создания платежа |
| BANK_ERROR | Order creation failed | Ошибка создания платежа |
| BANK_ERROR | Generic error | Внутренняя ошибка банка |
| BANK_ERROR | Bad request | Ошибка при валидации параметров запроса |
| BANK_ERROR | - | Ошибка банка |
| INVALID_PHONE_NUMBER | Top-up for this operator is unavailable or the number does not exist | Пополнение номера телефона для этого оператора недоступно или номер не существует |
| INVALID_AMOUNT | Invalid sum parameter | Значение суммы указано некорректно |
| BAD_REQUEST | Agreement not accepted | Соглашение не было принято |