post https://api.cashfree.com/pg/easy-split/orders//split
Split After Payment API splits the payments to vendors after successful payment from the customers.
Creating Multiple Splits
- You can create multiple splits by setting the value of "disable_split" - false.
- When you are done creating multiple splits for an order you can change the value of "disable_split" to true.
- Default value of “disable_split” is true.
Important
To use this API, write to [email protected] or your Account Manager. This API has to be enabled for the test and production environment.
After the customer payment is successful, add 120 seconds delay before you use this API to split payments to vendors, to accommodate any delays in payment response from customers.
For Auto Collect pass the Authorization token. Use the Authorize API to generate the token for Auto Collect APIs.
Response Codes
| Status Code | Message | Solution |
|---|---|---|
| 200 | Order split created | |
| 404 | Order not found | Specify an order ID that exists |
| 400 | Order not paid | Ensure the order is paid |
| 400 | Settlement not found | Specify a settlement ID that is present |
| 400 | Settlement not applicable for payment code | Specify a valid Settlement ID |
| 400 | Split Vendor doesn't exist | Specify a split vendor that exist |
| 400 | Total split amount is greater than transaction amount | Specify a split amount that is less than the transaction amount |
| 400 | Transaction not captured | Retry again after some time |
| 400 | Split already exists | Create a new split |
| 400 | Transaction already processed, not eligible for split | Order is not applicable for split now, as settlement is already processed |
| 400 | Merchant not enabled for split after payments | Enable the merchants |
| 400 | Either amount or percentage has to be present for each vendor and not both | Specify either amount or percentage, do not provide both |
| 400 | Invalid vendor split amount | Specify a valid vendor split amount |
| 400 | Refund already exists, cannot create split | Create a split where refund is not initiated |
| 400 | Multiple split on charges billed to vendor is not applicable | When charged is billed to vendor multiple split feature is not allowed |
Watch this video to learn how to initiate an order with split API