Skip to main content
GET

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. Authenticate with your marketplace operator Partner API key via the X-API-Key header. The key’s environment (sandbox or live) determines which payout requests are returned.

Query Parameters

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

Response

Sandbox and live requests are isolated. The environment of the Partner API key determines which records are returned.