Холдирирование

Для осуществления безопасных сделок система PAYMO позволяет организовать холдирование средств на карте.

Процесс осуществления холдирования:
  1. Система Поставщика услуг передает реквизиты карты пользователя и сумму холдирования путем вызова метода POST hold/.
  2. Владельцу карты отправляется SMS с кодом подтверждения.
  3. Система Поставщика услуг подтверждает холдирование путем вызова метода PUT hold/{hold_id}.
  4. Для проведения списания по созданному холдированию необходимо вызвать метод POST hold/{hold_id}.

Механизм авторизации для вызова методов API указан в разделе Авторизация в API.

В запросах ко всем методам имеется поле lang, в котором необходимо передать язык ответного сообщения. Во всех ответах передается объект result с полями code – код и description – описание результата запроса. Далее в документации поля lang и result будут опущены для упрощения описания методов.

Метод POST hold/

Метод создает заявку на холдирование

Адрес: https://api.paymo.uz/hold/

Входящее сообщение:

Поле Описание
card_number Номер карты
card_expiry Дата истечения карты
store_id ID магазина, предоставленный системой PAYMO
account Идентификатор инвойса (логин, номер инвойса и т.п.)
payment_details Дополнительная информация о платеже
amount Сумма платежа
duration Длительность холдирования в минутах

Ответное сообщение:

# Поле Описание
1 hold_id Идентификатор холдирования

Метод PUT hold/{hold_id}

Метод создает планировщик для автоплатежа. Перед вызовом данного метода необходимо зарегистрировать карту путем вызова метода partner/add-card

Адрес: https://api.paymo.uz/hold/{hold_id}

Входящее сообщение:

# Поле Описание
1 otp Код подтверждения, высланный в SMS

Ответное сообщение:

# Поле Описание
1 hold_id Идентификатор холдирования
2 card_token Токен карты в системе PAYMO
3 card_pan Маска карты
4 hold_till Время окончания холдирования (YYYY-mm-ddTHH:mm:ii)

Метод POST hold/{hold_id}

Метод производить списание захолдированной суммы.

Адрес: https://api.pays.uz/hold/{hold_id}

Тело запрос отправить пустое.

Ответное сообщение:

# Поле Описание
1 store_transaction объект с информацией о транзакции
2 –success_trans_id ID транзакции
3 –store объект с информации о поставщике (магазине)
4 – –id ID поставщика (магазина)
5 – –name Название поставщика (магазина)
6 – –logo Логотип поставщика (магазина)
7 – –desc Описание поставщика (магазина)
8 –card_id Токен карты плательщика
9 –account Идентификатор инвойса
10 –commission_type Форма комиссии с плательщика (1 – процент, 2 – фиксированная)
11 –commission_value Размер комиссии
12 –amount Сумма инвойса
13 –total Сумма к оплате
14 –success_trans_id ID завершенной платежной транзакции в системе PAYMO
15 –terminal_id ID терминала
16 –prepay_time Время создания драфта транзакции
17 –confirm_time Время завершения транзакции
18 –status_code Код состояния транзакции
19 –status_message Сообщение состояния транзакции

Метод DELETE hold/{hold_id}

Отмена холдирования.

Адрес: https://api.pays.uz/hold/{hold_id}

Тело запрос отправить пустое.

Ответное сообщение:

# Поле Описание
1 code «OK» - успешно
2 description Описание ответа