Split Payment

The Payant's Inline API can be extended to allow split payments. This allows you to invoice your customers and split the payment between several wallets.

Rules
1.
Split type must either be flat or percentage.
2.
When spliting by flat amount, the total values in the receivers array must equal the total invoice amount.
3.
When spliting by percentage, the total values in the receivers array must equal 100%.
4.
Split transactions must have atleast 2 receivers and at most 6 receivers.
5.
One of the receivers must always be marked primary.
Fee Bearer
Fees are applied to split transactions the same way fees are applied to normal transactions on Payant. The only difference is that when the fee_bearer of the invoice is account, you can specify who bearers the fees in the split transaction. You can either spread the transaction fees across the receivers or choose a single receiver to bear the fees. When the selected receivers settlement value is less than the fees, we would automatically spread fees across all receivers.
Client Pays
The following illustration shows how fees are paid when client bears the fees.

Could not load image
Account Pays
The following illustration shows how fees are paid when account bears the fees. The first illustration shows fees distributed across all receivers and the second illustration shows fees paid by a single receiver.

Could not load image
​
options
Split payment
​
Heads up!
Only one of client or client_id is required per invoice object. The client parameter will allow you to add a new customer while invoicing on the fly in case you don't have a client_id. Client will not be added if already exist. All fields are not required if reference_code is available.
​

Accept Payment - Previous

Inline Payment

Next - Payments

Add Payment

Last modified 2yr ago

Copy link

Contents