Skip to main content
GET
/
marketplace
/
payout-requests
curl -X GET \
  "https://api.khaime.com/api/v1/marketplace/payout-requests?status=pending&limit=20" \
  -H "x-id-key: your_dashboard_auth_token" \
  -H "X-Environment: live"

List Payout Requests

Retrieve staged payout requests belonging to the authenticated marketplace. Marketplace operators use the returned reference and merchant_id to approve a request. This dashboard endpoint uses x-id-key authentication, not a Partner API key.

Query Parameters

status
string
default:"pending"
Filter by pending, approved, rejected, or cancelled.
merchant_id
number
Optionally return requests for one sub-merchant.
page
number
default:"1"
Page number.
limit
number
default:"20"
Results per page. Maximum 100.

Response

{
  "success": true,
  "message": "Marketplace payout requests retrieved successfully.",
  "data": {
    "requests": [
      {
        "id": 9821,
        "reference": "marketplace_payout_request_1780912800000_1676",
        "merchant_id": 1676,
        "amount": "50000",
        "currency": "NGN",
        "status": "pending",
        "payment_gateway": "gravv",
        "payout_method": "transfer",
        "is_live": true,
        "wallet_transaction_id": null,
        "requested_at": "2026-06-08T10:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "pages": 1
    }
  }
}
Sandbox and live requests are isolated. The environment of the Partner API key determines which records are returned.
curl -X GET \
  "https://api.khaime.com/api/v1/marketplace/payout-requests?status=pending&limit=20" \
  -H "x-id-key: your_dashboard_auth_token" \
  -H "X-Environment: live"