Метод: create
Метод служит для создания виртуальной карты.
URL
POST https://api-pvk.prostodar.ru/partner/create/
Описание
Метод позволяет инициировать процесс создания виртуальной карты. Для выполнения запроса необходимо указать уникальный идентификатор запроса, данные карты и авторизационные данные партнера.
Структура запроса
Пример запроса
Формат запроса:
POST https://api-pvk.prostodar.ru/partner/create/ ?requestId=some_unique_request_id &partnerName=name &partnerPassword=some_unique_password &phoneNumber=1234567890 &sum=1023.00 &offerAccepted=true &productType=VIRTUAL_MASTER_CARD_MY_GIFT_3 &idPerson=idPerson &useAuthByCert=Y
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование | Цвет |
|---|---|---|---|---|---|
requestId |
string | Уникальный идентификатор запроса, состоящий из префикса и произвольного идентификатора | Да | Да | |
partnerName |
string | Уникальное имя партнера | Да | Нет | |
partnerPassword |
string | Уникальный API пароль партнера | Да | Да | |
phoneNumber |
string | Номер телефона в формате 10 цифр | Да | Да | |
sum |
float | Сумма для виртуальной карты | Да | Да | |
offerAccepted |
string | Признак принятия условий соглашения | Да | Да | |
productType |
string | Тип выпускаемой карты (список типов) | Да | Да | |
idPerson |
string | Уникальный идентификатор лица | *Да | Да | |
useAuthByCert |
string | Указывает на использование шифрования данных | Да | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"message": "request successfully completed",
"walletId": "ZmM2NmYxZjAtNDg2NS00MDlmLTgzZDMtYWY5ZGZjMWNiYjEy"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус операции |
message |
string | Текстовое описание результата |
walletId |
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_ID_ALREADY_EXISTS |
Request id already exists | Запрос с таким идентификатором уже существует |
NO_MONEY |
There are no funds on the balance sheet | Недостаточно средств для операции |
REQUEST_INCORRECTLY |
Invalid authorization is used | Ошибка в шифровании сертификатом |
SERVICE_UNAVAILABLE |
Service is temporarily unavailable. | Сервис временно недоступен |
CARD_CREATE_ERROR |
Error creating card | Ошибка при создании карты |
TRANSACTIONS_AMOUNT_EXCEEDED |
This client has exceeded the number of transactions for the given period | Для этого клиента превышено количество транзакций за заданный период (предыдущие 31 день) |
AMOUNT_WILL_BE_EXCEEDED |
Exceeded the total amount for the client for the specified period | Превышена общая сумма для клиента за заданный период (предыдущие 31 день) |
FIELD_IDPERSON_IS_NOT_CORRECT |
The field idPerson must be filled in | Поле idPerson должно быть заполнено. Актуально, когда данный сервис используется совместно с сервисом верификации ПД. |
BANK_ERROR |
Wallet creation failed | Ошибка при создании кошелька |
BANK_ERROR |
Order creation failed | Ошибка при создании ордера |
BANK_ERROR |
Generic error | Внутренняя ошибка банка |
BANK_ERROR |
Bad request | Ошибка при валидации параметров запроса |