Retrieve payout state

Returns the current lifecycle state of a payout. Identify the payout by exactly one of payout_id or idempotency_key — supplying neither or both returns 400 Bad Request. The response is lifecycle-only (PII-free); full per-resource details are fetched from the existing per-resource endpoints (GET /participants/{code}, GET /payments/external_accounts/{id}, GET /payments/{payment_id}) once the caller has the identifier. All queries are scoped to the caller's platform_code; a payout_id belonging to another tenant returns 404 Not Found (indistinguishable from a non-existent payout).

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

Public-facing payout identifier returned by POST /payouts (202 acknowledgement) and emitted on payout.status_updated webhooks. Mutually exclusive with idempotency_key.

string

The Idempotency-Key value the caller supplied on the original POST /payouts submission. Useful for reconciliation when the POST response was lost mid-flight and the caller is unsure whether a payout was created. Mutually exclusive with payout_id.

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

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