Administrative APIs | REST

Version:
Download Open API Specification

Get Transaction Details

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

  • tpaId string Required

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

  • settlementDate string <date-time>

    Date the transactions settled on. Used with SettlementSequenceNumber to uniquely identify a transaction. Settlement occurs typically at 3:45 PM CT, so all transactions received that day before that time and all transactions received after 3:45 PM CT the previous day have the same settlement date.

  • settlementSequenceNumber integer <int32>

    WCA assigns a sequence number within the settlement date for every transaction that it receives. Using the settlement date and the settlement sequence number is a way to uniquely identify a transaction within the system.

  • verboseMode boolean

    Optional, if set to true, the method may return more details as to why a query did not return any records.

  • queryIias boolean

    To see IIAS related data on the response, set this field to true.

  • externalClaimNumber string

    External claim number

  • cardProxy string

    Proxy card number for the employee or dependent.

  • TaxYear string

    Provides the tax year for non-HSA transactions that a reimbursement should be applied to. This feature is specific to the pre/post tax plan configuration options.

  • PreTaxAmt number <double>

    Amount that is considered pre-tax for the transaction based on pre/post tax business rules on the plan.

  • PostTaxAmt number <double>

    Portion of the transaction that should be added as taxable income on the employee’s W2. This amount is based on the plan setting in WCA.

  • DisplayDate string <date-time>

    Date for the transaction that is displayed to the employee and employer

  • MerchantPropertyName string

    Name assigned to the merchant ID. Merchant name that shows on transaction.

  • PatientID string

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

  • LinkTxnKey string

    For a linked transction, this will be the unique identifier for the transaction linked to this one

  • TxnKey string

    A unique identifier generated by WCA for the transaction

  • AccountTypeCode string

    Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.) that the transaction was processed against.

  • ApprovalCode string

    Unique code assigned by MasterCard/Visa or the authorization process to identify this transaction.

  • BalanceAfterTransaction number <double>

    The account's available balance after the transaction has processed, less any holds on the account

  • BalanceTimeTransaction number <double>

    The account's original available balance, before the transaction has processed, less any holds on the account before the transaction has processed

  • CardholderPropertyName string

    The name of the cardholder for whom the transaction is for (may be the employee or a dependent). Will be in the format of LastName, FirstName

  • CardNumber string

    Card proxy number

  • DeniedAmount number <double>

    The amount of the claim that was denied by the claims processor.

  • DeniedReason string

    Reason the transaction or part of a transaction was denied

  • DisplayToEmployee boolean

    Indicates if transaction will display on WCP/WCM or returned on the participant APIs. 0 (False) - transaction will not be included/will not be displayed to the participant 1 (True) - transaction will be included/displayed to the participant

  • EmployeePropertyName string

    First and last name of the employee

  • ErrorCode string

    Error code and description indicating why a transaction was not approved. If the transaction was successful, "0 - Approved" will be returned.

  • ExceptionType string

    Type of exception. Value will be None if there was no exception. Valid values are: None/Employee/Terminal/Merchant/Plan Design

  • ExpirationDate string

    Expiration date of the card

  • Fee number <double>

    Indicates if a per transaction fee was paid and amount.

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

    City where the originating terminal resides. Available only when returned from the terminal.

  • MerchantId string

    Unique number assigned by Visa/MasterCard identifying the submitting merchant

  • MerchantState string

    State where the originating terminal resides. Available only when returned from the terminal.

  • MerchantTypeCode string

    Also referred to as Merchant Category Code. Indicates the type of merchant submitting the transaction. The identifier is encoded into the terminal by the issuing bank and transmitted with every transaction. Note: If the transaction was accepted because of a terminal, merchant, or employee exception, the code is considered a converted MTC. The code is designated as MCC for MasterCard and SIC for Visa.

  • Notes string

    Notes on transaction

  • OriginalMerchantTypeCode string

    The Terminal Merchant Type Code that had its MTC code converted. This occurs in the case of allowing specific terminals, merchants and employee exceptions.

  • SequenceNumber integer <int32>

    Sequential number assigned by the settlement system within a Settlement Date.

  • ServiceEndDate string <date-time>

    If the service the transaction is for expanded over multiple days, this is the last day of service

  • ServiceStartDate string <date-time>

    The start date of the service received

  • SettlementDate string

    Date transaction was settled in WCA, also used in conjunction with the Settlement Sequence Number as a unique key for each transaction.

  • StatusDateTime string <date-time>

    The date and time of the most recent adjudication activity

  • TerminalId string

    Terminal ID as known by the network, returned from the originiating terminal.

  • TpaId string

    A unique identifier for your administrator instance, generated by WCA when the instance was first set up.

  • TrackingNumber string

    Tracking Number assigned by the system importing the transaction to WCA

  • TransactionAmount number <double>

    Amount of this transaction. Note: If this amount is less than the amount for the original transaction, this transaction has been split.

  • TransactionDateTime string <date-time>

    The date/time that the transaction was received by WCA (yyyy-mm-ddThh:mm:ss)

  • TransactionType string

    For claims, the SCC description + the Merchant name (Note: a
    tag is included to separate the two fields). For Card transactions, the Merchant Name. For other transactions, the type of transaction

  • UserUpdatingStatus string

    User ID of person who changed the Transaction Status of this transaction

  • TotalAuthorizedAmountOriginal number <double>

    Original Merchant Requested Amount Authorized

  • HetAmountOriginal number <double>

    For an IIAS transaction, this is the Healthcare Eligible Total (HET) requested/provided by the merchant.

  • HetAmount number <double>

    For an IIAS transaction, this is the Healthcare Eligible Total (HET) applied to the account for this transaction.

  • RxAmountOriginal number <double>

    For an IIAS transaction, this field will specify the original prescription amount

  • RxAmount number <double>

    For an IIAS transaction, this field will specify the prescription amount that was approved

  • DentalAmountOriginal number <double>

    For an IIAS transaction, this will be the original dental amount. Will be 0 if not populated.

  • DentalAmount number <double>

    For an IIAS transaction, this will be the dental amount approved. Will be 0 if not populated.

  • VisionAmountOriginal number <double>

    For an IIAS transaction, this will be the original vision amount. Will be 0 if not populated.

  • VisionAmount number <double>

    For an IIAS transaction, this will be the vision amount approved. Will be 0 if not populated.

  • PartialAuthIndicator boolean

    Indicator received from a merchant, indicating if partial authorization is allowed. 0 (False) 1 (True)

  • PartialAuthorized boolean

    Indicates if the transaction was partially authorized 0 (False) 1 (True)

  • TpsErrorCode integer <int32>

    Real time adjudication code

  • OffsetAmount number <double>

    If using offset eligibility, this will be the Offset Amount. This is the amount remaining after offsetting. For completely offset transactions, the amount will be 0.

  • CheckNumber integer <int32>

    If applicable, this will be the check number for the claim that was reimbursed.

  • CheckReissue integer <int32>

    Indicates if a check was reissued for the reimbursement. 0 - check was not reissued 1 - check was reissued

  • ReimbursementDate integer <int32>

    The date a claim was reimbursed. Will be in the format of yyyymmdd if populated; 0 will be populated if there is no reimbursement.

  • DepositSubTypeId string

    Deposit Sub Type ID. No value will be sent if there is not a deposit subtype for the transaction.

  • DeductibleAmount number <double>

    Amount of this claim that was applied to the deductible on this account.

  • BypassDeductibleIndicator boolean

    Indicates if the deductible was bypassed or not 0 (False) – Do not bypass (apply toward deductible as appropriate) 1 (True) – Bypass Deductible (claim not applicable to the deductible and was eligible to be paid) Indicates whether this transaction used deductible rules when it was applied to the account or if it was paid out directly (was not applicable to the deductible).

  • ReduceByBalanceMax boolean

    For rollover deposits, indicates if the amount rolled over was reduced due to the balance of the account meeting or exceeding the maximum balance.

  • FundRolloverType integer <int32>

    0= Non-rollover transaction 1 = Primary Fund Rollover 2 = Secondary Fund Rollover (FUTURE)

  • RolloverDepositsPtd number <double>

    Deposits made Year to Date INTO this account via Fund Rollover. For an Individual/Family HRA plan, this is the Individual Fund information– If a Dependent ID is provided, then this is the Dependent’s individual Fund information.

  • FamilyRolloverDepositsPtd number <double>

    Individual/Family HRA plans only. Deposits made Year to Date INTO this account via Fund Rollover.

  • ServiceCategoryCode string

    The alphanumeric SCC assigned to a manual claim.

  • ServiceCategoryCodeDescription string

    The description for the SCC.

  • ManualClaimNumber string

    A system generated number assigned to a manual claim once that claim is successfully submitted. Consists of YYYYMMDD + INCREMENT, where INCREMENT is a sequential number. For example, if the first claim of the day was submitted on 19 March 2008, then the # would be 200803191. Note; Both the tracking number and Manual claim number appear on the latest version (July, 2008) of the Manual Claim Denial Letter.

  • DocumentTrackingNumbers string

    WCA generated unique number to identify receipt notification or reminder letter documents in which this transaction was shown. Each tracking number is separated by a pipe (|) character.

  • CrossOverClaim boolean

    Indicates if this is a crossover claim, where the payment was automatically deducted from the participant's account 0 (False) 1 (True)

  • FlexAcctId string

    A system generated unique identifier for the benefit account

  • EligDte string

    Date upon which the employee is eligible to elect benefits. This existing field is being updated to validate that it is prior to the termination date.

  • TermDte string

    Date the participant is no longer eligible for the plan type within WealthCare Admin.

  • PendedAmount number <double>

    Pended Amount of Claim

  • PendedReason string

    Reason Code for the Pended Amount

  • PayProviderFlag string

    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.

  • ProviderAddress1 string

    Address line 1 associated with the provider’s mailing address

  • ProviderAddress2 string

    Address line 2 associated with the provider’s mailing address

  • ProviderCity string

    City associated with the provider’s mailing address

  • ProviderState string

    State associated with the provider’s mailing address

  • ProviderZip string

    Zip Code associated with the provider’s mailing address

  • ProviderPhone string

    Phone number associated with the provider

  • ExternalClaimNumber string

    External Claim Number

  • PinNetworkIndicator boolean

    Indicate whether the transaction is a PIN based or signature based transaction. True = PIN Based  False = Signature Based

  • ExcludeFromEmployerFunding boolean

    Indicates if the transaction was included in employer funding calculations 0 (False) - transaction was included in employer funding calculations 1 (True) - transaction was excluded in employer funding calculations

  • Status_2015_02 string

    A code used to provide more detail about the transaction. Refer to the Transaction Status Code table for more information.

  • HSAPostingDate string

    Posting date, for HSA transactions only

  • HSACodeDescription string

    The human-friendly description for the IRS reporting category associated with the HSA account transaction, derived from the transaction type or the product partner HSA Status Code. For HSA transactions only.

  • HSACode integer <int32>

    The numeric code for the IRS reporting category associated with the HSA account transaction, derived from the transaction type or the product partner HSA Status Code. For HSA transactions only.

  • HSATransactionStatus string

    HSA Transaction Status

  • HSAReasonForNonPostDescription string

    When an HSA transaction is in a status of non-post, this field will include a human friendly description indicating why it was a non-post. This field orresponds with HSAReasonForNonPostCode. For HSA transactions only.

  • HSAReasonForNonPostCode integer <int32>

    When an HSA transaction is in a status of non-post, this field will include a numeric code indicating why it was a non-post. This field corresponds with HSAReasonForNonPostDescription. For HSA transactions only.

  • PostingType string

    Indicates the type of transaction Credit/Debit/Both

  • GLAccount string

    The name of the general ledger account used for settlement. For HSA transactions only.

  • HoldAmount number <double>

    The total amount in holds on the account

  • PaymentId string

    Represents the draft # issued by our Integrated Payment vendor.

  • PayoutMethod string

    Represents the payment method used by the participant or our Integrated Payment vendor. Valid methods include Pending, Check, Direct Deposit, External Check, External Direct Deposit, Card, Payroll, ePay-ACH, ePay-Virtual Card, and ePay-eCheck.

  • PaymentClearedDate string

    YYYYMMDD - The date the transaction’s check cleared the source of funds bank account. The payment cleared date may be entered by the administrator via the UI, or using EDI on the (FB) import record.