LinkedBankAccounts

Create a linked bank account

Changed on

Creates a new linked bank account associated with a Straddle account. This endpoint allows you to associate external bank accounts with a Straddle account for various payment operations such as payment deposits, payout withdrawals, and more.

post/v1/linked_bank_accounts

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/linked_bank_accounts
  • Auth
    HTTP bearer

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

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

idempotency-keystring

Optional client generated value to use for idempotent requests.

Request body

account_idstring uuid nullable required

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

metadataobject nullable

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

platform_idstring uuid nullable

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

purposesstring[] nullable

The purposes for the linked bank account.

descriptionstring nullable

Optional description for the bank account.

Response

Created

response_type'object' | 'array' | 'error' | 'none' 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.

Changes

  • 8019e1d73575Revision changes
    • warning

      added the new canceled enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new canceled enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new canceled enum value to the / response property for the response status (media type: text/json)

    • info

      added the new optional header request parameter idempotency-key

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)