# Linked Bank Accounts

## Create a linked bank account

**post** `/v1/linked_bank_accounts`

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.

### Header Parameters

- `"correlation-id": optional string`

- `"idempotency-key": optional string`

- `"request-id": optional string`

### Body Parameters

- `account_id: string`

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

- `bank_account: object { account_holder, account_number, routing_number }`

  - `account_holder: string`

    The name of the account holder as it appears on the bank account. Typically, this is the legal name of the business associated with the account.

  - `account_number: string`

    The bank account number.

  - `routing_number: string`

    The routing number of the bank account.

- `description: optional string`

  Optional description for the bank account.

- `metadata: optional map[string]`

  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: optional string`

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

- `purposes: optional array of "charges" or "payouts" or "billing"`

  The purposes for the linked bank account.

  - `"charges"`

  - `"payouts"`

  - `"billing"`

### Returns

- `LinkedBankAccountV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $STRADDLE_API_KEY" \
    -d '{
          "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "bank_account": {
            "account_holder": "account_holder",
            "account_number": "account_number",
            "routing_number": "xxxxxxxxx"
          }
        }'
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_mask": "account_mask",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "purposes": [
      "charges"
    ],
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "metadata": {
      "foo": "string"
    },
    "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## List linked bank accounts

**get** `/v1/linked_bank_accounts`

Returns a list of bank accounts associated with a specific Straddle account. The linked bank accounts are returned sorted by creation date, with the most recently created appearing first. This endpoint supports pagination to handle accounts with multiple linked bank accounts.

### Query Parameters

- `account_id: optional string`

  The unique identifier of the related account.

- `level: optional "account" or "platform"`

  - `"account"`

  - `"platform"`

- `page_number: optional number`

  Results page number. Starts at page 1.

- `page_size: optional number`

  Page size. Max value: 1000

- `purpose: optional "charges" or "payouts" or "billing"`

  The purpose of the linked bank accounts to return. Possible values: 'charges', 'payouts', 'billing'.

  - `"charges"`

  - `"payouts"`

  - `"billing"`

- `sort_by: optional string`

  Sort By.

- `sort_order: optional "asc" or "desc"`

  Sort Order.

  - `"asc"`

  - `"desc"`

- `status: optional "created" or "onboarding" or "active" or 3 more`

  The status of the linked bank accounts to return. Possible values: 'created', 'onboarding', 'active', 'inactive', 'rejected'.

  - `"created"`

  - `"onboarding"`

  - `"active"`

  - `"rejected"`

  - `"inactive"`

  - `"canceled"`

### Header Parameters

- `"correlation-id": optional string`

- `"request-id": optional string`

### Returns

- `LinkedBankAccountPagedV1 = object { data, meta, response_type }`

  - `data: array of object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: PagedResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

      Total number of items returned in this response.

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts \
    -H "Authorization: Bearer $STRADDLE_API_KEY"
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "bank_account": {
        "account_holder": "account_holder",
        "account_mask": "account_mask",
        "institution_name": "institution_name",
        "routing_number": "routing_number"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "purposes": [
        "charges"
      ],
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "metadata": {
        "foo": "string"
      },
      "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}
```

## Update a linked bank account

**put** `/v1/linked_bank_accounts/{linked_bank_account_id}`

Updates an existing linked bank account's information. This can be used to update account details during onboarding or to update metadata associated with the linked account. The linked bank account must be in 'created' or 'onboarding' status.

### Path Parameters

- `linked_bank_account_id: string`

### Header Parameters

- `"correlation-id": optional string`

- `"idempotency-key": optional string`

- `"request-id": optional string`

### Body Parameters

- `bank_account: object { account_holder, account_number, routing_number }`

  - `account_holder: string`

    The name of the account holder as it appears on the bank account. Typically, this is the legal name of the business associated with the account.

  - `account_number: string`

    The bank account number.

  - `routing_number: string`

    The routing number of the bank account.

- `metadata: optional map[string]`

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

### Returns

