CLICK Pass

API Endpoint

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

Private Data

Upon registration, service provider receives following data to connect and make requests to an API:

  • merchant_id
  • service_id
  • merchant_user_id
  • secret_key

secret_key parameter is private and service provider is fully responsible for its safety.
Exposing secret_key may end up in compromising your data.

Authentication

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

Required headers

Accept
Auth
Content-Type

Supported content types

application/json
application/xml

Payment status codes

# Error code Description
1 <0 Error (details in error_note)
2 0 Payment created
3 1 Processing
4 2 Payment successful

 

Payment with CLICK Pass

Request

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”: :service_id,
“otp_data”: “1234567415821”,
“amount”: 500,
“cashbox_code”: “KASSA-1”,
“transaction_id”: “12345”

}

Request parameters

# Parameter Data type Description
1 service_id integer Service ID
2 otp_data string QR code contents
2 amount float Payment amount
2 cashbox_code String (optional) Cashbox identifier
2 transaction_id String (optional) Merchant transaction ID

Response

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

“error_code”: error_code,
“error_note”: “Error description”,
“payment_id”: 1234567,
“payment_status”: 1,
“confirm_mode”: 1

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description
3 payment_id bigint Payment Identifier
4 payment_status int Payment status code
4 confirm_mode bit Confirmation mode status

 

Payment status check

Request

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

Request parameters

# Parameter Data type Description
1 service_id integer Service ID
2 payment_id bigint Payment ID

Response

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

“error_code”: error_code,
“error_note”: “Error description”,
“payment_id”: 1234567,
“payment_status”: 1

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description
3 payment_id bigint Payment Identifier
4 payment_status int Payment status code

 

Payment reversal (cancel)

Request

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

Request parameters

# Parameter Data type Description
1 service_id integer Service ID
2 payment_id bigint Payment ID

Response

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

“error_code”: error_code,
“error_note”: “Error description”,
“payment_id”: 1234567

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description
3 payment_id bigint Payment Identifier

Reversal conditions

  • Payment should be successfully completed
  • Only payments created in current reporting month can be reverted
  • Payments from previous month can be canceled only on first day of current month.  Payment should be made with Online card.
  • Payment reversal can be denied due to refusal by UZCARD

 

Confirmation mode

  • Confirmation mode is enabled for the service (service_id) and all payments via CLICK Pass for this service will work in confirmation mode.
  • Payments working in confirmation mode must be confirmed immediately after receiving a successful response to the payment.
  • Unconfirmed payments will be canceled after 30 seconds after making the payment.

 

Payment confirmation

Request

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

}

Response

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

“error_code”: 0,
“error_note”: “Payment confirmed”

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description

 

Enable confirmation mode

Request

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

Response

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

“error_code”: 0,
“error_note”: “Confirmation mode enabled”

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description

 

Disable confirmation mode

Request

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

Response

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

“error_code”: 0,
“error_note”: “Confirmation mode disabled”

}

Response parameters

# Parameter Data type Description
1 error_code integer Error code
2 error_note string Error description
© 2018 Click