bca-virtual-account-mgpc

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 - Merchant Generated Virtual Account Sequence Diagram

---

1. Generate payment code (virtual account number)

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

API Request

Type	Value
HTTP Method	POST
API endpoint (Sandbox)	https://api-sandbox.doku.com/bca-virtual-account/v2/merchant-payment-code
API endpoint (Production)	https://api.doku.com/bca-virtual-account/v2/merchant-payment-code

Virtual Account Number has to contain a merchant's BIN

Please refer to BIN Rules Guidelines. See VA Number Component to know how many free digits merchant can use.

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

Client-Id: MCH-0001-10791114622547
Request-Id: 15022aab-444f-4b04-afa8-ddfce89432ec
Request-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=

Request Header Explanation

Parameter	Description
Client-Id	Client ID retrieved from DOKU Back Office
Request-Id	Unique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-Timestamp	Timestamp 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
Signature	Security 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": "invoice-0000061212314",
        "amount": 10000

    },
    "virtual_account_info": {
        "virtual_account_number": "1900801234567891",
        "billing_type": "FIX_BILL",
        "expired_time": 60,
        "reusable_status": false,
        "info1": "Online Shoping Store",
        "info2": "Online Shoping Store",
        "info3": "Online Shoping Store"
    },
    "customer": {
        "name": "Jessica Tessalonika",
        "email": "jessica@example.com"
    }
}

Request Body Explanation

Parameter	Type	Mandatory	Description
order.invoice_number	string	Mandatory	Generated by merchant to identify the order and must unique per request Allowed chars: alphabetic, numeric, special chars Max length: 64
order.amount	number	Conditional	In IDR currency and without decimal. Set this parameter to more than (>) 0 for Close Amount Virtual Account Allowed chars: numeric Max length: 12
order.min_amount	number	Conditional	Send this parameter for Limited Amount Virtual Account to set the minimum amount need to be paid by the customer Allowed chars: numeric Max length: 12
order.max_amount	number	Conditional	Send this parameter for Limited Amount Virtual Account to set the maximum amount need to be paid by the customer Allowed chars: numeric Max length: 12
virtual_account_info.virtual_account_number	number	Mandatory	Generated by Merchant that will be used by customer for doing a payment through acquirer channel (eg. ATM, Internet Banking) Allowed Chars: numeric Max Length : 23
virtual_account_info.billing_type	string	Optional	Value is FIX_BILL, NO_BILL or BILL_VARIABLE_AMOUNT Allowed chars: alphabetic, special chars Maximum length: 20 Default value: FIX_BILL
virtual_account_info.expired_time	number	Optional	Virtual account expiration time in minutes format Allowed chars: numeric Maximum length: 8 Default value: 60
virtual_account_info.reusable_status	string	Mandatory	For VA that can be paid more than once, set this to true Possible value: true false
virtual_account_info.info1	string	Optional	Additional 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: 32
virtual_account_info.info2	string	Optional	Additional 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: 32
virtual_account_info.info3	string	Optional	Additional 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: 32
customer.name	string	Mandatory	Customer name that will be displayed on acquirer channel when do inquiry Allowed chars: alphabetic, numeric, special chars Max length: 64
customer.email	string	Optional	Customer email Allowed chars: alphabetic, numeric, special chars Max length: 128

API Response

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

Type	Value
HTTP Status	200
Result	SUCCESS

Client-Id: MCH-0001-10791114622547
Request-Id: 15022aab-444f-4b04-afa8-ddfce89432ec
Response-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=

Response Header Explanation

Parameter	Description
Client-Id	Same as the request
Request-Id	Same as the request
Response-Timestamp	Timestamp Response on UTC with format ISO8601 UTC+0 from DOKU
Signature	Signature generated by DOKU based on the response body

Here is the sample of response body:

{
    "order": {
        "invoice_number": "invoice-0000061212314"
    },
    "virtual_account_info": {
        "virtual_account_number": "1900801234567891",
        "how_to_pay_page": "https://app-uat.doku.com/how-to-pay/v2/bca-virtual-account/1900801234567891/QH6xvw4tAzvbwUR9zojtxltr-KxSj9PkrocaeyqrNI4",
        "how_to_pay_api": "https://app-uat.doku.com/bca-virtual-account/v2/how-to-pay-api/1900801234567891/QH6xvw4tAzvbwUR9zojtxltr-KxSj9PkrocaeyqrNI4",
        "created_date": "20210907101930",
        "expired_date": "20210907111930",
        "created_date_utc": "2021-09-07T03:19:30Z",
        "expired_date_utc": "2021-09-07T04:19:30Z"
    }
}

Response Body Explanation

Parameter	Type	Mandatory	Description
order.invoice_number	string	Mandatory	Same as the request
virtual_account_info. virtual_account_number	number	Mandatory	Generated by Merchant that already registered to DOKU and will be used by customer for doing a payment through acquirer channel (eg. ATM, Internet Banking)
virtual_account_info.how_to_pay_page	string	Optional	Page URL that merchant can use to display how customer can complete the payment process through acquirer channel (eg. ATM, Internet Banking)
virtual_account_info.how_to_pay_api	string	Optional	URL that merchant can parse to display customized how customer can complete the payment process through accquirer channel (eg. ATM, Internet Banking)
virtual_account_info.created_date	number	Conditional	Date time of VA generated with the format of yyyyMMddHHmmss. The created date uses UTC+7 time
virtual_account_info.expired_date	string	Conditional	Date 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_utc	string	Conditional	Date time of VA generated in UTC format
virtual_account_info.expired_date_utc	string	Conditional	Date time of VA will be expired in UTC. Use this to set the expiry order on merchant side

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:

• Handling DOKU HTTP Notification

---