Use this operation to retrieve information about a specific bank account. The account's display name is used to retrieve the account information.
This operation retrieves detailed information about a specific bank account associated with an employer, identified by the TPA ID and the account's display name. It is typically used when administrators need to verify or update bank account details for ACH transactions or reimbursements.
Request
-
tpaId string Required
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
displayName string
Display name associated with the account.
-
verboseMode boolean
Optional, if set to true, the response may return more details as to why a request was not successful
Response
-
TpaId string
A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
-
BankAccountName string
Name assigned by the administrator during creation. It cannot be updated on subsequent loads. It can be applied to more than one employer by changing the employer ID. Settlement is NOT immediate for each newly linked employer
-
BankAccountNumber string
Bank account number. Required if account usage includes ACH
-
BankRoutingNumber string
Bank account routing number. Required if account usage includes ACH.
-
BankSecondRoutingNumber string
Bank account secondary routing number
-
BankAccountTypeCode enum<string>
Type of account. 0 - None 1 - Checking 2 - Savings 3 - General Ledger
Possible values:NoneCheckingSavingsGeneralLedger -
EmailAddress string
Email addresses separated by semicolon used to provide daily activity emails.
-
IsDailyEmailReceive boolean
Do you wish to receive daily POS account activity via email? 1= Yes 0 = No
-
Address1 string
First line of the bank’s mailing address
-
Address2 string
Second line of the bank’s mailing address
-
City string
City associated with the group’s address.
-
ZipCode string
Up to nine digits Zip Code associated with the bank’s address. Limited to either five(5) or nine(9) characters, numbers only
-
State string
Two letter state abbreviation associated with the bank’s address
-
CountryCode string
US is the only valid option. Contact us if you intend to send to any other international addresses
-
DisplayName string
Unique display name associated with the account.
-
AuthorizedOwnerName string
Authorized owner of the account
-
AuthorizedPersonName string
Person authorizing the account to be debited.
-
AuthorizedPersonTitle string
Title of person listed in the “authorized by” field
-
PhysicalBankAccountUsageCode enum<string>
Purpose of account. 1 - ACH only 2 - Reimbursement only 3 - All (default) 4 - Employer funding 5 - Balance repayment agent 6 - Incentive deposits 7 - Investments tranfer out Note Each employer must be linked to one ACH account that has reimbursement capabilities or no manual claims can be run for the employer (even for validation purposes via EDI). Recommended to choose ACH and Reimbursement
Possible values:AchOnlyReimbursementOnlyAchAndReimbursement -
POSSettlementType enum<string>
Indicates if settlement will be one entry for each transaction (individual) or one entry per day for the net sum of all transactions (aggregate) IndividualSettlement = 0 AggregatedSettlement = 1
Possible values:IndividualSettlementAggregatedSettlement -
ManualSettlementType enum<string>
Indicates if settlement will be one entry for each transaction (individual) or one entry per day for the net sum of all transactions (aggregate) IndividualSettlement = 0 AggregatedSettlement = 1
Possible values:IndividualSettlementAggregatedSettlement -
EmailAddressForManual string
Email addresses separated by semicolon used to provide daily activity emails for manual transactions.
-
IsDailyEmailReceiveForManual boolean
Do you wish to receive daily account activity for manual transactions via email? 1= Yes 0 = No