Add Employer Funding Bank Account
Use this operation to add an employer funding bank account.
-
tpaId string Required
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
accountName string Required
Name assigned by administrator during creation. It cannot be updated on subsequent loads. It can be applied to more than one employer by making a separate request for each employer ID. Settlement is NOT immediate for each newly linked employer.
Min Length: 0 Max Length: 50 -
bankAccountNumber string Required
Bank account number. Required if account usage includes ACH.
Min Length: 0 Max Length: 17 -
bankRoutingNumber string Required
Bank account routing number. Required if account usage includes ACH.
Min Length: 0 Max Length: 9 -
bankSecondRoutingNumber string
Bank account secondary routing number
Min Length: 0 Max Length: 9 -
bankAccountType enum<string>
Type of account. Defaults to Checking if left blank
Possible values:Checking
Savings
General Ledger
-
financialInstitutionName string
Name of the bank or financial instituation which hosts this account.
-
fiAddress1 string
First line of the bank’s mailing address
Min Length: 0 Max Length: 55 -
fiAddress2 string
Second line of the bank’s mailing address
Min Length: 0 Max Length: 55 -
fiCity string
City associated with the bank’s address
Min Length: 0 Max Length: 30 -
fiZipCode string
Up to nine digits Zip Code associated with the bank’s address. Limited to either five(5) or nine(9) characters Numbers only.
Min Length: 0 Max Length: 15 -
fiState string
Two letter state abbreviation associated with the bank’s address
-
fiCountryCode string
“US” is the only valid option. Contact us if you intend to send to any other international addresses.
Min Length: 0 Max Length: 3 -
authorizedOwnerName string
Authorized owner of the account
Min Length: 0 Max Length: 50 -
authorizedPersonName string
Title of person listed in the “authorized by” field.
Min Length: 0 Max Length: 50 -
authorizedPersonTitle string
Financial Institution Authorized Person Title
-
ErrorCode integer <int32>
A numeric code indicating the processing result of the request. 000000 indicates a success. Note: Ask Alegeus for a copy of error codes.
-
ErrorDescription string
Human friendly description corresponding to ErrorCode to indicate either a success or why the request was not successfully processed.