Split Settlement
Last updated
Last updated
DOKU API
Legacy DocumentationSplit Settlement 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. Split Settlement will help you to manage your complex payment flows.
This feature only works for Aggregator Merchant, meaning that your funds are settled from acquiring to DOKU, then DOKU will forward the funds to your account.
You have activated the split settlement service when onboarding to DOKU. If not activated, we will settle all settlement amounts to your default bank account. You can activate split settlement service through menu Setting > Service.
Create new bank account on DOKU Back Office from menu Setting > Bank Account and click the Add button, then fill the form and click Submit button.
We will verify your data and after the status is Verified
then you can retrieve the settlement_bank_account_id
from Bank Settlement ID column to put into your Split Settlement Rule
Split settlement currently only works for integration with:
Checkout
Direct API
Then you are good to go!
Split settlement done when payment request success. To do split settlement, please add this additional_info.settlement
object into your payment request:
additional.info.settlement
array
Mandatory
Include this object to do split settlement for the transaction
additional_info.settlement[].
bank_account_settlement_id
string
Mandatory
The bank_account_settlement_id
that you retrieved from the DOKU Back Office
additional_info.settlement[].value
string
Mandatory
The 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[].type
string
Mandatory
The type of the splitting funds
Possible value: FIX
, PERCENTAGE
Please be aware that the object names in this system are case sensitive. This means that "ObjectName" and "objectname" would be treated as two distinct objects. Be sure to use the exact case as specified to avoid any errors or issues in your implementation
Let's assume you are using the Checkout integration. You can simply add these parameters into your API Initiate Payment:
NOTES
The split settlement is calculated based on the Net Settlement amount, not the order amount. This means you must deduct the Total Fee from the order amount to determine the Net Settlement value.
Here is the illustration:
Let's assume that the order.amount
is Rp104,500
and the Total Fee that being charged by DOKU 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
).
order.amount
-
104,500
Total Fee by DOKU
-
4,500
Amount that will be splitted
100%
100,000
SBA-0001-123123123
15%
15,000
SBA-0002-321321321
85%
85,000
Therefore, the first bank account will receive Rp15,000
and second bank account will receive Rp85,000
.
You can see the split settlement bank account information from each success transaction, follow the steps given below:
Login to DOKU Back Office and go to Report > Reconciled Transaction
Click the icon on the Action column at the transaction you wish to see
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.
Of course, you can!