Administrative APIs | REST

Version:
Download Open API Specification

Get Employer Logical Bank Accounts

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

Use this to get a list of logical accounts under an employer.

  • tpaId string Required

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

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • verboseMode boolean

    Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

  • array <object>
    • BankAcctStatusCde_2022_02 enum<string>
      Possible values: New Active TempInactive PermInactive PendingValidation ValidationRequired FixAccount
    • BankAccountStatusCode enum<string>
      Possible values: New Active TempInactive PermInactive
    • ReimbSchOverName1 string
    • ReimbSchOverName2 string
    • EnableInvoicingOptions boolean
    • SuppressNACHA boolean
    • FundNotClearedAlert boolean
    • TrackInvoiceDueDate boolean
    • InvoiceDueDays integer <int32>
    • DivisionName string
    • BillingGroup string
    • AccountSegmentId string
    • EnableEmployerHSAFundingManagement boolean
    • EnableReminderCommunication boolean
    • ReminderNotificationToEmail string
    • ReminderNotificationCCEmail string
    • ReminderNotificationBCCEmail string
    • ReminderNotificationTemplateName string
    • ReminderNotificationSendDaysPrior integer <int32>
    • FundingNotificationTemplate string
    • FundingNotificationDaysPrior integer <int32>
    • HSAFundingOption enum<string>
      Possible values: None AutomatedSettlement NachaFiles
    • CheckFileExportTemplate string
    • CheckPrintingTemplate string
    • DirectDepositFileExportTemplate string
    • ReimbursementSignature string
    • ReimbursementComment string
    • TpaId string
    • EmployerId string
    • BankAccountDisplayName string
    • AvailableBalance number <double>
    • InActivateEmployerIfBalanceDropsBelowZero boolean
    • DefaultAccount boolean
    • DisbPtd number <double>
    • PreAuthBal number <double>
    • ConvenienceFeesPaid boolean
    • MinBalanceReceiveAlert number <double>
    • NextCheckNumber integer <int32>
    • PhysicalBankAccountName string
    • ReceiveAccountActivityViaEmailAddress string
    • ReceiveAccountActivityViaEmail boolean
    • TypeOfClaimsAffected enum<string>
      Possible values: POS Manual All
    • PlanType string
    • UseEmployerAccountCheckNumber boolean
    • ZeroBalanceAccount boolean
    • EnableEmployerFunding boolean
    • FundingTemplateName string
    • EmployerFundingMethod enum<string>
      Possible values: None ClaimActivityFunding OnDemand HSA Payroll
    • FundingBankAcctName string
    • FundingNotificationToAddress' string
    • FundingNotificationCCAddress' string
    • FundingNotificationBCCAddress' string
    • FundingNotificationSubject' string
    • ProcessLogicalDeposits integer <int32>
    • PhysicalBankAccountNameDd string
    • BeginningDate string