v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
customers

Create a customer bank account

Create a new customer bank account. When you add customer bank account information, you can charge the customer for invoices.

Creating a customer bank account follows a set of rules.

  • Customer billing address: The customer billingAddress information is required before you can create a customer bank account.
  • Customer bank account verification: If the customer bank account requires verification, BILL requires up to 2 business days to complete a one-time verification of the bank account.

Note: When you add a customer bank account in the production environment, BILL validates the customer routing number before you can charge the customer. You will get an error message if the customer routing number is invalid in production.

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

Path parameters

customerIdstring required

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

Example:{{customer_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 required

Customer bank account name

nicknamestring

Customer bank account nickname

routingNumberstring required

Customer bank routing number

accountNumberstring required

Customer bank account number

type'CHECKING' | 'SAVINGS' required

Customer bank account type

ownerType'BUSINESS' | 'PERSONAL' required

Customer bank account owner type

Example request

{
  "nameOnAccount": "Check Mailworth",
  "nickname": "Check Mailworth Personal Checking",
  "routingNumber": "021000021",
  "accountNumber": "333222111",
  "type": "CHECKING",
  "ownerType": "PERSONAL"
}

Response

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

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

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