Skip to main content

BNI VA Guide

Jokul has partnered with various banks and one of them is BNI to provide Virtual Account Payment. Learn more about how Jokul can help you integrate with BNI Virtual Account here.


Integration methods

There are two methods to integrate with BNI VA:

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

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
Jokul Direct - Virtual Account Sequence Diagram
Jokul Direct 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/bni-virtual-account/v2/payment-code
API endpoint (Production)https://api.doku.com/bni-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 Jokul 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-1634463196",
"amount": 20000
},
"virtual_account_info": {
"expired_time": 60,
"biling_type" : "FIXED",
"info" : "Product detail here",
"merchant_unique_reference":"UNIQUE_000035"
},
"customer": {
"name": "Anton Budiman",
"email": "anton@doku.com"
},
"additional_info": {
}
}
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. Billing type already provides its own settings for the Amount type. You can check the details in the Billing type section.
Allowed chars: numeric
Max length: 12
virtual_account_info.expired_timenumberOptionalVirtual account expiration time in minutes format
Allowed chars: numeric
Maximum length: 8
Default value: 60
virtual_account_info.billing_typestringOptionalBilling type is a type of feature used by merchants to determine the method of payment for their customers when they are in Inquiry. Here are the types:
a. OPEN : Invoice/billing can be paid multiple times as long as it is still active. Validation : order.amount must be = 0.

b. FIXED : Invoice/billing should be paid with exactly the same amount as requested. Validation : order.amount must be > 0.

c. INSTALLMENT : Invoice/billing can be paid multiple times as long as paid amount is less than the requested amount and still active.

d. MIN : Invoice/billing can be paid with greater than or equal to the requested amount.

e. OPEN_MIN : Invoice/billing can be paid greater than or equal to the requested amount multiple times as long as it is still active.

f. OPEN_MAX : Invoice/billing can be paid less than or equal to the requested amount multiple times as long as it is still active.
virtual_account_info.infostringOptionalAdditional info that will be display on BNI channel.
Allowed chars: alphabetic, numeric, special chars
Max length: 32
virtual_account_info.merchant_unique_referencestringMandatoryGenerated by merchant to identify the order and must unique per request
Allowed chars: alphabetic, numeric
Max length: 13

NOTES :
a. If client id 22 character (eg. MCH-0411-1211992283648), then max char 13 char.

b. If client id longer (eg. 23 char), merchant unique reference will be shorter (12 char)
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
additional_infoobjectOptionalMerchant can send additional data through this parameter and will be get the data when notify payment

API Response

After hitting the above API request, Jokul 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 Jokul
SignatureSignature generated by Jokul based on the response body

Here is the sample of response body:

{
"order": {
"invoice_number": "INV-1634463196",
"amount": 20000
},
"virtual_account_info": {
"status": "ACTIVE",
"virtual_account_number": "8803300000000014",
"merchant_unique_reference": "UNIQUE_000035",
"created_date": "20211017163316",
"expired_date": "20211017173316",
"created_date_utc": "2021-10-17T09:33:16Z",
"expired_date_utc": "2021-10-17T10:33:16Z",
"how_to_pay_page": "https://sandbox.doku.com/how-to-pay/v2/bni-virtual-account/8803300000000014/XmmJ-mWUYNY6Cmp6GeF0qYvwvLsH57UOz_Ap6yqCEEM",
"how_to_pay_api": "https://api-sandbox.doku.com/bni-virtual-account/v2/how-to-pay-api/8803300000000014/XmmJ-mWUYNY6Cmp6GeF0qYvwvLsH57UOz_Ap6yqCEEM"
}
}
Response Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
order.amountnumberMandatorySame as the request
virtual_account_info.statusstringOptionalStatus of the transaction.
Possible values: ACTIVE, TIMEOUT, FAILED
virtual_account_info.merchant_unique_referencenumberMandatorySame as the request
virtual_account_info.
virtual_account_number
stringOptionalGenerated by Jokul that will be used by customer for doing a payment through acquirer channel (eg. ATM, Internet Banking)
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)
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)
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
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, Jokul will send HTTP Notification to your defined Notification URL. Learn how to handle the notification from Jokul:


Additional features

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

Jokul Fin - 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.