v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

customers

Archive a customer bank account

Archive an existing customer bank account. In the response, the archived field is set as true. An archived customer bank account cannot be restored.

post/v3/customers/{customerId}/bank-accounts/{bankAccountId}/archive

customerIdstring required

BILL-generated ID of the customer. The value begins with 0cu.

Example:{{customer_id}}

bankAccountIdstring required

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

Example:{{customer_bank_account_id}}

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

Archive a customer bank account response

idstring

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

nameOnAccountstring

Customer bank account name

nicknamestring

Customer bank account nickname

routingNumberstring

Customer bank routing number

accountNumberstring

Customer bank account number

type'CHECKING' | 'SAVINGS'

Customer bank account type.

ownerType'BUSINESS' | 'PERSONAL'

Customer bank account owner type.

Customer bank account status.

archivedboolean

Set as true if the customer bank account is archived

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time