Update a linked bank account

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.

PUT /v1/linked_bank_accounts/{linked_bank_account_id}

cURL

cURL

curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/linked_bank_accounts/<uuid> \
  --header 'Content-Type: application/json' \
  --data '{
  "bank_account": {
    "account_holder": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>"
  }
}'

200

{
  "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>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "purposes": [
      "charges"
    ],
    "metadata": {},
    "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>"
  }
}

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

Path Parameters

linked_bank_account_id · string<uuid> · required

Body

application/jsontext/jsonapplication/*+json

bank_account · object · required

Show child attributes

metadata · object

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

Show child attributes

Response

200

text/plain

OK

meta · object · required

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

Show child attributes

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

Show child attributes