LinkedBankAccounts

Update a linked bank account

Changed on

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}

Request

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

Path parameters

linked_bank_account_idstring uuid required

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

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.

Response

OK

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 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)