Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
funding-accounts

Archive a bank account

Archive an existing bank account. In the response, the archived field is set as true.

Archiving a bank account at BILL has a set of requirements.

  • Bank account status: The bank account status must be set as VERIFIED. You can verify the bank account with POST /v3/funding-accounts/banks/{bankAccountId}/verify.
  • Bank account user status: The bank account user verificationStatus must be set as VERIFIED. To begin the verification process, nominate a bank account user with POST /v3/funding-accounts/banks/users.
post/v3/funding-accounts/banks/{bankAccountId}/archive

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

Response

Archive 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.