Jokul Hub Overview

Jokul Hub is a feature that enables to define your settlement rule for a payment. This is a good solution for a merchant that need customized settlement rule such as, marketplace, platforms, franchise, business with various branches, and many more. Jokul Hub will help you to manage your complex payment flows.

Preparation

  1. This feature only works for Aggregator Merchant, meaning that your funds are settled from acquiring to Jokul, then Jokul will forward the funds to your account.
  2. You have activated the split settlement service when onboarding to Jokul.
  3. Create new bank on Jokul Back Office then retrieve the settlement_bank_account_id.
  4. Split settlement currently only works for integration with:
    • Jokul Checkout
    • Jokul Direct

Then you are good to go!

Implementation

To do split settlement, please add this additional_info.settlement object into your payment request:

{
...
"additional_info": {
"settlement": [
{
"bank_account_settlement_id": "SBA-0001-123123123",
"value": 10,
"type": "PERCENTAGE"
},
{
"bank_account_settlement_id": "SBA-0002-321321321",
"value": 90,
"type": "PERCENTAGE"
}
]
}
...
}
ParameterTypeMandatoryDescription
additional.info.settlementarrayOptionalInclude this object to do split settlement for the transaction
additional_info.settlement[].
bank_account_settlement_id
stringOptionalThe bank_account_settlement_id that you retrieved from the Jokul Back Office
additional_info.settlement[].valuestringOptionalThe value of the settlement can be in IDR or percentage based on the type defined. If you are using FIX type then the value should be the exact amount. If you are using PERCENTAGE type then the value should be the percentage
additional_info.settlement[].typestringOptionalThe type of the splitting funds
Possible value: FIX, PERCENTAGE

Sample Usage

Let's assume you are using the Jokul Checkout integration. You can simply add these parameters into your API Initiate Payment:

{
"order": {
"amount": 100000,
"invoice_number": "INV-20201109-002",
"currency": "IDR",
"session_id": "SU5WFDferd561dfasfasdfae123c",
"callback_url": "http://merchant.com/callback-url",
"line_items": [
{
"name": "Kopi Susu Large",
"price": 100000,
"quantity" : 1
}
]
},
"payment": {
"payment_due_date": 60
},
"customer": {
"name": "Anton Budiman",
"email": "anton@doku.com",
"phone": "6285694533142",
"address": "Menara Mulia Lantai 8",
"country": "ID"
},
"additional_info": {
"settlement": [
{
"bank_account_settlement_id": "SBA-0001-123123123",
"value": 15,
"type": "PERCENTAGE"
},
{
"bank_account_settlement_id": "SBA-0002-321321321",
"value": 85,
"type": "PERCENTAGE"
}
]
}
}

Notes

The split settlement is based on the Nett Settlement amount value and NOT from the order.amount value. This means that you need to deducted the order.amount value with the Total Fee.

Here is the illustration:

Let's assume that the order.amount is Rp104,500 and the Total Fee that being charged by Jokul for this transaction is Rp4,500 and you want to split the amount into two bank accounts with percentage of 15% into the first bank account (SBA-0001-123123123) and 85% into the second bank account (SBA-0002-321321321).

NamePercentageAmountBalance
order.amount-104,500104,500
Total Fee by Jokul-4,500100,000
SBA-0001-12312312315%15,00085,000
SBA-0002-32132132185%85,0000

Therefore, the first bank account will receive Rp15,000 and second bank account will receive Rp85,000.

FAQs

What if the settlement amount defined incorrectly?

The transaction will still be processed, but the split settlement mechanism will not be executed. The funds will settled to the primary bank account that you set in the settlement configuration.