API Documentation for Payout Functionality
This documentation provides step-by-step guidance for developers to integrate functionalities for payout using PHP cURL or NodeJs. Each section includes the method, endpoint, request parameters, and sample responses.
GET https://mybundlepay.com/api/payout
HEADERS
Authorization* string
Pass your {secret_key} as a bearer token in the request header to authorize this call
Accept application/json
REQUEST PARAMETERS*
The request body parameters include the required amount (integer) representing the withdrawal amount in the smallest currency unit, bank_code (string) for the bank code from the fetch banks endpoint, account_number (string) for the recipient's bank account number, and account_name (string) for the recipient's account name.
Notes for Developers
1. API Key Security: Ensure the API key is stored securely, such as in environment variables.
2. Error Handling: Always implement error handling for failed requests or invalid responses.
3. Rate Limits: Check the API provider’s documentation for rate limits and implement retry mechanisms if needed.
4. Currency Unit: The amounts are typically in the smallest currency unit (e.g., kobo for NGN). Ensure proper conversions.
5. Test vs. Live: Use test API keys for development and testing, and ensure live keys are only used in production.