Administrative APIs | REST

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

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

Unique Identifier to distinguish this plan from others within the administrator.

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

This date matches the corresponding date set for the employer’s benefit plan, as entered in the WealthCare Admin user interface.

This date matches the corresponding date set for the employer’s benefit plan, as entered in the WealthCare Admin user interface.

Date the grace period ends for this account type. After this date, a warning displays when transactions are applied to this account type.

N/A – not utilized by HRX plan types.

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.

Note 1: This field can be set only when the account is created; it cannot be updated.

Note 2: If this field is set to 1 or 2, the field, Spending Deposit Amount, or the field Spending. Transaction Amount, is required. Note 3: Leave this field blank if the plan is an HRA.

Note 4: Setting the Spending Limit is a point-in-time event and affects only transactions after that point-in time. It is not retroactive.

Note5: Setting a spending limit period of Yearly is based off the Calendar Year, not the Plan year as specified in the Plan Start and End Date Fields.

Note 6: If Calendar Year is selected, then spending limits are based on a calendar year. If Spending Limits are added to a plan after the Start Date, the transaction and deposit limits are not retroactive. The limits are not applicable to deposit and transaction amounts existing for a Participant prior to the date that the limits were imposed.

Maximum amount that can be deposited to this account during the spending limit period.

** Required if the field, Spending Limit Period, is set to 1 or 2.

Note 1: Leave blank if the plan is an HRX.

Note 2: If Calendar Year is selected, then spending limits are based on a calendar year. If Spending Limits are added to a plan after the Start Date, the transaction and deposit limits are not retroactive. The limits are not applicable to deposit and transaction amounts existing for a Participant prior to the date that the limits were imposed.

Maximum amount that can be disbursed from this account during the spending limit period. ** Required if the field, Spending Limit Period, is set to 1 or 2.

Note 1: Leave blank if the plan is an HRX.

Note 2: If Calendar Year is selected, then spending limits are based on a calendar year. If Spending Limits are added to a plan after the Start Date, the transaction and deposit limits are not retroactive.The limits are not applicable to deposit and transaction amounts existing for a Participant prior to the date that the limits were imposed.

Previously, manual claims submitted to an account that had insufficient funds to pay the claim in full were denied. If the benefit plan allowed manual claims to be partially paid (to reduce the balance in the account to zero) the system would automatically generate a second claim for the exact amount remaining in the account.

With WCA 5.0.00, claims submitted, which cannot be paid in full, now create a single transaction with the amount that could be approved and the amount that was denied for low funds.

0 = Deny manual transactions if the entire amount is not available. (Default)

1 = Pay what is left in the account toward manual transactions.

Flag to enable or disable auto deposits.

0 = Enables auto deposits and catches up on any that were missed while the flag was set to 1.

1 = Disables any future scheduled auto deposits.

Note: Leave blank if this is an HRA.

Flag to enable or disable auto deposits.

0 = Enables auto deposits and catches up on any that were missed while the flag was set to 1.

1 = Disables any future scheduled auto deposits.

Note: Leave blank if this is an HRA.

Note: Setting this field has no impact. Convenience fee functionality was decommissioned.

Note: Setting this field has no impact. Convenience fee functionality was decommissioned.

Maximum amount allowed per transaction.

Maximum amount allowed for the duration of the plan.

Note: Leave blank for HRA plans.

Determines whether default plan or MCC values are applied to the plan.

0 = None (Default) 1 = Plan 2 = MCC 4 = Life Event Balance Management 8 = Enable Coverage Tiers 16 = Enable Special Deposit 32 = Service Category 64 = Manual Claim Percent Coverage 128 = Enable Deductible 256 = Hide Plan From Participant To use only the WCA default MCCs, enter 0 or 1.

To use the default MCCs for a plan and the default WCA MCCs, enter 3 (1 + 2).

Note 1: This field is recognized only when you first create the plan.

Note 2: You can also create default plans and sets of MCCs through the WCA user interface (UI) on the Administrator tab.

Note 3: Leave blank if this plan is an HRA. You cannot create default plans for HRAs.

Determines whether a plan rolls over to the next plan period.

0 = Do not rollover. (Default)

