v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
funding-accounts

Update a bank account

Update details about an existing bank account.

This operation follows a set of rules.

  • Bank account status requirement: The bank account status must be set as VERIFIED before you can update any details about the bank account. You can verify the bank account with POST /v3/funding-accounts/banks/{bankAccountId}/verify.
  • Update field restrictions: You cannot update the routingNumber, accountNumber, and account type values for a bank account. If you want to update any of these values, create a new bank account with POST /v3/funding-accounts/banks.
patch/v3/funding-accounts/banks/{bankAccountId}

Path parameters

bankAccountIdstring required

BILL-generated ID of the bank account. The value begins with bac.

Example:{{org_bank_account_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

nameOnAccountstring

Full name on bank account

ownerType'BUSINESS' | 'PERSONAL'

Bank account owner type

bankNamestring

Bank name. Set this field as a nickname for your bank account.

accessToAdminsboolean

Set as true to enable access to all users with the ADMINISTRATOR user role

chartOfAccountIdstring

BILL-generated ID of the chart of accounts for the organization bank account. The value begins with 0ca.

Example request

{
  "ownerType": "PERSONAL"
}

Response

Update a bank account response

idstring required

BILL-generated ID of the bank account. The value begins with bac.

archivedboolean required

Set as true if the bank account is archived

status'NOT_VERIFIED' | 'VERIFIED' | 'PENDING' | 'BLOCKED' | 'EXPIRED' | 'INVALID' | 'UNDEFINED'

Bank account status.

createdBystring

BILL-generated ID of the user that created the bank account. The value begins with 006.

routingNumberstring

Bank routing number

accountNumberstring

Bank account number

nameOnAccountstring

Full name on bank account

type'CHECKING' | 'SAVINGS'

Bank account type

ownerType'BUSINESS' | 'PERSONAL'

Bank account owner type

bankNamestring

Bank name

accessToAdminsboolean

Set as true to enable access to all users with the ADMINISTRATOR user role

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

chartOfAccountIdstring

BILL-generated ID of the chart of accounts for the bank account. The value begins with 0ca.