Administrative APIs | REST

Version:
Download Open API Specification

Submit Manual Claim

https://api.wealthcare.com/system/Services/Transaction/{tpaId}/{employerId}/ManualClaim

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

  • MerchantName string

    Enter the name of the merchant as shown on the claim/receipt. UPDATE: This field is only able to accept the first 22 characters at this time due to a Mastercard/system limitation. Data truncates to only include first 22 characters from the left (right truncated).

    Min Length: 0
    Max Length: 22
  • ReimbursementMode enum<string>
    Possible values: None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card
  • ClaimReceivedDate string

    The date the claim was received by the administrator

  • HideFromReports boolean

    0 (False) - Display transaction in reports 1 (True) – Hide transaction from reports

  • AccountTypeCode string

    Enter the account from which the claim is to be deducted from. FSA, DCA, etc

  • ApprovedClaimAmount number <double>

    Amount of claim/transaction.

  • CardholderId string

    Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Cardholder SSN may be used for this purpose.

  • CardholderSocialSecurityNumber string

    Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Cardholder ID may be used for this purpose.

  • CardNumber string

    Benefit card number. You must provide either the Card Number or Cardholder Social Security Number or Cardholder ID; all are not required. If either or both of the cardholder identifiers (SSN or ID) are provided in addition to card number, card number is used.

  • DateOfServiceFrom string <date-time>

    Beginning Date of Services for the transaction. The actual date that the cardholder had the service provided.

  • DateOfServiceTo string <date-time>

    Ending Date of Services for the transaction. The actual date that the cardholder had the service provided.

  • PlanYearStartDate string <date-time>

    Plan year start date for the plan that the account making the claim is under.

  • PlanYearEndDate string <date-time>

    Plan year end date for the plan that the account making the claim is under.

  • DeniedClaimAmount number <double>

    Amount, if any, that is not approved. Approved Claim Amount + Denied portion of Claim = Total Claim

  • DeniedReasonCode string

    Code set at the administrator level in system for EOB.

  • DisplayDate string <date-time>

    Date displayed to the employer/employee. Default to Today’s date unless date is listed.

  • DisplayToCardholder boolean

    0 (False) = No 1 (True) = Yes Defaults to true (Yes).

  • EmployerId string

    First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.

    Min Length: 0
    Max Length: 18
  • MerchantId string

    Enter the merchant’s identification number

    Min Length: 0
    Max Length: 11
  • MerchantTypeCode string

    Required if Plan has maximum amounts on individual MTC codes. If required, value must be greater than 0. The value does not need to match any existing MTC.

    Min Length: 0
    Max Length: 4
  • Note string

    Specific note to tie to this transaction.

    Min Length: 0
    Max Length: 255
  • TpaId string

    A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.

  • TrackingNumber string

    Assigned by the administrator, needed to track export of claim back into the administrator’s system. Tracking number are used in the result file to uniquely identify whether this transaction was processed or not.

  • PlanId string

    Plan ID for the plan that the benefit account is under.

    Min Length: 0
    Max Length: 18
  • CheckEligibility boolean

    Determines if the participant's eligibility will be checked. 0 (False) 1 (True)

  • AllowOnhold boolean

    Determines if an on hold transaction will be allowed. If the manual claim is for more than the disbursable balance, then an on-hold transaction is created for the remaining dollar amount. 0 (False) 1 (True)

  • EligibleForPosOffset boolean

    Determines if the claim will be eligible for POS offset.0 (False) 1 (True) If set to True, and the Employer is setup for Ineligible POS offsetting, then the manual transaction would apply to the balance due, if there is any.

  • OverrideSuspendActivity boolean

    Determines if Suspend Activity status will be overridden. 0 (False) 1 (True) Set to true if overriding a qualified live event that is in Suspended status.

  • IsBypassDeductible boolean

    Determines if the claim amount is subject to the deductible. 0 (False) 1 (True) False – apply claim to the deductible where applicable. This is the default behavior. True – bypass the deductible and attempt to reimburse claim regardless of whether the deductible has been met.Field ignored if plan not enabled for deductible management.

  • CheckAcctEligibility boolean

    Determines if the account's eligibility dates will be enforced. 0 (False) 1 (True) True -  The Service Start Date and Service End Dates must be within the Employee and/or Dependent’s eligibility and termination dates. False – WCA does not enforce Participant Eligibility Dates.

  • ScCde string

    Service Category Code (SCC).

  • CheckGenerateDenialLetter boolean

    Determines if Manual Claim Denial Letter will be generated. 0 (False) – Do not generate Manual Claim Denial Letter 1 (True) – Generate Manual Claim Denial Letter

  • CrossOverClaim boolean

    Determines if this is a crossover claim. 0 (False) 1 (True)

  • PendedClaimAmount number <double>

    The amount of the claim that is pended by the administrator.  This amount will not be approved for payment and will be reflected as “Pended Amount” in the system and in claim letters generated by WCA. If using the Manual Claim Letter in WCA, a pending letter will be generated and sent to the participant.

  • PendedReasonCode string

    Reason Code associated with Pended Amount (these codes are set up by the admin).

  • FlexAcctId string

    Employee's flex account ID that the transaction is occurring on.

  • PayProviderFlag boolean

    Determines if the claim amount is paid to the provider. 0 (False) – Claim amount is reimbursed to the participant 1 (True) – Claim amount is paid to provider

  • PatientID string

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

    Min Length: 0
    Max Length: 20
  • DependentId string

    Dependent's ID in WCA. Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Dependent SSN may be used for this purpose. If this was not a dependent transaction, this field can be ignored.

  • DependentSocialSecurityNumber string

    Dependent's social security number. Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Dependent ID may be used for this purpose.  If this was not a dependent transaction, this field can be ignored.

  • IsProxyCard boolean

    Determines if the card proxy number was provided in the CardNumber field. 0 (False) – Card Number provided in Card Number field 1 (True) – Card Proxy Number provided in Card Number Field

  • ExternalClaimNumber string

    External Claim Number added to transactions to facilitate and track overpayments. This is something the admin creates.

  • ExcludeFromEmployerFunding boolean

    Allows administrators to exclude the transactions from WCA Employer Funding calculations. 0 (False) – Include in Employer Funding (Default) 1 (True) – Exclude from Employer Funding

  • RecurrenceFrequency integer <int32>

    Determines if the claim will be a recurring claim, and what the recurrence is. 0 – None (Default), 1 - Once, 2 - Weekly, 3 - Monthly

  • RecurrenceStartDate string <date-time>

    The start date for the first recurrence of the claim.  Required if Recurrence value is not set to 0 = None. Start Date must be greater than or equal to today’s date and cannot be more than 18 months in the future.

  • RecurrenceEndDate string <date-time>

    The end date for the recurrence.  If specified, no claims will be created after this date.  If Recurrence value is not set to 0 = None, then either Recurrence End or Total Number of Payments is required. End Date must be greater than or equal to today’s date and cannot be more than 18 months after the Start Date.

  • TotalNumberOfPayments integer <int32>

    Number of Payments to be made.  If Recurrence value is not set to 0 = None, then either Recurrence End or Total Number of Payments is required. Note 1: For Weekly Recurring Frequency, Total Number Of Payments cannot be more than 75. Note 2: For Monthly Recurring Frequency, Total Number Of Payments cannot be more than 18.

  • ReimbursementMode enum<string>
    Possible values: None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card
  • PayProviderFlag string

    Indicates if the transaction was submitted for pay provider.

  • TrackingNumber string

    The Tracking Number that was used on the SubmitManualClaim.

  • TxnAmtOrig number <double>

    The original transaction amount.

  • ErrorCode integer <int32>

    Error code that the claim received.

  • TxnResponseList array <object>
    • AcctTypeCde string

      The type of account the claim was deducted from. FSA, DCA, etc

    • DisbBal number <double>

      The disbursable balance on the account.

    • TxnAmt number <double>

      The transaction amount that processed over the associated account.

  • TxnApprovedAmt number <double>

    The approved amount of the transaction.