CIMBClicks (OctoClicks)

CIMBClicks (or also known as OctoClicks) is one of the Internet banking payment methods provided by CIMB Niaga Bank. This method allows the customer to perform a transaction by redirecting the customer to the CIMB Clicks payment page.

The Steps to integrate with CIMB Clicks are given below.

Send the charge API request to Midtrans.
Redirect the customer to URL specified in the response.
Redirect your customer back to your page by configuring Finish URL in Midtrans's Dashboard > Configurations.
Handle notifications.

Send a Charge API request with the details of the transaction such as payment_type, cimb_clicks, transaction_details, item_details, and customer_details. Successful request returns a redirect URL.

By default, expiry time for OctoClicks is 2 hours unless specified by merchant (min 20s, max 180 days).

CIMB Clicks Charge API Request

{
  "payment_type": "cimb_clicks",
  "cimb_clicks": {
    "description": "Purchase of a special event item"
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "transaction_details": {
    "order_id": "H17550",
    "gross_amount": 11000
  },
  "customer_details" : {
    "first_name": "Andri",
    "last_name": "Litani",
    "email": "[email protected]",
    "phone": "081122334455"
  }
}

JSON Attribute	Description	Type	Required
payment_type	Set CIMB Clicks payment method. Value: `cimb_clicks`.	String	Required
transaction_details	The details of the specific transaction such as `order_id` and `gross_amount`.	Object	Required
cimb_clicks	Charge details using CIMB Clicks.	Object	Required
item_details	Details of the item(s) purchased by the customer.	Object	Required
customer_details	Details of the customer.	Object	Required

CIMB Clicks Charge Sample Responses and Notifications

{
  "status_code": "201",
  "status_message": "Success, CIMB Clicks transaction is successful",
  "redirect_url": "https://api.midtrans.com/cimb-clicks/request?id=226f042f-020e-4829-8bd7-2de64b8673ce",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending"
}

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "signature_key": "666617ddc981eb096b6f08ab8ee132b93c12d3b5b3817f00a02c5d4c71bd53fd7f39d55a92b2a1f729ee070fdb241b569dc90bfa61e41de16904075238d67d55",
}

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:45:21",
  "transaction_status": "settlement",
  "approval_code": "RB5031388093",
  "signature_key": "3bcdf0700d3c8a288f279e4fe27a4012e916cb44120d541f6e4c48c83a107b605fdb063ae7c8744d15891047aeb1fc8d2e95741c0abc5f67e10e0b60244bc441"
}

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:44:21",
  "transaction_status": "deny",
  "signature_key": "b736864661f8cbf04b287ee5a9514589dbe2dc53e3949338d648144b6bad1bc77d1b495921f119e7a6bf5521b697ea5d629b5ea93f2bcda4ff13df744cfbf701"
}

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 18:41:25",
  "transaction_status": "expire",
  "signature_key": "3f1ddaf45b269df7a1638d6d4080957e1323df2cbc2da83549f86a23b17c2acae0215994bb60805455daf157125990414259e5319e84c9288fd6222e655c6756"
}

JSON Attribute	Description	Type
status_code	Status code of transaction charge result.	String
status_message	Status message describing the result of the API request.	String
redirect_url	Redirect URL to CIMB Clicks payment page.	String
transaction_id	Transaction ID given by Midtrans.	String
order_id	Order ID specified by you.	String
gross_amount	Total amount of transaction in IDR.	String
payment_type	The payment method used by the customer.	String
transaction_time	Timestamp of transaction in ISO 8601 format. Time Zone: GMT+7.	String
transaction_status	Status of CIMB Clicks transaction. Value: `pending`.	String
signature_key	Combination of parameters such as `order_id`, `status_code`, `gross_amount`, and `server_key` to verify integrity of payload/response.	String
approval_code	Successful CIMB Clicks transaction approval code.	String