Cancel a payout
Cancel a payout to prevent it from being processed. The status of the payout must be created, scheduled, or on_hold.
Authorizations
Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Optional client generated value to use for idempotent requests.
10 - 40Path Parameters
Body
Details about why the payout status was updated.
Response
OK
Metadata about the API request, including an identifier and timestamp.
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
object, array, error, none