API Docs
Creating Payout Requests
When creating payout requests, you need to specify the customer ID, withdrawal method, amount, and currency. This helps determine the payout details and ensures the correct amount is sent to the customer.
Headers
- Authorization:
Bearer YOUR_SECRET_KEY - Content-Type:
application/json
Body Parameters
customer_id
Required - The ID of the customer receiving the payout.
withdrawal_method_code
Required - The method of withdrawal (e.g., bank_transfer, mobile_money - Check all withdrawal methods for more details at the bottom of this page).
amount
Required - Amount to be paid out (e.g., 1000).
currency
Required - Currency code (e.g., USD, ZWG, ZAR).
Response Parameters
result
Status of the payout request creation.
payout_request_id
Payout Request ID.
message
Message.
Sample Request to Create a Payout Request
curl -X POST https://api.zuripay.app/v1/payout/request \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "d078b806-e70f-4df4-b242-344d7e7a6817",
"withdrawal_method_code": "bank_transfer",
"amount": 1000,
"currency": "USD"
}'Sample Responses
{
"result": "success",
"payout_request_id": "zp_payout_1234567890",
"message": "Payout request created successfully."
}