External Payout APIs Workflow

External Payout is a powerful solution that enables businesses to disburse funds to external entities such as vendors, partners, or service providers. To streamline this process, our platform supports the creation of batch payments, allowing multiple disbursement requests to be grouped together and processed efficiently. This guide will walk you through the workflow of using External Payout APIs, starting with creating a batch, adding payout requests, and finally, closing the batch.

What is a Batch?

A batch is essentially a container that holds multiple payout requests, allowing merchants to manage these requests as a single unit. Instead of manually handling each disbursement one by one, batches help automate the process, ensuring that large numbers of payments can be submitted and tracked at the same time. This reduces manual work and increases the overall efficiency of your payout process.

---

(A) Creating the Deposit Batch

The first step in the External Payout API workflow is to create a Batch. This batch will serve as the foundation for organizing and managing multiple deposit requests. You can create a batch in two ways:

1. Create an empty batch and add deposit requests later.
2. Create a batch with requests included from the start.

How to Create a Batch?

• When initiating the creation of a batch, the system allows you to either include deposit requests immediately or add them afterward. This flexibility ensures that you can manage your workflow based on your operational needs.
• Think of the batch as a folder that will contain all your deposit requests. By grouping them into a batch, you can track, process, and review all requests together.

The ability to organize deposit requests into batches ensures smooth management and consistency. Whether you’re disbursing funds to hundreds of vendors or processing payments for a gig economy platform, creating a batch makes the entire process streamlined and easily manageable.

---

(B) Adding Deposit Requests to the Batch

Once your batch is created, the next step is to add deposit requests. Each deposit request is an individual payment instruction that transfers funds to a specific recipient. The deposit request includes important details like:

• Beneficiary Name
• Account Number
• Amount to be transferred

Filling in Beneficiary Information

• The beneficiary details must be accurate, as any mistakes can result in delays or funds being sent to the wrong account. Make sure to double-check all beneficiary details before submitting the request.

By using our platform’s API, you can efficiently add multiple deposit requests into the batch. This is especially useful for businesses with a high volume of transactions, as it automates the process and minimizes the potential for human error.

---

(C) Closing the Batch

After all the necessary deposit requests have been added to the batch, the final step is to close the batch. Closing the batch triggers the payout process, ensuring that the disbursement requests are submitted for processing.

Why Closing the Batch is Important?

• Closing the batch confirms that all deposit requests have been reviewed and are ready for submission. This step is crucial to initiate the actual transfer of funds.
• Once the batch is closed, it is sent for processing, and the payout system begins the task of transferring the specified amounts to the intended beneficiaries.

you should know

You should know that you can close the batch while creating it from the beginging by providing all the needed requests and the "close_batch" parameter within the create batch payload.

---

Querying Batch and Request Details

Merchants have the flexibility to query the details of their batches and requests using our various query APIs. This feature allows merchants to:

• Query the details of a specific batch: Retrieve information about the batch, including all the deposit requests within it.
• Query a single request within a batch: Identify and view the details of a specific deposit request.
• Query batches based on status: Filter and view batches with specific statuses, such as pending or completed.
• Query batches by merchant reference: Locate and retrieve batches using the merchant’s own reference code for better tracking and management.

These query APIs provide transparency and control, ensuring that merchants can monitor and manage their payout processes effectively.

---

Workflow Summary

In summary, the External Payout API workflow offers merchants a streamlined and organized method for managing their payout processes. Here's a recap of the key steps:

1. Create a Batch: A container for multiple deposit requests that can be managed as a single unit.
2. Add Deposit Requests: Include individual payment instructions for each recipient.
3. Close the Batch: Submit the batch for processing to finalize the payout.
4. Query Batch and Request Details: Use our query APIs to track and monitor batches or specific requests based on status or reference.

By leveraging this workflow, merchants can automate their external payouts, ensuring secure and timely delivery of funds to multiple recipients. For more information on setting up and optimizing your External Payout process, please refer to our related manual for detailed API documentation and best practices.