Correct a returned payout

Raises a CORRECTION against a payout whose leg came back RETURNED.

The original failed leg is preserved and a corrective leg is issued to the destination you supply. The single-writer rule means the original and the correction are never live at two providers at once.

For a payout that failed without returning, use /reprocess instead.

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

A VERIFIED linked account.

metadata
object

Client-supplied key–value pairs, echoed on the object and every event about it.

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