Single and Bulk Payout Implementation with Recurring Flow Updates
This document provides an overview of our single and bulk payout functionalities, including the recurring flow for updating their statuses.
Payout Options
Our system supports two payout options via the External API:
- Single Payout: Send funds electronically to one recipient at a time.
- Bulk Payout: Send funds electronically to multiple recipients in a single API call.
Single Payout Flow
- Initiate Payout: A request is sent via the API endpoint specifying recipient details (bank account information, amount, currency), and an optional reference ID.
- Process Payout: The system validates the request and initiates the transfer of funds to the recipient's account.
Bulk Payout Flow
- Prepare Recipient List: A list containing recipient details for each payout (bank account information, amount, currency) is prepared.
- Submit Bulk Payout: The recipient list and any additional information (total payout amount, currency) are sent via the dedicated bulk payout API endpoint.
- Process Individual Payouts: The system validates the request, initiates individual transfers for each recipient, and provides individual status updates for each payout within the response.
API Documentation
The API documentation provides detailed information on:
- Specific API endpoints for single and bulk payouts.
- Data format requirements for recipient information and payout details.
The following endpoints are available for Payouts:
- Initiate Payout with File:
Upload a file to initiate multiple payouts in bulk. This endpoint processes a file containing details for each transaction, supporting efficient batch payouts - Initiate Payout to Existing Beneficiary
Create a payout for an existing beneficiary using their unique identifier. This endpoint enables seamless payments to previously registered recipients without re-entering details. - Initiate Direct Payout
Make an immediate payout to a specified account without the need for a pre-registered beneficiary. Ideal for one-time payments to new recipients. - Cancel a Payout
Cancel a Pending payout before completion. This endpoint allows you to stop a scheduled or pending payment, preventing the transfer from finalizing. - Get Payout by ID
Retrieve detailed information for a specific payout using its unique ID. This endpoint provides status, transaction details, and history for individual payout tracking. - Get Payouts
Fetch a list of all payouts, with optional filters for date or status of the Payout transaction. This endpoint allows for easy access to payout history and helps track multiple transactions. - Update Payout Account
Modify account details for an existing payout before it’s processed. Use this endpoint to change payout account information, ensuring accuracy in transactions. - Get Payout Document Template
Download a standardized document template required for bulk or specific types of payouts. This endpoint helps ensure compliance with required formats for file-based payouts. - Get Payout Configuration
Retrieve configuration settings for payout operations, including supported currencies, payout limits, and fees.
Please refer to the API documentation for comprehensive instructions and code samples for integrating single and bulk payouts into your application.