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 for the employee.

Employee’s social security number. Required if this field is being used as the unique employee Identifier - either this field or EmployeeID may be used for this purpose.

Unique identifier for dependent.

Social Security Number of Dependent.

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.). This is the account type displayed in the participant claim. Participant must be enrolled in the account. If the account does not exist for the participant, an error will be returned.

The plan ID for the plan which the employee is enrolled. Either this or ServiceCategoryCode must be included on the request.

Start date of the plan.  Condintionally required if service category code is not given.

End date of the plan.  Condintionally required if service category code is not given.

Service category code to be used for claim processing. This is required if PlanID is not included. If an SCC is sent that is not associated with a plan the participant is enrolled in, the request will return with an error.

The service start date of the participant claim.

The service end date of the participant claim.

The method used to reimburse the employee or dependent for this transaction: 0 - None (default), 1 - Check, 2 - Direct deposit, 3 - External check, 4 - External direct deposit, 5 - Card, 6 - Payroll Note: If reimbursement method is 2 (direct deposit) and the direct deposit account has not yet been validated, the reimbursement defaults to check as a one-time override (if check reimbursement is available). If check reimbursement is not available, the claim is denied.

Indicates whether the transaction was reimbursed to a provider or directly to the participant. 0/False = Reimbursement should go to participant 1/True = Reimbursement should go to provider. Provider ID must be included.

Identifier for the Provider, as entered into WCA when the provider was created. Required if PayProviderFlag is true.

The provider's patient identification number, to be used for provider payments.

The provider's patient account number

The external claim number is used to process claim reversals. If a manual claim is received with an external claim number that matches another manual claim with the same external claim number, WCA will process a claim reversal. The reversal will either credit back the benefit account, or add to the balance due, depending upon if the original manual claim has been reimbursed in WCA. Note: Using external claim number to generate claim reversals will only work if the administrator is linked to the "auto claim reversal creation" feature on the admin options page within WCA.

Dollar amount of claim requested. Valid dollar amount must be entered. Claim amount should be greater than or equal to $0.01 and less than $999,999,999.99. Returns an error if invalid amount is entered.

The date the claim was received by the carrier (not the date the claim is adjudicated)

Any details or comments relevant to the transaction

Used to set this claim up as a recurring claim. Options are:0 = None (default),256 = Once,2 = Weekly,8 = Monthly

Required if recurrence is any value other than ‘ none’. Current or future date allowed. Up to 18 months in the future.

If recurrence is any value other than "none," either RecurrenceEndDte or TotalNoOfPayments is required. Indicates the date at which no more recurrences will be created. Can only extend 18 months from recurrence start

If recurrence is any value other than none, either RecurrenceEndDte or TotalNoOfPayments is required. Number of recurring payments. Monthly - Up to 18 payments,Weekly - Up to 75 payments

Number you assign to track claims. Note: WCA does not use this number.

Error returned from the claim submission if returned as 0 is successful.

The unique identifier for the claim.

Number you assign to track claims. Note: WCA does not use this number.

The amount on the claim.

The Account type code the claim processed against.