Participant APIs | REST

Version:
Download Open API Specification

Get list of the External Bank Accounts

https://api.wealthcare.com/participant/services/participant/hsa/bankaccounts/{tpaId}/{employerId}/{participantId}/{dataPartnerId}

Get list of the External Bank Accounts

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

  • participantId string Required

    Participant Id

  • dataPartnerId string Required

    Data Partner Id

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • array <object>
    • TpaId string

      Unique identifier assigned to the administrator

    • ExtBankAcctKey integer <int64>

      Unique key identifier for external bank account

    • BankAccountName string

      Name associated with the logical bank account Must be unique within the administrator

    • BankAcctNickName string

      Name given to external bank account to easily identify by

    • BankAcctTypeCdeEnumeration integer <int32>

      Defaults to 1 if left blank (None = 0, Checking = 1, Savings = 2, General Ledger = 3)

    • BankAccountNumber string

      Bank account number Required if account usage includes ACH

    • BankRoutingNumber string

      Bank account routing number Required if account usage includes ACH

    • BankAccountStatusCdeEnumeration integer <int32>

      (New = 0, Confirmed = 1, PendingValidation = 2, ValidationRequired = 3, FixAccount = 4)

    • ConfirmDte string <date-time>

      Date the employee provided the microtransaction amounts to confirm the account is valid

    • DataPartnerId string

      Unique identifier for the Product Partner