POST /v1/external_accounts/{id}

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Servers

Path parameters

Name Type Required Description
id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
address_line1 String No

Address line 1 (Street address/PO Box/Company name).

exp_year String No

Four digit number representing the card’s expiration year.

default_for_currency Boolean No

When set to true, this becomes the default external account for its currency.

exp_month String No

Two digit number representing the card’s expiration month.

address_zip String No

ZIP or postal code.

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

account_holder_name String No

The name of the person or business that owns the bank account.

address_country String No

Billing address country, if provided when creating card.

account_type String No

The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

Possible values:

  • "futsu"
  • "toza"
  • "checking"
  • "savings"
address_line2 String No

Address line 2 (Apartment/Suite/Unit/Building).

documents Object No

Documents that may be submitted to satisfy various informational requests.

documents.bank_account_ownership_verification Object No
documents.bank_account_ownership_verification.files[] Array No
address_city String No

City/District/Suburb/Town/Village.

name String No

Cardholder name.

address_state String No

State/County/Province/Region.

account_holder_type String No

The type of entity that holds the account. This can be either individual or company.

Possible values:

  • ""
  • "company"
  • "individual"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.