Usage Info

Use this method when updating the bank account purpose for your specific Business Bank Account entity.

Request

Parameters

Parameter	Type	Required	Description
business_bank_account_id	string	Yes	The business_bank_account_id of the Business Bank Account.

Business Bank Account Parameters

Parameter	Type	Required	Nullable	Description
bank_account_purposes	array	No	Yes	The purpose(s) of the bank account in the business. Must be one or more of the BANK_ACCOUNT_PURPOSES.

Note:

Nullable parameter unsets the value.
Nullable Parameters of type array removes all the items from the parameter.
Empty array for a parameter removes all the items

Example

{
  "business_bank_account_id": "bai_7eobHllxknr7mfqbjnX2Pp",
  "business_bank_account": {
    "bank_account_purposes": [
      "PRIMARY",
      "FEES",
      "SETTLEMENT"
    ]
  }
}

Response

Data

An empty data object is returned when the completion is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Enum value provided does not correspond to an available type.
ENTITY_NOT_FOUND	400	The `bank_account_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Business	SINGLE_PRIMARY_BANK_ACCOUNT	A Business can only have one bank account designated as PRIMARY. Another bank account is already set with this purpose.