# 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. You will receive this from your account manager.
2. **Create Receivers**: Begin by using the [Create New Receiver](https://docs.payswiftly.io/payout-api/receiver/create-new-receiver) 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 receiving account with them using the the appropriate [Add Receiver Account](https://docs.payswiftly.io/payout-api/receiver/add-receiver-account) 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  [Create a Payout Transaction](https://docs.payswiftly.io/payout-api/payout/create-a-payout-transaction) 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 Payout](https://docs.payswiftly.io/payout-api/payout/get-payout) endpoint to check if the payout was successful, pending, or failed.
6. **Webhooks**: To handle event-driven updates, such as successful payouts or errors, provide your systems webhook url to your Account Manager. 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 receiver account to the receiver.
* Execute the payout.
* Monitor the payout status.
* Use webhooks for real-time event notifications.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.payswiftly.io/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.