Fetching Payout Requests

You can fetch a payout request using the payout request ID. The response will provide detailed information about the payout request.

Headers

• Authorization: Bearer YOUR_SECRET_KEY - Your API secret key prefixed with "Bearer".
• Content-Type: application/json - Specifies the format of the request body.

URL Parameters

• payout_request_id: string (required) - The unique identifier for the payout request you want to fetch.

Sample Request to Fetch a Payout Request

1. Fetch Payout Request using Payout Request ID

curl -X GET "https://api.zuripay.app/v1/payout/request/fetch/zp_payout_1234567890" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Response Parameters

• result: string - Indicates whether the request was successful ("success") or not ("error").
• payout_request: object - Contains the details of the fetched payout request with the following properties:
  • payout_request_id: string - Unique identifier for the payout request.
  • business_id: string - ID of the business that created the payout request.
  • customer_id: string - ID of the customer who will receive the payout.
  • withdrawal_method_code: string - Code indicating the method used for withdrawal (e.g., "bank_transfer").
  • amount: string - The amount to be paid out.
  • currency: string - The currency of the payout amount.
  • status: string - Current status of the payout request (e.g., "pending", "completed", "failed").
  • date_created: string - ISO 8601 timestamp indicating when the payout request was created.

Sample Responses

{
    "result": "success",
    "payout_request": {
        "payout_request_id": "zp_payout_1234567890",
        "business_id": "b078b806-e70f-4df4-b242-344d7e7a6817",
        "customer_id": "d078b806-e70f-4df4-b242-344d7e7a6817",
        "withdrawal_method_code": "bank_transfer",
        "amount": "1000.00",
        "currency": "USD",
        "status": "pending",
        "date_created": "2023-01-15T12:30:45Z"
    }
}