Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

Straddle-Account-Id
string<uuid>

For use by platforms to specify an account id and set scope of a request.

Request-Id
string

Optional client generated identifier to trace and debug a request.

Correlation-Id
string

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Key
string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Path Parameters

id
string<uuid>
required

Body

description
string | null
required

An arbitrary description for the payout.

amount
integer<int32>
required

The amount of the payout in cents.

Example:

"10000"

payment_date
string<date>
required

The desired date on which the payment should be occur. For payouts, this means the date you want the funds to be sent from your bank account.

metadata
object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the payout in a structured format.

Response

OK

meta
object
required

Metadata about the API request, including an identifier and timestamp.

response_type
enum<string>
required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Available options:
object,
array,
error,
none
data
object
required