Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Headers

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

Body

account_id
string<uuid> | null
required

The unique identifier of the Straddle account to associate this bank account with.

bank_account
object
required
metadata
object | null

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

platform_id
string<uuid> | null

The unique identifier of the Straddle Platform to associate this bank account with.

purposes
enum<string>[] | null

The purposes for the linked bank account.

Available options:
charges,
payouts,
billing
description
string | null

Optional description for the bank account.

Response

Created

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