Skip to main content

BRI VA Guide

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


BRI VA Payment Method activation#

We offered two types of BRI VA activation:

  1. Aggregator Model
  2. Direct Model

Aggregator model means you will use Jokul BIN and if you have your own BIN from BRI, you can use the Direct Model

What is BIN?

BIN stands for Bank Identifier

Integration methods#

There are two methods to integrate with BRI 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.
  2. Direct Inquiry: The VA number is registered on merchant side and Jokul 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
Jokul Direct - Jokul Generated Payment Code Virtual Account Sequence DiagramJokul 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/bri-virtual-account/v2/payment-code
API endpoint (Production)https://api.doku.com/bri-virtual-account/v2/payment-code

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

Client-Id: MCH-0001-10791114622547Request-Id: 15022aab-444f-4b04-afa8-ddfce89432ecRequest-Timestamp: 2020-08-11T08:45:42ZSignature: 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-20210124-0001",        "amount": 150000    },    "virtual_account_info": {        "expired_time": 60,        "reusable_status": false,        "info1": "Merchant Demo Store",        "info2": "Thank you for shopping",        "info3": "on our store"    },    "customer": {        "name": "Anton Budiman",        "email": "anton@example.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.amountnumberConditionalIn 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_amountnumberConditionalSend 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_amountnumberConditionalSend 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.expired_timenumberOptionalVirtual account expiration time in minutes format
Allowed chars: numeric
Maximum length: 5
Default value: 60
virtual_account_info.reusable_statusnumberMandatoryFor VA that can be paid more than once, set this to true
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: 32
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: 32
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: 32
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: 128

API Response#

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

TypeValue
HTTP Status200
ResultSUCCESS
Client-Id: MCH-0001-10791114622547Request-Id: 15022aab-444f-4b04-afa8-ddfce89432ecResponse-Timestamp: 2020-08-11T08:45:42ZSignature: 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-20210124-0001"    },    "virtual_account_info": {        "virtual_account_number": "1900600000000046",        "how_to_pay_page": "https://sandbox.doku.com/how-to-pay/v1/bri-virtual-account/1900600000000046",        "how_to_pay_api": "https://sandbox.doku.com/bri-virtual-account/v1/how-to-pay-api/1900600000000046",        "created_date": "20200313095850",        "expired_date": "20200313155850",        "created_date_utc": "2020-03-31T09:58:50Z",        "expired_date_utc": "2020-03-31T15:58:50Z"    }}
Response Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
virtual_account_info.
virtual_account_number
stringMandatoryGenerated 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.

Open amount virtual account#

Jokul supports open amount payment meaning that your customer can input their own payment amount. To use open amount, you can set your order.amount to 0. Here is the sample:

{    ...    "order": {        "invoice_number": "INV-20210124-0001",        "amount": 0,        ....    },    ...}

Limit amount virtual account#

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

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

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/doku-virtual-account/v2/payment-code
API endpoint (Production)https://api.doku.com/doku-virtual-account/v2/payment-code

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

Client-Id: MCH-0001-10791114622547Request-Id: 2dc5985e-adaa-4f82-b126-b09e9006da14Request-Timestamp: 2020-08-11T08:45:42ZSignature: 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 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": "1236260000000004",        "status": "ACTIVE",        "expired_time": 60,        "reusable_status": false,        "info1": "Merchant Demo Store",        "info2": "Thank you for shopping",        "info3": "on our store",        "info4": "additional notes 4",        "info5": "additional notes 5"    },    "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: 25
virtual_account_info.info2stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 25
virtual_account_info.info3stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 25
virtual_account_info.info4stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 25
virtual_account_info.info5stringOptionalSet this with updated value if wished
Allowed chars: alphabetic, numeric, special chars
Max length: 25
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, Jokul will give the response.

TypeValue
HTTP Status200
ResultSUCCESS
Client-Id: MCH-0001-10791114622547Request-Id: 09e0defe-a071-45b3-9feb-ac134374628cResponse-Timestamp: 2020-08-11T08:45:42ZSignature: 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-20210124-0001"    },    "virtual_account_info": {        "virtual_account_number": "1236260000000004",        "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 Jokul 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

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.