Route and Split Payments for your Sub-Accounts
If your Platform charges a fee or commission when facilitating payments for your Partners, or if you need to split payments between multiple parties, this feature allows you to do so automatically. There are multiple ways to route your payment based on your use cases.
- Partner to Platform
- Partner to Partner
- Platform to Partner
Partner to Platform | Partner to Partner | Platform to Partner | |
---|---|---|---|
Routes | The fund will be settled on Partner Account and routed to Platform Account | The fund will be settled on Partner Account and routed to another Partner Account | The fund will be settled on Platform Account and routed to Partner Account |
Use Case | Charge a commission for each sale of your sellers | For business that needs to take commission from other parties | For business that wants to hold the funds and take commission first before routing it to the partner |
Name Displayed to the End User | Partner Name | Partner Name | Platform Name |
Business Model Example | Multi-Branch Business, Payment resellers, Bookkeeping | Food delivery SaaS, Dropshipping / reseller | Online Marketplace |
Let us know if you are interested in using this feature for other use cases.
Route and split payments automatically in 2 steps
1. Create a Split Rule via API
Split Rule is an object that could be created in our system to set a rule for splitting payments in your platform.
Steps to create Split Rule:
- POST to
https://api.xendit.co/split_rules
- Split Rules lets you set a
flat
orpercent
amount from each transaction - You also need to specify currency of
IDR
,PHP
,THB
,VND
,MYR
- Add the destination account where the amount will be routed (if destination account is null, it will default to platform account)
- Xendit does the fee calculation for you
- The Split Rule
amount
should be less than total transaction amount
- Split Rules lets you set a
curl --request POST \ --url POST https://api.xendit.co/split_rules
You can create several split rules based on your needs (the rate and the destination routes). E.g: as a franchise business you're looking to receive 5000 flat fee for each transaction made in Jakarta stores, and 5% of revenue made by stores in Bali. You can create two fee rules that take 5% IDR percent fee and 5000 IDR flat fee.
2. Create a Transaction (e.g. Invoice, eWallet Payment) via API with the Split Rule
You can apply a fee rule to a specific transaction. Use with-split-rule header on the API call when you are creating a transaction on behalf of your partners. The set up of your API request will be depend on how do you want the flow of the money
for-user-id header | with-split-rule header | |
---|---|---|
Partner to Platform | Partner Business ID | Split rule with destination to platform |
Partner to Partner | Partner Business ID | Split rule with destination to partner |
Platform to Partner | ❌ | Split rule with destination to partner |
Steps to create Transaction with Split Rule:
- POST to
https://api.xendit.co/v2/invoices
usingwith-split-rule
header containing fee ID- And also
for-user-id
containing Business ID (for Partner to Platform and Partner to Partner flows)
- You can find Split ID on Split Payments Dashboard
with-split-rule
header is set up on the transaction level, so you can customize the amounts based on your needs. E.g: as an online marketplace, you want to take 10% commission only from apparel purchase transactions. You can apply different fee rule to this transaction type only.
Learn more on our API reference.
Monitor and track Splits on your Dashboard
You can also monitor all the split payments and track the split rules that have been created in your system.
E.g as any platform business, you need to check whether payments are successfully received in the system, and do financial reconciliations on the split payments - you can have access to our user friendly dashboard, easily track the fees created and also check payment status.
1. Monitor Split Payments
Check payment status, settlement dates, filter fees and more.
On the Split Payments tab, you will see the following columns:
Split ID
: This column shows the unique split rule ID applied on this transaction. This was generated by Xendit system when you first created a split rule.Reference:
A unique reference of your transaction from your server, such as external_id parameter.Date Created
: The date in which transaction with applied fee rule was created.Source Account ID
: The unique account name and ID of account that is deducted by the split.Transaction Amount
: The total amount of transaction paid by the end-payer.Total Split
: The total amount of split specified by the Platform.Date Settled
: The date in which the transaction is settled to the Xendit account.Status
: The status of the split in the system.
Status | Description | Notes |
---|---|---|
Completed | Split has been settled to your Platform | The fee amount will appear on your balance & transaction tab. |
Pending | Split is still pending | There are two possibilities why: 1. the transaction has not settled to Xendit 2. the system is still in the process of transferring the fees to your Platform |
Failed | Failure in splitting the payments | This could be due to reasons such as: 1. Partner account has insufficient balance 2. End-payer failed to pay the transaction 3. Payment has expired |
2. Export Split
You can also export the list of split payments on your Accounts and filter through the dates and status of these split along with the original transaction to help with your reconciliation.
Steps to Export the Split
- Filter the
date
andstatus
according to your needs - Click the export button on the Split Payments dashboard
- Upon clicking the export button, we will send you the reports directly to your email in CSV format.
INFO
This export feature can handle up to 100,000 rows total. If your data exceeded this number, we will return an error and you will be prompted to filter a smaller range of data set
3. Track Split Rules created
You can also track the list of created fee rules on the dashboard and filter through the search bar using Split Rule ID
On the Split Rule tab, you will see the following columns:
Split Rule Name
: This column shows the name to identify fee rule.Split Rule ID
: This is the ID generated by Xendit when you first created the fee rule via API.Total Split
: This is the specified amount of Platform Fee when you first created fee rule via API. This could be in percentage amount or a flat rate.Date Created
: This column shows the date of which you created the fee rule via API.
Learn more you can reach out to us for a free demo for this feature, no commitments.
Last Updated on 2023-11-22