Administrative APIs | REST

Version:
Download Open API Specification

Get Bank Account List

https://api.wealthcare.com/system/Services/Employer/BankAccount/{tpaId}/List

Use this operation to retrieve information about all bank accounts set up with a specific bank

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • bankName string Required

    Bank Name. The response will return all accounts tied to this bank name.

  • verboseMode boolean Required

    Optional, if set to true, the response may return more details as to why a request was not successful

  • array <object>
    • 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.

    • BankRoutingNumber string

      Bank account routing number.

    • BankSecondRoutingNumber string

      Bank account secondary routing number

    • BankAccountTypeCode enum<string>

      Type of account. 0 - None 1 - Checking 2 - Savings 3 - General Ledger

      Possible values: None Checking Savings GeneralLedger
    • EmailAddress string

      Email addresses separated by semicolon used to provide daily activity emails.

    • IsDailyEmailReceive boolean

      Do you wish to receive daily 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 bank’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.

    • DisplayName string

      Unique display name associated with the account

    • 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

      Person authorizing the account to be debited.

    • AuthorizedPersonTitle string

      Title of person listed in the AuthorizedPersonName 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: AchOnly ReimbursementOnly AchAndReimbursement
    • 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: IndividualSettlement AggregatedSettlement
    • 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: IndividualSettlement AggregatedSettlement
    • 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? Defaults to 0(No) if left blank  1= Yes 0 = No

    • 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>

      Determines who is the owner of the bank account.

      Possible values: None Administrator Employer Third Party (Other)