CustomerBankAccount – Developer Support

About CustomerBankAccount

Add the bank account details of a Customer. A Customer can only have one bank account. If the customer wants to change the details or switch to another bank account, you need to delete the current bank account, and create a new bank account.

To allow a direct charge (ChargeCustomer), the customer must agree to the Bill.com Bill Payments Terms of Service. If your organization's UI allows users to charge the customer's bank account, ensure users know about and agree to the Bill.com Bill Payments Terms of Service.

Create

Request

<API_URL_EndPoint>/Crud/Create/CustomerBankAccount.json

data={
  "obj" : {
    "entity" : "CustomerBankAccount",
    "isActive" : "1",
    "customerId" : "0cu01OVCSLTRSAWLh162",
    "nameOnAccount" : "Peter Smith",
    "nickname" : "Business Checking",
    "routingNumber" : "121000358",
    "accountNumber" : "1234567890",
    "isLockedByOrg" : false,
    "isSavings" : false,
    "isPersonalAcct" : false,
    "isWrittenAuth" : true
  },
  "agreedWithTOS" : true
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerBankAccount",
    "id" : "cba01JKUWIGEILPU855q",
    "isActive" : "1",
    "createdTime" : "2016-12-09T21:36:42.000+0000",
    "updatedTime" : "2016-12-09T21:36:42.000+0000",
    "customerId" : "0cu01OVCSLTRSAWLh162",
    "nameOnAccount" : "Peter Smith",
    "nickname" : "Business Checking",
    "routingNumber" : "*****0358",
    "accountNumber" : "******7890",
    "isLockedByOrg" : false,
    "isSavings" : false,
    "isPersonalAcct" : false,
    "isWrittenAuth" : true
  }
}

Read

Request

<API_URL_EndPoint>/Crud/Read/CustomerBankAccount.json

data={
   "id" : "cba01JKUWIGEILPU855q"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerBankAccount",
    "id" : "cba01JKUWIGEILPU855q",
    "isActive" : "1",
    "createdTime" : "2016-12-09T21:36:42.000+0000",
    "updatedTime" : "2016-12-09T21:36:42.000+0000",
    "customerId" : "0cu01OVCSLTRSAWLh162",
    "nameOnAccount" : "Peter Smith",
    "nickname" : "Business Checking",
    "routingNumber" : "*****0358",
    "accountNumber" : "******7890",
    "isLockedByOrg" : false,
    "isSavings" : false,
    "isPersonalAcct" : false,
    "isWrittenAuth" : true
  }
}

Delete

Request

<API_URL_EndPoint>/Crud/Delete/CustomerBankAccount.json

data={
   "id" : "cba01JKUWIGEILPU855q"
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "entity" : "CustomerBankAccount",
    "id" : "cba01JKUWIGEILPU855q",
    "isActive" : "2",
    "createdTime" : "2014-05-15T21:36:42.000+0000",
    "updatedTime" : "2014-05-15T21:36:42.000+0000",
    "customerId" : "0cu01OVCSLTRSAWLh162",
    "nameOnAccount" : "Peter Smith",
    "nickname" : "Business Checking",
    "routingNumber" : "*****0358",
    "accountNumber" : "******7890",
    "isLockedByOrg" : false,
    "isSavings" : false,
    "isPersonalAcct" : false,
    "isWrittenAuth" : true  }
}

Resources

Parameters