1 = Rollover. If a prior plan, matching the requirements, is found, the system can be set to copy the attributes of the prior plan to the new plan. Attributes to copy include: MCC codes, TPS settings, Exceptions, and Plan co-pays. If Exceptions are selected to roll, the system rolls only active exceptions.

Attributes or characteristics of the plan to roll over to the next plan period.

Note 1: If the field, Plan Rollover, is set to 1 = Yes and the field, Plan Rollover Attributes, are blank, WCA rolls over MCC codes and TPS settings only.

Note 2: Enter a sum value to roll over multiple attributes. For example, to roll over MCCs and Co-Pay Amounts for Auto Review, enter 68 (4+64)

Type of full-featured HRA.

** This field is required only if the plan is a full-featured HRA. Leave blank for all other plan types.

Determines whether HRA funds can roll over to the next period. 0 = No. Ignores remaining rollover fields. 1 = Yes. Rolls any remaining funds in the current period to pay for services in the next plan period. Note 1: If you specify Yes, you must manually roll over the HRA to the next plan period or create a new HRA with the same ID. Note 2: Leave blank if this plan is not a full-featured HRA.

Determines whether WCA or your software calculates the rollover amount.

Note: Leave blank if this plan is not a full-featured HRA

Fund Rollover Status

Date on which funds roll over from current funds for this plan period to this rollover funds for this plan period.

** This field is required if HRA Fund Roll over is set to 1 = Yes.

Note 1: This date must be within 90 days of the end date for this plan

Note 2: If left blank, funds roll over at the end of the plan period.

Note 3: Leave blank if this plan is not a full-featured HRA

Determines the type of rollover that will occur for the funds remaining in the HRA on the rollover date.

Note 1: When WCA determines the rollover amount, it ensures that the total of the rollover amount and the next period’s election amount do not exceed any lifetime maximum amount or any maximum for 2 adjacent periods.

Note 2: Leave blank if this plan is not a full-featured HRA

Maximum amount of remaining individual funds that can roll over for an individual in an Individual/Family HRA.

Note 1: This field is ignored unless HRA Fund Rollover Type is set to 2 = Cap or 8 = % up to Cap.

Note 2: Leave blank if this plan is not a full-featured HRA

Maximum amount of remaining family funds in an Individual/Family HRA or total remaining funds in a Single Fund HRA that can roll over.

Note 1: This field is ignored unless HRA Fund Rollover Type is set to 2 = Cap or 8 = % up to Cap.

Note 2: Leave blank if this plan is not a full-featured HRA

Percent of remaining individual funds that can roll over for an individual in an Individual/Family HRA. Note 1: This field is ignored unless the field, HRA Fund Rollover Type, is set to 4 = % or 8 = % up to Cap

Note 2: Leave blank if this plan is not a full-featured HRA

Percent of remaining family funds in an Individual/Family HRA or total funds in a Single Fund HRA that can roll over.

Note 1: This field is ignored unless the field, HRA Fund Rollover Type, is set to 4 = % or 8 = % up to Cap

Note 2: Leave blank if this plan is not a full-featured HRA

Maximum amount of individual funds in an Individual/Family HRA that can accumulate to pay for services received during the most current plan period.

Note 1: The rollover amount is calculated as follows: Lifetime Maximum, less the next plan’s Individual amount, less the sum of prior available rollover amounts = Individual Rollover Amount. This amount might be further restricted by a specified cap or % limitation.

Note 2: Leave blank if this plan is not a full-featured HRA

Maximum amount of individual funds in an Individual/Family HRA that can accumulate to pay for services received during the most current plan period.

Note 1: The rollover amount is calculated as follows: Lifetime Maximum, less the next plan’s Individual amount, less the sum of prior available rollover amounts = Individual Rollover Amount. This amount might be further restricted by a specified cap or % limitation.

Note 2: Leave blank if this plan is not a full-featured HRA

Maximum amount of individual funds in an Individual/Family HRA that can accumulate to pay for services received during the most current plan period.

Note 1: The rollover amount is calculated as follows: Lifetime Maximum, less the next plan’s Individual amount, less the sum of prior available rollover amounts = Individual Rollover Amount. This amount might be further restricted by a specified cap or % limitation.

