Get Payout Approval List

Retrieve payout requests that are pending approval.

Endpoint Information

Name: Get Payout Approval List
Method: GET
URL: {{BASE_URL}}/api/v1/payment/payout-approval/list

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Query Parameters

Parameter	Type	Required	Description
merchantAccountId	string	Yes	Your merchant account ID
filterByEmail	string	No	Filter by customer email
page	number	No	Page number for pagination
perPage	number	No	Number of items per page

Response

Success Response

{
    "success": true,
    "message": "Payout approval list retrieved successfully",
    "data": [
        {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "reference": "payout_013503",
            "merchantAccountId": "100002",
            "customerEmail": "[email protected]",
            "customerName": "Pete Smith",
            "amount": "500.00",
            "currency": "USD",
            "payoutType": "bankPayout",
            "status": "Pending Approval",
            "requestedBy": "[email protected]",
            "requestedAt": "2025-12-28 10:30:45",
            "approvalRequired": true,
            "approvers": [
                {
                    "email": "[email protected]",
                    "status": "Pending"
                },
                {
                    "email": "[email protected]",
                    "status": "Approved"
                }
            ],
            "bankDetails": {
                "accountName": "Pete Smith",
                "accountNumber": "****5678",
                "bankName": "Example Bank"
            }
        },
        {
            "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
            "reference": "payout_013504",
            "merchantAccountId": "100002",
            "customerEmail": "[email protected]",
            "customerName": "Jane Smith",
            "amount": "250.00",
            "currency": "EUR",
            "payoutType": "cardPayout",
            "status": "Pending Approval",
            "requestedBy": "[email protected]",
            "requestedAt": "2025-12-28 14:15:20",
            "approvalRequired": true,
            "approvers": [
                {
                    "email": "[email protected]",
                    "status": "Pending"
                }
            ],
            "cardDetails": {
                "cardBrand": "Visa",
                "lastFourDigits": "4242"
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "last_page": 3,
        "per_page": 20,
        "total": 45,
        "from": 1,
        "to": 20
    }
}

warning

Note: This API returns only payout requests that require approval. Use the filterByEmail parameter to narrow down results to a specific customer. The approval status can be: Pending, Approved, Rejected.