Explore the New API Documentation!

Whats difference ?

Go to the New Documentation
Skip to main content

CIMB VA Guide

DOKU has our own Virtual Account named CIMB VA to provide you with Virtual Account payment that can be paid from various issuers meaning that you can use this VA to process interbank transfer. Learn more about how DOKU can help you integrate with CIMB Virtual Account here.

Integration methods

There are two methods to integrate with CIMB VA:

  1. Register: The VA number will be registered to DOKU and Acquirer will inquiry to our side when the customer make payment at the acquirer channel (ATM, mobile banking, internet banking, etc.)
    1. DOKU Generated VA: The VA number is generated by DOKU. Suitable for e-commerce business model.
    2. Merchant Generated VA: The VA number is generated by Merchant. Suitable for top up business model.
  2. Direct Inquiry: The VA number is registered on merchant side and DOKU will forward Acquirer inquiry request to merchant side when the customer make payment at the acquirer channel (ATM, mobile banking, internet banking, etc.)

Integration steps

Here is the overview of how to integrate with Virtual Account:

  1. Generate payment code (virtual account number)
  2. Display payment code (virtual account number)
  3. Acknowledge payment result
Direct API - DOKU Generated Payment Code Virtual Account Sequence Diagram
Direct API - VA Aggregator Merchant Flow

1. Generate payment code (virtual account number)

To generate payment code, you will need to hit this API through your Backend:

API Request

TypeValue
HTTP MethodPOST
API endpoint (Sandbox)https://api-sandbox.doku.com/cimb-virtual-account/v2/payment-code
API endpoint (Production)https://api.doku.com/cimb-virtual-account/v2/payment-code

Here is the sample of request header to generate payment code:

Client-Id: MCH-0001-10791114622547
Request-Id: d24a5644-6078-4249-8740-4a6dcd92df5a
Request-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=
Request Header Explanation
ParameterDescription
Client-IdClient ID retrieved from DOKU Back Office
Request-IdUnique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-TimestampTimestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z
SignatureSecurity parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature

Here is the sample of request body to generate payment code:

{
    "order": {
        "invoice_number": "INV-20210124-0001",
        "amount": 15000
    },
    "virtual_account_info": {
        "billing_type": "FIX_BILL",
        "expired_time": 60,
        "reusable_status": false,
        "info1": "Online Shoping Store",
        "info2": "Contact support@oss.id",
        "info3": "Thank you"
    },
    "customer": {
        "name": "Anton Budiman",
        "email": "antonbudiman@doku.com"
    }
}
Request Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatoryGenerated by merchant to identify the order and must unique per request
Allowed chars: alphabetic, numeric, special chars
Max length: 64
order.amountnumberMandatoryIn IDR currency and without decimal. CIMB VA supports Close Amount Virtual Account and Open Amount Virtual Account
Allowed chars: numeric
Max length: 12
virtual_account_info.billing_typestringOptionalGenerated by Merchant to implement the open amount, close amount and limit amount features. For open amount, set this to NO_BILL. For close amount, set this to FIX_BILL
Possible Value : FIX_BILL, NO_BILL
Default value: FIX_BILL
virtual_account_info.expired_timenumberOptionalVirtual account expiration time in minutes format
Allowed chars: numeric
Maximum length: 8
Default value: 60
virtual_account_info.reusable_statusstringMandatoryFor VA that can be paid more than once, set this to true
Allowed chars: alphabetic
Possible value: true false
virtual_account_info.info1stringOptionalAdditional info that will be display on the acquirer channel (eg. ATM, Internet Banking) when customer do inquiry
Allowed chars: alphabetic, numeric, special chars
Max length: 100
virtual_account_info.info2stringOptionalAdditional info that will be display on the acquirer channel (eg. ATM, Internet Banking) when customer do inquiry
Allowed chars: alphabetic, numeric, special chars
Max length: 100
virtual_account_info.info3stringOptionalAdditional info that will be display on the acquirer channel (eg. ATM, Internet Banking) when customer do inquiry
Allowed chars: alphabetic, numeric, special chars
Max length: 100
customer.namestringMandatoryCustomer name that will be displayed on acquirer channel when do inquiry
Allowed chars: alphabetic, numeric, special chars
Max length: 64
customer.emailstringOptionalCustomer email
Allowed chars: alphabetic, numeric, special chars
Max length: 64

