Метод create

URL: POST - /partner/hold/create

Метод позволяет отправить запрос на холдирование (резервирование) определенной суммы на банковской карте клиента. Время холдирования средств указывается в минутах.
При успешной обработке запроса система возвращает уникальный идентификатор холдирования.
Холдирование средств отменяется сразу после истечения времени холдирования, если партнер не снял средства или не отменил холдирование.

Параметры Заголовков

Свойство	Тип	Описание
client-id *	авторизация	Уникальный идентификатор партнера
client-secret *	авторизация	Уникальный ключ аутентификации к API VIA

Параметры запроса

Имя	Тип	Описание
merchantId *	string	Идентификатор мерчанта VIA
cardToken *	string	Токен банковской карты
externalId *	string	Идентификатор запроса партнера
amount *	integer	Сумма пополнения в тийинах, центах и т.д. (1/100 часть базовой единицы валюты)
currency *	string	Валюта: «UZS» - узбекский сум
note	string	Текст примечания, заметки и т.д.
accounts *	string	Объект данных относительно услуг мерчанта. Параметры и их значения объекта accounts определяется в зависимости от услуги мерчанта, на которую осуществляется платеж. Например: Для оплаты услуги мобильного оператора отправляется номер телефона.
holdTime	integer	Время холдирования средств в минутах.

Пример запроса

curl POST '/partner/hold/create' \
  --header 'client-id: system' \
  --header 'client-secret: system123' \
  --data '{
      "merchantId": "mrt_qwegFC1lHGaAzJIRphv4LdU10zX",
      "externalId": "test_1"
      "cardToken": "VLH8VNWKE3SBBBZEKA86T5PF72ZNTEST",
      "amount": 10000,
      "currency": "UZS",
      "note": "",
      "accounts": {
          "account": "123123",
          "myKey": "myValue"
      },
      "holdTime": 3600
  }'

Параметры ответа

Имя	Тип	Описание
holdId	string	Идентификатор холдирования
status	string	Статус выполнения запроса на холдирование Доступны следующие значения: «NEW» - Запрос на холдирование принят «CREATE_SUCCESS» - Холдирование успешно «CREATE_PENDING» - Холдирование в ожидании «CREATE_ERROR» - Ошибка при холдировании «CONFIRM_SUCCESS» - Снятие средств выполнено успешно «CONFIRM_PENDING» - Процесс снятия средств в ожидании «CONFIRM_ERROR» - Ошибка при снятии средств «CANCEL_SUCCESS» - Отмена средств выполнено успешно «CANCEL_PENDING» - Процесс отмены средств в ожидании «CANCEL_ERROR» - Ошибка при отмене средств «EXPIRED» - срок холдирования истек

Пример ответа в случае успеха

{
  "data": {
    "holdId": "phl_2RW4uL2eTpbCqyUjw9mZEOUgVYY",
    "status": "NEW"
  }
}

Пример ответа в случае ошибки

{
    "status": {
        "code": "1234",
        "message": "Ошибка при выполнении запроса"
    },
    "error": {
        "path": "URL Path",
        "message": {
            "uz": "Error message in Uzbek",
            "ru": "Error message in Russian",
            "en": "Error message in English"
        }
    }
}