GuidesAPI ReferenceChangelog
Log In
API Reference

Execute an end-user custodial Payout Request

Executes a Payout Request using an end-user custodial signature.

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

Payout request ID

Body Params
string
required

The signature to authorize the payout execution.

string
enum
Defaults to FLEXIBLE

Exchange rate checking behavior for payout execution. FLEXIBLE: Execute the payout regardless of exchange rate changes. STRICT: Fail with PayoutQuoteExpiredException if rates have changed (see Errors section in documentation).

Allowed:
Headers
string
required

Organization ID to act on behalf of

uuid

Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an idempotency-replayed: true response header. Keys expire after 24 hours.

Responses

400

Invalid idempotency-key — the value is not a valid UUID.

401

Unauthorized

409

IdempotencyConflictError

422

IdempotencyKeyExpiredError

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