List recipient payouts for a tenant

List the recipient payouts in a tenant.

Authenticate with a dashboard session token, or a payout_write API key in X-API-Key (create one with POST /v1/api-keys/payout; it is pinned to one merchant and expires within 90 days). A payout key acts only for its own merchant. A merchantId for another merchant, another merchant's recipient or payout, or a path tenantId other than the key's tenant all return 404. A znz_pt_ key sends only sandbox payouts and a znz_pl_ key only production payouts. Payouts made with a key record it as the actor. Merchant secret keys, publishable keys and agent_onboarding keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Tenant identifier (UUID).

Query Params
string

Filter by payout status.

string

Filter by gateway key.

string

Filter by recipient (UUID).

string

ISO date lower bound.

string

ISO date upper bound.

integer
1 to 500

Result cap (default 100, max 500).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json