ZuriPay
API Docs

Listing Payout Requests

You can list payout requests using various query parameters. The response will provide detailed information about the payout requests.

Headers

  • Authorization: Bearer YOUR_SECRET_KEY
  • Content-Type: application/json

Query Parameters

  • start_date: string (optional) - Start date for listing payout requests (format: YYYY-MM-DD).
  • end_date: string (optional) - End date for listing payout requests (format: YYYY-MM-DD).
  • limit: number (optional) - Limit the number of results returned.
  • skip: number (optional) - Skip a number of results for pagination.

Sample Request to List Payout Requests

1. List Payout Requests using Date Range

curl -X GET "https://api.zuripay.app/v1/payout/request/list?start_date=2023-01-01&end_date=2023-01-31" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

2. List Payout Requests with Pagination

curl -X GET "https://api.zuripay.app/v1/payout/request/list?limit=50&skip=0" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Sample Responses

{
    "result": "success",
    "payout_requests": [
        {
            "payout_request_id": "zp_payout_1234567890",
            "customer_id": "d078b806-e70f-4df4-b242-344d7e7a6817",
            "withdrawal_method_code": "bank_transfer",
            "amount": "1000",
            "currency": "USD",
            "status": "completed",
            "created_at": "2023-01-15T12:30:45Z",
            "updated_at": "2023-01-15T12:35:22Z"
        },
        {
            "payout_request_id": "zp_payout_0987654321",
            "customer_id": "a123c456-b789-0def-1ghi-2jkl3mno4pqr",
            "withdrawal_method_code": "mobile_money",
            "amount": "500",
            "currency": "ZAR",
            "status": "pending",
            "created_at": "2023-01-20T09:15:30Z",
            "updated_at": "2023-01-20T09:15:30Z"
        }
    ],
    "total_count": 2,
    "message": "Payout requests listed successfully."
}