Payout APIs
Learn about the different types of Payout APIs available with Plural payout, each API is tailored to handle a specific kind of payout.
Plural payout support, Individual Transfers, and Bulk Transfers are two distinct methods of distributing funds, each suited to different use cases depending on the number of the transactions.
1. Individual Transfer
In individual transfers, funds are sent to a single beneficiary or bank account number at a time.
- Create a Payout to Bank Account Number: You can initiate a payout to a bank account number and save the account details as a beneficiary linked to your account for future transactions. You can also perform the below action using the same API.
- Schedule a Payout: You can schedule a specific time to process a payout request. This allows you to initiate a scheduled payout to a beneficiary or directly to a bank account.
- Create a Payout to Beneficiary: You can save the Beneficiary details returned in our Create a Payout to Bank Account Number API to initiate a future payout to the Beneficiary details saved.
- Update Schedule Payout: You can update the schedule time of the payout request.
- Cancel Schedule Payout: You can also cancel a scheduled payout request.
The table below lists the various options available in our Payouts API and gives a brief description of each:
API Endpoint | Description |
---|---|
Create a Payout to Bank Account Number | Use this API to initiate a payout to a bank account number and save the account details as a beneficiary linked to your account for future transactions. |
Update Schedule Payout | Use this API to update the schedule time of the scheduled payout. |
Cancel Scheduled Payout | Use this API to cancel a schedule payout. |
Get Payout Status | Use this API to fetch the payout status. |
2. Bulk Transfer
Bulk transfer involves sending payouts to multiple beneficiaries in a queue. The sender uploads an Excel file containing beneficiary details, and the system processes all the payments simultaneously.
API Endpoint | Description |
---|---|
Upload File | Use this API to initiate Bulk payout. |
Get Bulk Payouts Status | Use this API to get the status of the bulk payout |
Updated 8 months ago