Administrative APIs | REST

Version:
Download Open API Specification

Get Default Plans

https://api.wealthcare.com/system/Services/Tpa/{tpaId}/DefaulBenefitPlan/List

  • tpaId string Required

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

  • verboseMode boolean
  • queryIias boolean

    To see IIAS-specific settings on the plan, set this to True.

  • array <object>
    • AccountTypeCode string

      Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, and so on).

    • ConvenienceFeeAmount number <double>

      Convenience amount charged for each POS transaction. Only used if employee is paying the fee.

    • ConvenienceFeePayor enum<string>

      Determines who will pay the convenience fee.

      Possible values: None Tpa Employer Employee
    • SpendingLimitPeriod enum<string>

      Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.

      Possible values: None Month Year Quarter
    • SpendingDepositAmount number <double>

      Maximum amount to be deposited, during the spending Limit period.

    • SpendingTransactionAmount number <double>

      Maximum amount to be withdrawn, during the spending limit period.

    • MaxTransactionAmount number <double>

      Maximum amount to be exchanged per transaction.

    • MaxTotalAmount number <double>

      Maximum amount to be paid per account on the plan.

    • TpaId string

      Unique identifier for each administrator.

    • IiasSettings enum<string>

      Determines if IIAS are being used.

      Possible values: NotUsed Disabled HealthEligibleTotal Specific
    • IiasOptions enum<string>

      Determines which IIAS options are enabled.

      Possible values: None Rx Vision Dental
    • DefaultDepositCalendarId string

      Calendar ID of the auto deposit calendar.

    • AllowPartialManualTransaction boolean

      Determines if the plan will allow partial manual transactions.

    • HidePlanFromParticipant boolean

      Determines if the plan will be hidden from the participant in WCP/WCM.