Create a new payout

POST 
/api/v2/payouts

Creates and executes a payout to send money to a recipient via Wave or Orange Money.

Rate Limit: 100 requests per 60 seconds

Requirements:

• Valid API key with Bearer authentication
• Organization must be active
• Sufficient account balance (amount + fees)
• Amount must be between 11 and 1,500,000 XOF

Supported Payment Methods:

• wave - Wave mobile money
• orange_money - Orange Money

Process Flow:

1. Validates request and checks balance
2. Creates payout record with 'pending' status
3. Initiates transfer with payment provider (Wave/Orange)
4. On success: deducts from account, updates status to 'completed'
5. On failure: updates status to 'failed'

Important Notes:

• Payouts are processed immediately and cannot be cancelled once initiated
• Ensure recipient phone number is correct before submitting
• Balance is deducted only on successful transfer

Request

Responses

200

Payout created and processed successfully. Returns the complete payout details with final status.

400

Bad request. Possible reasons:

• Invalid request body
• Amount less than 11 or greater than 1,500,000 XOF
• Insufficient account balance

401

Unauthorized. Possible reasons:

• Invalid or missing API key
• Organization is not active

429

Rate limit exceeded (100 requests per 60 seconds).

500

Internal server error or payment provider error. Possible reasons:

• Failed to process with Wave
• Failed to process with Orange Money
• Database error