API Reference
  1. PCE Boarding APIs
  2. Business Bank Accounts

Add a bank account

post
https://sandbox-api.prioritycommerce.com/v1/businesses//bank-accounts

Adds a bank account to a business. Use purposes to say whether the account receives settlement funds (funding), pays fees (billing), or both.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

Body Params

The bank account to add.

string
length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

purposes
array of strings

What the account is used for: funding receives settlement funds from card sales, billing pays fees, and settlement is used when no purpose is given. An account can have more than one purpose.

purposes
Allowed:
string
enum
required

Type of account: checking or savings.

Allowed:
string
required
^\d{4,17}$

The bank account number, digits only, 4 to 17 digits. It is stored securely and only the last four digits are returned.

string
required
^\d{9}$

The nine-digit ABA routing number of the bank.

string
required
length ≤ 255

Name of the bank, up to 255 characters.

string
^[A-Z]{2}$

Country of the bank, as a two-letter ISO 3166-1 code. Defaults to US.

boolean

Set to true for the main record of this kind.

Headers
string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

Updated about 19 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 19 hours ago

Did this page help you?
.readme-logo { display: none !important; }