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

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

Body

customer_id
string<uuid>
required

Unique identifier of the related customer object.

routing_number
string
required

The routing number of the bank account.

Required string length: 9
account_number
string
required

The bank account number.

account_type
enum<string>
required
Available options:
checking,
savings
metadata
object | null

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

config
object
external_id
string | null

Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

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