Hold and Release Settlement
Hold & Release Settlement is a feature that enables you to hold the settlement for a payment. This is a good solution for a merchant that needs to hold and release the settlement when needed. It is suitable for merchants who have a marketplace or ecommerce business.
Case Study
"Pasar Kelontong" is an online marketplace where sellers and buyers meet. They need to hold the settlement to their sellers and will only settle it after the buyers confirmed they have received the goods.
Therefore, they implement Hold and Release Settlement feature which makes the settlement hold until they trigger the release settlement API.
Implementation
Hold Settlement
To do hold settlement, please add this additional_info.hold_settlement
object into your payment request:
You can validate whether the settlement is hold by checking to DOKU Back Office and go to Finance > Transaction. You should see the transaction will have Settlement Schedule with HOLD
.
Sample usage
Let's assume you are using the Checkout integration. You can simply add these parameters into your API Initiate Payment:
Release Settlement
To release the settlement, you will need to hit this API through your backend:
API Request
Here is the sample of request header to release transaction into settlement:
Here is the sample of request body:
API Response
After hitting the above API request, DOKU will give the response.
Here is the sample response body:
The funds will be settled to the defined bank account H+1
FAQs
When will I receive my funds after I hit the release API?
You will receive your funds H+1 after you hit the release API
What currency supported for the settlement?
We support IDR, SGD, and USD settlement. Please make sure that your defined bank account is on respective currency.
Can I use this feature with split settlement or custom settlement report?
Of course, you can!
Last updated