Administrative APIs | REST

Version:
Download Open API Specification

Update Default Benefit Plan

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

  • tpaId string Required

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

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

    Indicates who will be paying the convenience fee.

    Possible values: None Tpa Employer Employee
  • gracePeriodEndDate string <date-time>

    The plan's run out date.

  • 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 exchanged under the plan while active.

  • planYearStartDate string <date-time>

    Plan's start date.

  • planYearEndDate string <date-time>

    Plan's end date.

  • iiasSettings enum<string>

    Determines if IIAS will be used on the plan.

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

    Determines which IIAS options will be enabled on the plan.

    Possible values: None Rx Vision Dental
  • defaultDepositCalendarId string

    Plan's default auto deposit calendar ID.

  • allowPartialManualTransaction boolean

    Determines if the plan will allow partial manual transactions.

  • hidePlanFromParticipant boolean

    Determines if the plan will be hidden from the participant on WCP or WCM.

  • planDesignId string

    Unique ID for the plan.

  • restrictClaimsProcessing boolean

    Determines if claims processing will be restricted.