CLICK Pass

API Точка (Endpoint)

https://api.click.uz/v2/merchant/

Конфиденциальные данные

При регистрации поставщик услуг получает следующие данные для подключения и отправки запросов к API:

  • merchant_id
  • service_id
  • merchant_user_id
  • secret_key

secret_key является конфиденциальным параметром и поставщик услуг несет полную ответственность за его безопасность.
Оставив secret_key незащищенным, вы может скомпрометировать ваши данные.

Аутентификация

HTTP Header “Auth: merchant_user_id:digest:timestamp”
digest — sha1(timestamp + secret_key)
timestamp — UNIX timestamp (10 digit seconds from epoch start)

Требуемые заголовки

Accept
Auth
Content-Type

Поддерживаемые виды контента

application/json
application/xml

Коды статуса платежа

# Error code Описание
1 <0 Ошибка (детали в error_note)
2 0 Платеж создан
3 1 Обработка
4 2 Успешная оплата

 

Оплата с помощью CLICK Pass

Запрос

POST https://api.click.uz/v2/merchant/click_pass/payment HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543
{

“service_id”: :id сервиса,
“otp_data”: “1234567415821”,
“amount”: 500,
“cashbox_code”: “KASSA-1”,
“transaction_id”: “12345”

}

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

# Наименование параметра Тип данных Описание
1 service_id integer ID сервиса
2 otp_data string Содержание QR-кода
2 amount float Сумма платежа
2 cashbox_code String (optional) Идентификатор кассы
2 transaction_id String (optional) ID транзакции поставщика

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: код ошибки,
“error_note”: “Описание ошибки”,
“payment_id”: 1234567,
“payment_status”: 1,
“confirm_mode”: 1

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки
3 payment_id bigint ID платежа
4 payment_status int Статус оплаты (платежа)
4 confirm_mode bit Статус режима подтверждения

 

Проверка статуса платежа

Запрос

GET https://api.click.uz/v2/merchant/payment/status/:service_id/:payment_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543

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

# Наименование параметра Тип данных Описание
1 service_id integer ID сервиса
2 payment_id bigint Payment ID

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: код ошибки,
“error_note”: “Описание ошибки”,
“payment_id”: 1234567,
“payment_status”: 1

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки
3 payment_id bigint ID платежа
4 payment_status int Код статуса платежа

 

Снятие платежа (отмена)

Запрос

DELETE https://api.click.uz/v2/merchant/payment/reversal/:service_id/:payment:id HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543

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

# Наименование параметра Тип данных Описание
1 service_id integer ID сервиса
2 payment_id bigint Payment ID

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: код ошибки,
“error_note”: “Описание ошибки”,
“payment_id”: 1234567

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки
3 payment_id bigint ID платежа

Условия снятия (отмены) платежа

  • Оплата должна быть успешно завершена
  • Только платежи, созданные в текущем отчетном месяце, могут быть возвращены
  • Выплаты из предыдущего месяца могут быть отменены только в первый день текущего месяца. Оплата должна производиться с помощью онлайн-карты.
  • Отмена платежа может быть отклонена из-за отказа UZCARD

 

Режим подтверждения

  • Режим подтверждения включается для сервиса (service_id) и все платежи по CLICK Pass по данному сервису будут работать в режиме подтверждения.
  • Платежи работающие в режиме подтверждения должны быть подтверждены сразу после получения успешного ответа на платеж.
  • Неподтвержденные платежи будут отменены после 30 секунд после создания платежа.

 

Подтверждение оплаты

Запрос

POST https://api.click.uz/v2/merchant/click_pass/confirm HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543
{

“service_id”: :service_id,
“payment_id”: 1234567

}

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: 0,
“error_note”: “Платеж подтвержден”

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки

 

Включение режима подтверждения

Запрос

PUT https://api.click.uz/v2/merchant/click_pass/confirmation/:service_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: 0,
“error_note”: “Режим подтверждения включен”

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки

 

Отключение режима подтверждения

Запрос

DELETE https://api.click.uz/v2/merchant/click_pass/confirmation/:service_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Auth: 123:356a192b7913b04c54574d18c28d46e6395428ab:1519051543

Ответ

HTTP/1.1 200 OK
Content-Type: application/json
{

“error_code”: 0,
“error_note”: “Режим подтверждения выключен”

}

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

# Наименование параметра Тип данных Описание
1 error_code integer Код ошибки
2 error_note string Описание ошибки
© 2021 Click