Return a fiat payout

Valid only while the payout hasn't reached a terminal state.

Before the rail accepts the instruction, this unwinds the lock and releases the balance. After that, it asks the destination to return the funds and completes only once the return is confirmed. The earlier you raise it, the cheaper the unwind.

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

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight.
Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a
different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Responses

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