Initiate an external account

post

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

Initiates a new external account with status=Unverified and starts the micro-deposit process. See externalAccount object definition for parameter details. [block:callout] { "type": "info", "body": "In the sandbox environment, if you have NACHA enabled, a "magic value" of 123456789 for the routingNumber property may be used for testing purposes. This will set the name to COREPRO SANDBOX BANK. Additionally, all trial deposit amounts in the Sandbox environment will be 0.18 and 0.28, and /externalAccount/verify can be called immediately. However, in production, a request to /externalAccount/verify must be sent at a later date to allow time for the ACH process to happen at the external bank." } [/block]

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