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
Bank Account Name
Min Length: 0 Max Length: 50 -
bankAccountNumber string Required
Bank account number
Min Length: 0 Max Length: 17 -
bankRoutingNumber string Required
Bank routing number
Min Length: 0 Max Length: 9 -
bankSecondRoutingNumber string
Bank Secondary Routing Number
Min Length: 0 Max Length: 9 -
bankAccountType enum<string>
Bank Account Type: Either Checking or Savings
Possible values:Checking
Savings
-
financialInstitutionName string
Financial Institution Name
-
fiAddress1 string
Financial Institution Address 1
Min Length: 0 Max Length: 55 -
fiAddress2 string
Financial Institution Address 2
Min Length: 0 Max Length: 55 -
fiCity string
Financial Institution City
Min Length: 0 Max Length: 30 -
fiZipCode string
Financial Institution Zip Code
Min Length: 0 Max Length: 15 -
fiState string
Financial Institution State
-
fiCountryCode string
Financial Institution Country Code: Must be US
Min Length: 0 Max Length: 3 -
accountOwnerName string
Name of the account owner. Only required when the Account Owner Type is set to Third Party (Other). For Administrator/Employer Account Owner Types the Administrator’s or Employer’s name should autofill for this field.
Min Length: 0 Max Length: 50 -
authorizedPersonName string
Financial Institution Authorized Person Name
Min Length: 0 Max Length: 50 -
authorizedPersonTitle string
Financial Institution Authorized Person Title
-
accountOwnerTaxId string
Tax ID of the account owner. A value is conditionally required if the account owner does not have a Tax ID or if the Account Owner Type is set to Third Party (Other).
Min Length: 0 Max Length: 9 -
accountOwnerType enum<string> Required
Determines who is the owner of the bank account.
Possible values:None
Administrator
Employer
Third Party (Other)
-
ErrorCode integer <int32>
A numeric code indicating the processing result of the request. 000000 indicates a success. A list of error codes is available in Online Resources.
-
ErrorDescription string
Human friendly description corresponding to ErrorCode to indicate either a success or why the request was not successfully processed.