Payout Approval List

Get a list of payout requests pending approval.

Endpoint Information

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

Description

Retrieve a list of payout requests that are pending approval. This is useful for merchants who have enabled approval workflows for payouts (e.g., dual control).

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	integer	No	Page number
perPage	integer	No	Items per page (default 20)

Response

Success Response

{
  "success": true,
  "message": "Payout approval list retrieved successfully",
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "reference": "payout_013503",
      "status": "Pending Approval",
      "approvalRequired": true,
      "amount": "500.00",
      "currency": "USD",
      "approvers": [
        {
          "email": "[email protected]",
          "status": "Pending"
        }
      ]
      // ...other fields
    }
  ]
}