Note 2: Leave blank if this plan is not a full-featured HRA

Amount of family funds in an Individual/Family HRA or total funds in a Single Fund HRA that can roll over; the sum of the funds for the next plan period and the rollover amount cannot exceed the Family Max or the Single Fund Max for Adjacent Plans.

Note: Leave blank if this plan is not a full-featured HRA

Dates of service that can be covered by the rollover funds.

1 = Yes. Rollover funds are available for services received in the plan period of origin and in the most current plan period.

Note 1: Rollover funds always remain with the plan period of origin. Although there can be up to 5 reachback periods, WCA can access only the 2 most recent periods for Card transactions. 0 = No. Rollover funds are available only for services received in the most current plan period.

Note 2: Rollover funds are maintained in the N-1 plan period.

Note 3: Leave blank if this plan is not a full-featured HRA.

Number of plan periods available for manual and Card transactions. Funds in the specified periods are included in the calculation for the value in the Lifetime Maximum field.

If the field, Continue to use rolled funds for dates of service in the plan period of origin, is set to 1 = Yes, you must enter one of these values for the number of plan periods: 1, 2, 3, 4, or 5.

Rollover funds for each period selected can be used for services received within that period and for services received in the current plan period.

Example: If you enter 2, then rollover funds from the N-1 plan period are available for services received in the N1 period and rollover funds from the N-2 plan period are available for services received in the N-2 period. In addition, the rollover funds are available for services received in the N period.

Note 1: Even if you enter more than two reach-back periods, WCA can access only two reach-back periods for Card transactions.

Note 2: Rollover funds stay with their respective plan periods. Any constraints for a plan in a specific period continue to apply to the usage of the Rollover Funds for that period. If the field, Continue to use rolled funds for dates of service in the plan period of origin, is set to 2 = No, you can enter one of these values: 1 = Rollover funds from the previous period can be used only for services received in the current period. Any rollover funds beyond the N-1 plan period are not available for services received in the current plan period. 5 (Unlimited) = Funds in the N-2 plan period are added to funds rolled over for the N-1 plan period and are available only for services received during the most current plan period.

Note 3: For these two options, all rollover funds for each period accumulate in a single rollover bucket maintained in the N-1 plan period. Any constraints in the N-1 Plan Period apply to the usage of these Rollover Funds.

Note 4: Leave this field blank if this plan is not a full-featured HRA.

The priority type for fund rollover

Determines the type of rollover that occurs for the funds remaining in the HRA on the rollover date. The choices are All Funds, Cap, %, or % up to a Cap. Note: When WCA determines the rollover amount, it ensures that the total of the rollover amount and the next or period's election amount do not exceed any lifetime maximum.

If the plan option field allows other (special) deposits, then data entered in the ‘other (special) deposit subtypes allowed field’ will be captured and processed.

If the plan options field DOES NOT allow other (special) deposits, then data entered in the ‘other (special) deposit subtypes allowed’ field will be ignored.

The other (special) deposit subtypes allowed field will be used to provide a list of other deposit sub type ids that are mapped to a plan. These sub types allow special deposit transactions to be made to a plan. These identifiers can be either separated by symbol or : (delimiters)

Use this field to indicate whether or not the plan will allow auto pay provider reimbursements.

1. = No (Default)=Yes

This field will specify a default account setting for participants enrolled in a plan using auto provider pay.

1. = No (Default)
2. = Yes Note: This field is required when setting the plan to “Auto Provider Pay” = 1 (Yes).

Use this field to indicate whether or not the plan will reimburse amounts applied to the deductible tracking plan type (DTR). If the account is setup to reimburse amounts applied to the DTR plan, the DTR plan must be a higher priority plan and the claim must be submitted using Service Category Codes (SCCs) to make sure the manual claim splits properly. False = No, the plan will not allow reimbursement of the deductible applied amounts (Default). True = Yes, the plan will allow reimbursement of the deductible applied amounts. Note: This option can be set only to Non Deductible Plan Types. If it is set for Deductible Plan Types, the option is just ignored rather than throwing the error.

Substantiation on the plan True – Enables Merchant Substantiation on the plan False – Disabled Merchant