POST
/
v1
/
linked_bank_accounts
import Straddle from '@straddleio/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const linkedBankAccountV1 = await client.embed.linkedBankAccounts.create({
    account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    bank_account: {
      account_holder: 'account_holder',
      account_number: 'account_number',
      routing_number: 'xxxxxxxxx',
    },
  });

  console.log(linkedBankAccountV1.data);
}

main();
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "created",
    "status_detail": {
      "reason": "unverified",
      "source": "watchtower",
      "code": "<string>",
      "message": "<string>"
    },
    "bank_account": {
      "institution_name": "<string>",
      "account_holder": "<string>",
      "routing_number": "<string>",
      "account_mask": "<string>"
    },
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> 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.

Body

​
account_id
string
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.

Response

201
text/plain
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
Suggest editsRaise issue