- `LinkedBankAccountV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts/$LINKED_BANK_ACCOUNT_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $STRADDLE_API_KEY" \
    -d '{
          "bank_account": {
            "account_holder": "account_holder",
            "account_number": "account_number",
            "routing_number": "xxxxxxxxx"
          }
        }'
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_mask": "account_mask",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "purposes": [
      "charges"
    ],
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "metadata": {
      "foo": "string"
    },
    "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## Lookup a linked bank account

**get** `/v1/linked_bank_accounts/{linked_bank_account_id}`

Retrieves the details of a linked bank account that has previously been created. Supply the unique linked bank account `id`, and Straddle will return the corresponding information. The response includes masked account details for security purposes.

### Path Parameters

- `linked_bank_account_id: string`

### Header Parameters

- `"correlation-id": optional string`

- `"request-id": optional string`

### Returns

- `LinkedBankAccountV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts/$LINKED_BANK_ACCOUNT_ID \
    -H "Authorization: Bearer $STRADDLE_API_KEY"
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_mask": "account_mask",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "purposes": [
      "charges"
    ],
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "metadata": {
      "foo": "string"
    },
    "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## Unmask a linked bank account

**get** `/v1/linked_bank_accounts/{linked_bank_account_id}/unmask`

Retrieves the unmasked details of a linked bank account that has previously been created. Supply the unique linked bank account `id`, and Straddle will return the corresponding information, including sensitive details. This endpoint needs to be enabled by Straddle for your account and should only be used when absolutely necessary.

### Path Parameters

- `linked_bank_account_id: string`

### Header Parameters

- `"correlation-id": optional string`

- `"request-id": optional string`

### Returns

- `LinkedBankAccountUnmaskV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 5 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      Unique identifier for the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_number, institution_name, routing_number }`

      The bank account details associated with the linked bank account.

      - `account_holder: string`

      - `account_number: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the linked bank account was created.

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      Additional details about the current status of the linked bank account.

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of when the linked bank account was last updated.

    - `metadata: optional map[string]`

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts/$LINKED_BANK_ACCOUNT_ID/unmask \
    -H "Authorization: Bearer $STRADDLE_API_KEY"
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_number": "account_number",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## Cancel a linked bank account

**patch** `/v1/linked_bank_accounts/{linked_bank_account_id}/cancel`

Cancels an existing linked bank account. This can be used to cancel a linked bank account before it has been reviewed. The linked bank account must be in 'created' status.

### Path Parameters

- `linked_bank_account_id: string`

### Header Parameters

- `"correlation-id": optional string`

- `"idempotency-key": optional string`

- `"request-id": optional string`

### Returns

- `LinkedBankAccountV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```http
curl https://sandbox.straddle.com/v1/linked_bank_accounts/$LINKED_BANK_ACCOUNT_ID/cancel \
    -X PATCH \
    -H "Authorization: Bearer $STRADDLE_API_KEY"
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "bank_account": {
      "account_holder": "account_holder",
      "account_mask": "account_mask",
      "institution_name": "institution_name",
      "routing_number": "routing_number"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "purposes": [
      "charges"
    ],
    "status": "created",
    "status_detail": {
      "code": "code",
      "message": "message",
      "reason": "unverified",
      "source": "watchtower"
    },
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "metadata": {
      "foo": "string"
    },
    "platform_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## Domain Types

### Linked Bank Account Paged V1

- `LinkedBankAccountPagedV1 = object { data, meta, response_type }`

  - `data: array of object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: PagedResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

      Total number of items returned in this response.

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Linked Bank Account Unmask V1

- `LinkedBankAccountUnmaskV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 5 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      Unique identifier for the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_number, institution_name, routing_number }`

      The bank account details associated with the linked bank account.

      - `account_holder: string`

      - `account_number: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the linked bank account was created.

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      Additional details about the current status of the linked bank account.

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of when the linked bank account was last updated.

    - `metadata: optional map[string]`

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Linked Bank Account V1

- `LinkedBankAccountV1 = object { data, meta, response_type }`

  - `data: object { id, account_id, bank_account, 8 more }`

    - `id: string`

      Unique identifier for the linked bank account.

    - `account_id: string`

      The unique identifier of the Straddle account related to this bank account.

    - `bank_account: object { account_holder, account_mask, institution_name, routing_number }`

      - `account_holder: string`

      - `account_mask: string`

      - `institution_name: string`

      - `routing_number: string`

    - `created_at: string`

      Timestamp of when the bank account object was created.

    - `purposes: array of "charges" or "payouts" or "billing"`

      The purposes for the linked bank account.

      - `"charges"`

      - `"payouts"`

      - `"billing"`

    - `status: "created" or "onboarding" or "active" or 3 more`

      The current status of the linked bank account.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

      - `"canceled"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the linked bank account.

    - `description: optional string`

      Optional description for the bank account.

    - `metadata: optional map[string]`

      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: optional string`

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

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`