CIMB Direct Debit
CIMB direct debit offers tokenization scheme that requires customer to input OTP and/or PIN to verify every payment.
Last updated
CIMB direct debit offers tokenization scheme that requires customer to input OTP and/or PIN to verify every payment.
Last updated
DOKU API
Legacy DocumentationOverview of integration process with CIMB Direct Debit.
Account Binding process should be done before payment can be made and processed. Merchant will send account binding request from customer to DOKU. The request includes customer's phone number that is registered to customer's CIMB account.
Each CIMB account can only be bind to one customer on one merchant. Customer needs to do verification for account binding process by inputting OTP and PIN.
Account Binding Flow
HTTP Method
POST
API Sandbox
API Production
Path
.../direct-debit/core/v1/registration-account-binding
Sample of Request Header, Request Body and Response Body
Notes:
Parameter with (*) is mandatory
Paramater without (*) is optional/conditional
After customer's account is bind/linked and customer has enough balance for payment, merchant can send payment request from customer to DOKU by bringing customer's token.
Payment Flow
HTTP Method
POST
API Sandbox
API Production
Path
.../direct-debit/core/v1/debit/payment-host-to-host
Sample of Request Header, Request Body and Response Body
Notes:
Parameter with (*) is mandatory
Paramater without (*) is optional/conditional
Once customer has submitted their payment request along with the OTP, merchant needs to verify the payment. Merchant can hit this API to verify the OTP.
OTP Verification Flow
HTTP Method
POST
API Sandbox
API Production
Path
.../direct-debit/core/v1/otp-verification
Sample of Request Header, Request Body and Response Body
Notes:
Parameter with (*) is mandatory
Paramater without (*) is optional/conditional
After payment is completed, DOKU will send HTTP Notification to merchant's defined Notification URL
. Learn how to handle the notification from DOKU.
This endpoint is used to create refund request for previous successful payment. Merchant can request a transaction refund to DOKU. Full refund and partial refund are available to be requested.
Online Refund Flow
HTTP Method
POST
API Sandbox
API Production
Path
.../direct-debit/core/v1/debit/refund
Sample of Request Header, Request Body and Response Body
Notes:
Parameter with (*) is mandatory
Paramater without (*) is optional/conditional
If a registered customer no longer wants their account/card to be bind/linked and wish to remove themself from DOKU's and merchant’s system, merchant can send account unbinding request that is initiated by customer.
HTTP Method
POST
API Sandbox
API Production
Path
.../direct-debit/v1/registration-account-unbinding
Sample of Request Header, Request Body and Response Body
Notes:
Parameter with (*) is mandatory
Paramater without (*) is optional/conditional
Reference No From Partner | max: 12 | Mandatory
"INV-0001"
Successful
Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit | Mandatory | min length: 1 | max length: 7.
"2005400"
Response Description. | min length: 1 | max length: 150
"Successful"
Redirect URL to Merchant's page/platform for customer to input OTP/PIN
"https://app-uat.doku.com/link/283702597342040"
Reference No From Partner
"INV-0001"
format: Value from getTokenB2B2C | max: 2048 | Mandatory
"eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTg4MjI3NTQsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjAyLTE2OTAyNzUzNTM3OTgiLCJhY2NvdW50SWQiOiJjZTBhZWIyM2YyMmZhOTgxZWViNTE1MjFmZmNkYmUzNyJ9.QZ2z0p2PoCYbuBSId7LleLqTUwNyNIeM1PUSaV4DwGKO05l7xQ3EbpdAPK62hxKNcczKqQqGY2Om6rzS78s2Tj88dkDD2vl46o3xEPd_plqQW8ayFqS74Z_HcFJfdo-egqFv9rAX7qgiE5AJHSx_hFolET9B3o3Jx82lmQutnXOjYb5gW9PV0FCPIZRWOaXppOSJSVcmTvXZxF0KUID9-2QVmQ5aPZroHjShYJKGyUu-1tCPClD_CbZMCi3TxhKLnI3e2oIoK7VjXEsrJjuil8O1zZTT7_aXAGgTu5UcPCrc0U9_3Nj-wQlEjDpedMVypKAWATWBUVpMo2MAsBRDAw"
Successful
Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit | Mandatory | min length: 1 | max length: 7.
"2000500"
Response Description. | min length: 1 | max length: 150
"Successful"
Reference Number
"UNB-0001"
Phone Number Customer | Format: 628238748728423 | min length: 9 max length: 16 | Mandatory
"628238748728423"
Successful
Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit | Mandatory | min length: 1 | max length: 7.
"2000700"
Response Description. | min length: 1 | max length: 150
"Successful"
Reference Number
"129260743966"
Redirect URL to Merchant's page/platform for customer to input OTP/PIN
"https://doku.com/direct-debit/ui/binding/2238230713001534401107183161486001168389"
Partner Reference No Payment | max: 36 | Mandatory
"INV-0001"
OTP sent to customer | min: 6 max: 6 | Mandatory
"111000"
Value should always be otpPayment | Mandatory
"otpPayment"
Successful
Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit . | Mandatory | min length: 1 | max length: 7.
2000400
Response Description. | min length: 1 | max length: 150
"Successful"
Reference no from acquirer
"GuJNX01wKYMdEGNUJ1k"
Partner Reference No Purchase Transaction | max: 12 | Mandatory
"INV-0001"
External ID Purchase Transaction | max: 36 |
"REQ-0001"
Reason from customer | max: 255
"Request by Customer"
Partner Refund No| max: 12 | Mandatory
"INV-REF-0001"
Successful
Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit | Mandatory | min length: 1 | max length: 7.
"2000700"
Response Description. | min length: 1 | max length: 150
"Successful"
Partner Reference No Purchase Transaction
"Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"
Reference No Purchase Transaction From DOKU To CIMB
"Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"
Refund No from DOKU To CIMB
"Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"
Partner Refund No
"Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"
format: yyyy-MM-dd'T'HH:mm:ssXXX
"2024-01-01T09:09:00.123"