API Response

After hitting the above API request, DOKU will give the response.

TypeValue
HTTP Status200
ResultSUCCESS
Client-Id: MCH-0001-10791114622547
Request-Id: d24a5644-6078-4249-8740-4a6dcd92df5a
Response-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=
Response Header Explanation
ParameterDescription
Client-IdSame as the request
Request-IdSame as the request
Response-TimestampTimestamp Response on UTC with format ISO8601 UTC+0 from DOKU
SignatureSignature generated by DOKU based on the response body

Here is the sample of response body:

{
    "order": {
        "invoice_number": "INV-20210124-0001"
    },
    "virtual_account_info": {
        "virtual_account_number": "8129400000000009",
        "how_to_pay_page": "https://sandbox.doku.com/how-to-pay/v2/cimb-virtual-account/8129400000000009/vTUTxmvBkLrMzEXiVOTSQbClalOWr2ZMxHDy8VXFlj4?",
        "how_to_pay_api": "https://api-sandbox.doku.com/cimb-virtual-account/v2/how-to-pay-api/8129400000000009/vTUTxmvBkLrMzEXiVOTSQbClalOWr2ZMxHDy8VXFlj4?",
        "created_date": "2021-10-13T13:41:00Z",
        "expired_date": "2021-10-13T14:41:00Z"
    }
}
Response Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
virtual_account_info.
virtual_account_number		stringMandatoryGenerated by DOKU that will be used by customer for doing a payment through acquirer channel (eg. ATM, Internet Banking)
Allowed chars: numeric
Max length: 17
virtual_account_info.how_to_pay_pagestringOptionalPage URL that merchant can use to display how customer can complete the payment process through acquirer channel (eg. ATM, Internet Banking)
Max length: 256
virtual_account_info.how_to_pay_apistringOptionalURL that merchant can parse to display customized how customer can complete the payment process through accquirer channel (eg. ATM, Internet Banking)
Max length: 256
virtual_account_info.created_datestringOptionalDate time of VA generated with the format of yyyyMMddHHmmss. The created date uses UTC+7 time
Max length: 24
virtual_account_info.expired_datestringConditionalDate time of VA will be expired with the format of yyyyMMddHHmmss. The expired date uses UTC+7 time. Use this to set the expiry order on merchant side
Max length: 24
Pro Tips

You can also show payment instruction link to your customer by using virtual_account_info.how_to_pay_page. If you wish to customize the UI for the payment instruction, you can use the virtual_account_info.how_to_pay_api.

2. Display payment code (virtual account number)

You can display the payment code to your customer by using virtual_account_info.virtual_account_number that you retrieved from the API response.

3. Acknowledge payment result

After the payment is being made by your customer, DOKU will send HTTP Notification to your defined Notification URL. Learn how to handle the notification from DOKU:

Additional features

We provide various additional features to suited your needs. Learn more here.

Open amount virtual account

DOKU supports open amount payment meaning that your customer can input their own payment amount. To use open amount, you don't need send order.amount to DOKU. Here is the sample:

{
    ...
    "order": {
        "invoice_number": "INV-20210124-0001",
        ...
    },
    "virtual_account_info": {
        "billing_type": "NO_BILL",
        ...
    },
    ...
}

Limit amount virtual account

DOKU supports limit amount payment meaning that your customer can input their own payment amount at the range that you defined. To use limit amount, you do not need to send 'order.amount' then send order.min_amount or order.max_amount to DOKU. Here is the sample:

{
    ...
    "order": {
        "invoice_number": "INV-20210124-0001",
        "min_amount": 10000,
        "max_amount": 50000,
        ...
    },
    "virtual_account_info": {
        "billing_type": "NO_BILL",
        ...
    },
    ...
}

Update and Cancel Virtual Account

If you wish to update your virtual account such as, update the amount, update the expiry time, customer details, and etc. You can do that by hitting the API with PATCH method:

API Request

