v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
funding-accounts

Archive a bank account user

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

post/v3/funding-accounts/banks/users/{bankAccountUserId}/archive

Path parameters

bankAccountUserIdstring required

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

Example:{{org_bank_account_user_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 user response

idstring

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

bankAccountIdstring

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

userIdstring

BILL-generated ID of the user. The value begins with 006.

archivedboolean

Set as true if the bank account user is archived

verificationStatus'UNVERIFIED' | 'NOMINATED' | 'VERIFIED' | 'UNDEFINED'

Bank account user verification status.

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time