Airtm Bulk Payments API

## OverviewBulk Payments enable your organization to process multiple payouts simultaneously through a single API operation. This powerful feature is designed for businesses that need to send payments to large numbers of recipients efficiently, such as payroll processing, affiliate commissions, contractor payments, or distribution of rewards and bonuses.## What are Bulk Payments?Bulk Payments allow you to upload a batch of payout instructions and process them all at once, rather than making individual API calls for each payment. This approach offers significant advantages in terms of efficiency, cost-effectiveness, and operational simplicity.### Key Features- **High-Volume Processing** - Handle thousands of payments in a single operation- **Asynchronous Processing** - Non-blocking operations that scale with your needs- **Real-Time Progress Tracking** - Monitor batch processing status in real-time- **Detailed Reporting** - Comprehensive success and failure reporting- **Cost Efficiency** - Reduced API calls and processing overhead### Use Cases- **Payroll Processing** - Monthly/weekly employee salary payments- **Contractor Payments** - Freelancer and contractor compensation- **Affiliate Commissions** - Partner and affiliate reward distribution- **Prize Distribution** - Contest and promotion prize payments- **Supplier Payments** - Vendor and supplier payment processing- **Refund Processing** - Bulk customer refund operations## Bulk Payment Workflow### 1. Preparation Phase- Validate recipient information- Calculate total amounts and fees- Ensure sufficient account balance### 2. Upload Phase- Submit bulk payment request- Receive batch ID for tracking- System validates all entries- Initial status: `pending`### 3. Processing Phase- Individual payments are processed asynchronously- Real-time status updates available- Status changes to `running`- Progress tracking via API### 4. Completion Phase- All payments processed (success or failure)- Final status: `done`- Detailed reports available- Success and failure breakdowns provided## Status Management### Bulk Payment Status Values| Status | Description | Actions Available || --------- | ---------------------------------------------------------- | ----------------------------------------- || `pending` | The bulk payment was received but it has yet to be started | Cancel entire batch || `running` | Individual payments being processed | Monitor progress, cancel pending payments || `done` | All payments processed (success or failure) | View reports, download results || `failed` | An error occurred during processing | check the errors endpoint |