Add ACH Account

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/addAchAccount

Use the Add ACH Account endpoint to add an ACH account to the specified customer account. If you are integrated with Plaid, set the RPVIR parameter to 1 to receive plaid_identity_values in the response. Use this endpoint to add external accounts that belong to individuals. For accounts that belong to companies, use the Add ACH Account Corporate endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
423-01	Plaid identity validation failed.
423-02	Plaid failed to retrieve ACH account details.
423-03	Plaid returned an error. Find the error in the status field and handle with Plaid accordingly.

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

The PRN or PAN of the account.
Pattern: PAN or PRN
Example: "074103447228"

name

string | null

The display name of the external account. This field is required unless processorToken is populated.
Pattern: 1–22 supported characters
Example: "Yellowbank account"

type

string | null

enum

Type of the external bank account. Required when processorToken is not populated:

C — Checking
S — Savings
M — Money market

Pattern: String
Example: "C"

Allowed:

achAccountNo

string | null

External bank account number. Required when processorToken is not populated.
Pattern: Up to 22 numerals
Example: "4483434234348"

achRoutingNo

string | null

Routing number for the external bank where achAccountNo is housed. Required when processorToken is not populated.
Pattern: Exactly 9 digits
Example: "124001545"

firstName

string | null

Required. First name(s) of the external account holder. Only the first 9 characters of this field are present in the outgoing Nacha file.
Pattern: 1–40 supported characters
Example: "Maricela Elena"

lastName

string | null

Required. Last name(s) of the external account holder. Only the first 12 characters of this field are present in the outgoing Nacha file.
Pattern: 1–40 supported characters
Example: "Garcia Castro"

location

string | null

≤ 20

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of locationType when the location was created:

0 or 2 — Returned in the location_id field
1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1
Example: "a455-3483"

locationType

int32 | null

enum

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: Integer
Example: 1

Allowed:

processorToken

string | null

Obtained from Plaid if using Plaid integration. When passing this token it is not necessary to pass achAccountNumber, achRoutingNumber, name, or type. If you are not using Plaid, do not send this parameter with an empty or null value.
Pattern: String
Example: "processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"

verifyIdentity

int32

enum

Defaults to 0

If processorToken is populated, pass 1 to call the Plaid identity endpoint for account-holder verification.
Pattern: Integer
Example: 0

Allowed:

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

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

application/json

application/xml

Status codes

default