Get all payouts
GET/api/v2/payouts
Retrieves all payouts for your organization with optional filtering and pagination.
Rate Limit: 100 requests per 60 seconds
Features:
- Pagination with configurable page size (max 100 items per page)
- Filter by payout status (pending, completed, failed, cancelled)
- Filter by payment method (wave, orange_money)
- Filter by recipient phone number
- Filter by amount range
- Filter by date range
- Full-text search
- Option to include deleted payouts
Default Behavior:
- Returns page 1 with 20 items
- Excludes deleted payouts
- Sorted by creation date (newest first)
Request
Responses
- 200
- 401
- 429
- 500
List of payouts with pagination metadata.
Unauthorized - Invalid or missing API key.
Rate limit exceeded.
Internal server error.