Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
funding-accounts

Create a bank account

Create a new bank account. The currently signed-in user must have the ADMINISTRATOR user role in the BILL organization to perform this operation. BILL sends an email notification for informing you about changes to your funding accounts.

When you create a bank account, BILL sends a test ACH payment to confirm whether the account details are accurate.

In the response, three fields are set to their default values.

  • The bank account status is set as PENDING. You can verify the bank account with POST /v3/funding-accounts/banks/{bankAccountId}/verify.
  • The payables and receivables values are set as false. To update these values, update the bank account with PATCH /v3/funding-accounts/banks/{bankAccountId}.

Note: Creating a bank account requires an MFA-trusted API session. See MFA setup for information about the BILL MFA process.

See Bank account setup (v3 API) in the Guides section for more information, sample requests, and responses.

post/v3/funding-accounts/banks

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 required

Full name on bank account

routingNumberstring

Bank routing number. This field is required.

accountNumberstring

Bank account number. This field is required.

type'CHECKING' | 'SAVINGS' required

Bank account type

ownerType'BUSINESS' | 'PERSONAL' required

Bank account owner type

bankNamestring required

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 bank account. The value begins with 0ca.

Example request

{
  "nameOnAccount": "Agatha Ffringe",
  "routingNumber": "074000010",
  "accountNumber": "111222333",
  "type": "CHECKING",
  "ownerType": "BUSINESS",
  "bankName": "Chase"
}

Response

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