TypeValue
HTTP MethodPATCH
API endpoint (Sandbox)https://api-sandbox.doku.com/cimb-virtual-account/v2/payment-code
API endpoint (Production)https://api.doku.com/cimb-virtual-account/v2/payment-code

Here is the sample of request header to update payment code:

Client-Id: MCH-0001-10791114622547
Request-Id: 2dc5985e-adaa-4f82-b126-b09e9006da14
Request-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=
Request Header Explanation
ParameterDescription
Client-IdClient ID retrieved from DOKU Back Office
Request-IdUnique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-TimestampTimestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z
SignatureSecurity parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature

Here is the sample of request body to update payment code:

Cancel Virtual Account

To cancel a virtual account, simply set virtual_account_info.status to DELETE

{
    "order": {
        "invoice_number": "INV-20210124-0001",
        "amount": 150000
    },
    "virtual_account_info": {
        "virtual_account_number": "8129400000000009",
        "status": "ACTIVE",
        "expired_time": 60,
        "reusable_status": false,
        "info1": "Online Shoping Store",
        "info2": "Contact support@oss.id",
        "info3": "Thank you"
    },
    "customer": {
        "name": "Anton Budiman",
        "email": "anton@example.com"
    }
}
Request Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringSame as the generate VA request
order.amountnumberConditionalSet this with updated value if wished. Set this parameter to more than (>) 0 for Close Amount Virtual Account
Allowed chars: numeric
Max length: 12
order.min_amountnumberConditionalSet this with updated value if wished
Allowed chars: numeric
Max length: 12
order.max_amountnumberConditionalSet this with updated value if wished
Allowed chars: numeric
Max length: 12
virtual_account_info.virtual_account_numberstringMandatoryThe virtual account number that wish to be updated
virtual_account_info.statusstringMandatorySet ACTIVE to update the virtual account and set DELETE to cancel the virtual account
Possible value: ACTIVE, DELETE
virtual_account_info.expired_timenumberOptionalSet this with updated value if wished
Allowed chars: numeric
Maximum length: 5
Default value: 60
virtual_account_info.reusable_statusnumberMandatorySet this with updated value if wished
Possible value: true false
virtual_account_info.info1stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 100
virtual_account_info.info2stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 100
virtual_account_info.info3stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 100
customer.namestringMandatorySet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 64
customer.emailstringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 128

API Response

After hitting the above API request, DOKU will give the response.

TypeValue
HTTP Status200
ResultSUCCESS
Client-Id: MCH-0001-10791114622547
Request-Id: 09e0defe-a071-45b3-9feb-ac134374628c
Response-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=
Response Header Explanation
ParameterDescription
Client-IdSame as the request
Request-IdSame as the request
Response-TimestampTimestamp Response on UTC with format ISO8601 UTC+0 from DOKU
SignatureSignature generated by DOKU based on the response body

Here is the sample of response body:

{
    "order": {
        "invoice_number": "INV-20210124-0001"
    },
    "virtual_account_info": {
        "virtual_account_number": "8129400000000009",
        "created_date": "20210331115005",
        "expired_date": "20210331125005",
        "created_date_utc": "2021-03-31T04:50:05Z",
        "expired_date_utc": "2021-03-31T05:50:05Z"
    }
}
Response Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
virtual_account_info.
virtual_account_number		stringMandatoryGenerated by DOKU that will be used by customer for doing a payment through acquirer channel (eg. ATM, Internet Banking)
virtual_account_info.created_datestringConditionalDate time of VA generated with the format of yyyyMMddHHmmss. The created date uses UTC+7 time
virtual_account_info.expired_datestringConditionalDate time of VA will be expired with the format of yyyyMMddHHmmss. The expired date uses UTC+7 time. Use this to set the expiry order on merchant side
virtual_account_info.created_date_utcstringConditionalDate time of VA generated in UTC format
virtual_account_info.expired_date_utcstringConditionalDate time of VA will be expired in UTC. Use this to set the expiry order on merchant side

Split Settlement

If you are a platform or a marketplace, you can use this feature to settle the funds to your sellers or partners programmatically, save many operational efforts.

What's next?

You can test your payment through our Payment Simulator. Learn more here.