Initiate an external account

post

https://sandbox-api.helix.q2.com/externalAccount/initiate

Initiate a new external account with status=Unverified and start the micro-deposit process. See externalAccount object definition for parameter details.

🚧WarningSandbox environment only:

Routing number 123456789 sets bank name to COREPRO SANDBOX BANK.

Trial deposit amounts are always 0.18 and 0.28.

/externalAccount/verify can be called immediately.

Production environment only:
A request to /externalAccount/verify must be sent at a later date to allow time for the ACH process to occur at the external bank.

Body Params

customerId

int32

required

≥ 1

routingNumber

string

required

length ≤ 50

accountNumber

string

required

length ≤ 17

firstName

string

required

length ≤ 50

lastName

string

required

length ≤ 50

businessName

string

length ≤ 100

type

string

enum

required

Allowed:

name

string

length ≤ 50

nickName

string

length ≤ 50

tag

string

length ≤ 50

customField1

string

length ≤ 50

customField2

string

length ≤ 50

customField3

string

length ≤ 50

customField4

string

length ≤ 50

customField5

string

length ≤ 50

requestingCustomerId

int32

≥ 1

The Helix-assigned unique ID for the individual customer requesting to create the external account. Only used when an individual is creating an external account on behalf of a business.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An envelope whose data node is an externalAccount object

400Bad Request

401Unauthorized

404Not Found

405HTTP Method Not Allowed

429Rate Limit Exceeded