Overview

The Payswiftly Payout API enables businesses to manage automated financial transactions by integrating key payout processes. Here’s a more detailed guide on how to utilize the API:

1. Authentication: Each request requires an API key for authorization. Set this up first to gain access to all API endpoints.

2. Create Receivers: Begin by using the POST /receivers endpoint to create a new receiver profile. This requires the receiver's personal details, such as name, email, and phone number.

3. Add Bank Accounts: After creating a receiver, associate a bank account with them using the POST /bank-accounts endpoint. You'll need the bank details like the account number and branch information.

4. Initiate Payouts: Once the receiver and their bank account are set up, initiate a payout using the POST /payouts endpoint. Specify the receiver's ID and the amount to transfer.

5. Track Transactions: To monitor the status of payouts, you can use the GET /payouts/{payout_id} endpoint to check if the payout was successful, pending, or failed.

6. Webhooks: To handle event-driven updates, such as successful payouts or errors, register webhooks with the API. Webhooks will notify your system when an event occurs, enabling real-time tracking.

7. Error Handling: Every API response includes status codes. The documentation lists possible errors, like invalid parameters or authentication failures, and provides guidance on troubleshooting.

Example Workflow:

• Authenticate using your API key.

• Create a receiver with their details.

• Attach a bank account to the receiver.

• Execute the payout.

• Monitor the payout status.

• Use webhooks for real-time event notifications.