Administrative APIs | REST

Version:
Download Open API Specification

Get Recent Transactions

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

This is used to retrieve a listing of up to the ten most recent transactions for a specific employee or dependent.

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

  • employeeSocialSecurityNumber string

    Required if this field is being used as the unique employee identifier and EmployeeID is not provided. Either this field or EmployeeID may be used for this purpose.

  • dependentID string

    Identifies Dependent; requires either EmployeeID or EmployeeSocialSecurityNumber

  • dependentSocialSecurityNumber string

    Identifies Dependent; requires either EmployeeID or EmployeeSocialSecurityNumber

  • cardProxy string

    0 (False) Card Number is returned in Response. 1 (True) Card Proxy Number is returned in Response.

  • cardNumber string

    Identifies Employee or Dependent

  • transactionStatus enum<string>

    Filters transaction results to transactions with a specific Transaction Status. If ‘All’ is specified, then no filtering occurs. This field will be ignored if HSATransactionStatus is selected in request Status of transaction.1 = Approved, 2 = Ineligible, 3 = Pending, 4 = ResolvedEmployeePay, 5 = ResolvedPayrollDeduction, 6 = New, 7 = Denied, 8 = Unknown, 9 = ResolvedNoRefund, 13 = Insufficient Documentation

    Possible values: Approved Ineligible Pending ResolvedEmployeePay ResolvedPayrollDeduction New Denied Unknown ResolvedNoRefund IneligiblePartiallyOffset ResolvedOffsetbyManualClaim UnauthorizedRefund InsufficientDocumentation Overpayment NonPost Returned Resubmitted All
  • transactionType enum<string>
    Possible values: Deposit POS Manual OtherDeposit All
  • wchsaTransactions enum<string>

    Limits return to HSA Transactions 0 – Include 1 - Only 2 - Exclude

    Possible values: Include Only Exclude
  • hsaTransactionStatus enum<string>

    Filters transaction results to specific WC HSA Transactions.  If HSATransactionStatu s is provided in request, then TransactionStatus value is ignored and non WC HSA transactions will not be returned in response. This filter must only impact transaction associated with a WC HSA account.   If HSATransactionStatu s is empty, then TransactionStatus will be used for filtering the transactions and returns non-WC HSA and WC HSA transactions.

    Possible values: Processing Posted WCHSAAccountImpacting
  • accountTypeCode string

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

  • planID string

    Filters transaction results to transactions associated with a specific Plan ID. Unique identifier that distinguishes this plan from all others you administer.

  • accountTypeEndDate string <date-time>

    (YYYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.

  • accountTypeStartDate string <date-time>

    (YYYYMMDD)Date that funds are available for services.

  • numberofRecentTransactions string Required

    Must be an integer between 1 and 10. Will return this number of transactions.

  • queryIias boolean

    0 (False) No, do not query IIAS 1 (True) Yes, query IIAS

  • verboseMode boolean

    0 (False) 1 (True) Optional, if set to true, the method may return more details as to why a query did not return any records.

  • EmployeeId string

    Unique identifier for the employee.

  • array <object>
    • LinkTxnKey string

      The transaction key of the transaction that this transaction is linked to. Linking occurs in situations where multiple transactions are needed to facilitate money transfer such as a card Authorization and card Post.

    • TxnKey string

      Unique identifier of a transaction.

    • AccountTypeCode string

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

    • AccountTypeEndDate string

      (YYYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.

    • AccountTypeStartDate string

      (YYYYMMDD)Date that funds are available for services.

    • CardNumber string

      Employee or dependent card number/proxy number if POS transaction

    • CardholderId string

      Unique Employee/Dependent Identifier

    • CardholderSocialSecurityNumber string

      Employee or depedent social security number

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

    • DisplayDate string <date-time>

      Date displayed to the employer/employee.

    • DisplayToCardholder boolean

      0 (False) 1 (True) Indicates if transaction will display on WCP

    • EmpeAvailBal number <double>

      Available Balance is the Disbursable Balance plus the Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period's balance. Note: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.

    • EmpeDisbBal number <double>

      Disbursable Balance = Available Balance minus Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period's balance. Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.

    • EmpeDisbPtd number <double>

      The disbursable balance paid to date.

    • EmpePreauthBal number <double>

      Employee's pre-auth balance. Transactions that don't have a matching Force-post transaction from a merchant.

    • MerchantName string

      Merchant Name

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

    • Note string

      Specific note to tie to this transaction.

    • SequenceNumber integer <int32>

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

    • SettlementDate string

      Date that the transactions was settled on. 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.

    • StatusCode string

      Refer to transaction status table below. Example AAA1

    • TrackingNumber string

      You can assign and use a number to identify specific claims. Note: WCA does not use this number.

    • TransactionAdjudicationStatus enum<string> Required

      Status of transaction. 1 = Approved, 2 = Ineligible, 3 = Pending, 4 = ResolvedEmployeePay, 5 = ResolvedPayrollDeduction, 6 = New, 7 = Denied, 8 = Unknown, 9 = ResolvedNoRefund, 13 = Insufficient Documentation

      Possible values: Approved Ineligible Pending ResolvedEmployeePay ResolvedPayrollDeduction New Denied Unknown ResolvedNoRefund IneligiblePartiallyOffset ResolvedOffsetbyManualClaim InsufficientDocumentation EnteredNotReviewed Reversed ClaimReversal Overpayment OverpaymentPartiallyResolved OverpaymentResolved NonPost Returned Resubmitted Processing Posted
    • TransactionAmount number <double>

      Transaction amount

    • TransactionDate string <date-time>

      Transaction date

    • TransactionDeniedAmount number <double>

      Transaction denied amount

    • TxnAdjudDesc string

      Transaction adjudication description

    • TransactionCode string

      Transaction Code 0 = Unassigned, 11 = Purchase, 12 = PreAuth, 13 = ForcePost, 14 = Refund, 20 = EmployerDeposit, 21 = PrefundedDeposit, 22= AutoDeposit, 23 = Adjustment, 24 = Void, 25 = PrefundedDepositReset, 26 = BalanceSyncAdjustment, 27 = IndividualAmt, 28 = IndividualAmtReset, 29 = HsaImported, 30 = OtherDeposit, 31 = RolloverDeposit, 32 = FamilyRolloverDeposit, 33 = FamilyOther Deposit

    • DentalAmount number <double>

      The Dental amount applied to the account for this transaction.

    • DentalAmountOriginal number <double>

      The Dental amount requested/provided by the merchant.

    • ErrorCode string

      Transaction error code

    • HetAmount number <double>

      The HET amount applied to the account for this transaction. Note: If an administrator has selected the OTC amount on which to authorize IIAS transactions, the HET amount authorized field will be populated as well. This is because IIAS merchants do not transmit an OTC amount (OTC is a calculated amount done in WealthCare Admin) and Alegeus simply returns the OTC amount authorized back to the IIAS merchant in the HET amount authorized field

    • HetAmountOriginal number <double>

      The Healthcare Eligible Total (HET) requested/provided by the merchant.

    • PartialAuthIndicator boolean

      0 (False) 1 (True) True or false depending on whether the merchant allows a partial authorization.

    • PartialAuthorized boolean

      0 (False) 1 (True) Returns true or false depending on whether a partial authorization took place.

    • RxAmount number <double>

      The Rx amount applied to the account for this transaction.

    • RxAmountOriginal number <double>

      The Prescription Drug (Rx) amount requested/provided by the merchant.

    • TotalAuthorizedAmountOriginal number <double>

      Total amount of this transaction. Note: If this amount is more than the amount in the Transaction Amount field, this transaction has been split.

    • TpsErrorCode integer <int32>

      TPS error code

    • VisionAmount number <double>

      The Vision amount applied to the account for this transaction.

    • VisionAmountOriginal number <double>

      The Vision amount requested/provided by the merchant.

    • BypassDeductibleIndicator boolean

      0 (False) 1 (True) Indicates if transaction bypassed deductible (if applicable)

    • DeductibleAmount number <double>

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

    • DepositSubTypeId string

      If using other (Other) Deposits feature and the transaction is an Other (Special) Deposit this field is populated with the sub-type deposit ID.

    • EligibleAmt number <double>

      WealthCare Admin calculated as the Administrator submitted Approved Amount less the WealthCare Admin determined Excluded Amount, This value is the amount of the claim that is eligible for payment and shown on the Transaction History screen.

    • FamilyRolloverDepositsPtd number <double>

      Family rollover deposits paid to date

    • FundRolloverType integer <int32>

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

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

    • ReduceByBalanceMax boolean

      0 (False) = All funds rolled according to fund rollover rules 1 (True) = Target Plan Fund Rollover amount reduced by balance Max This field applies only to fund rollover deposits.

    • RolloverDepositsPtd number <double>

      Rollover deposits paid to date

    • ServiceCategoryCode string

      The alphanumeric SCC assigned to a manual claim.

    • ServiceCategoryCodeDescription string

      The description for the SCC.

    • TransactionDesc string

      If using other (Special) Deposits feature and the transaction is an Other (Special) Deposit this field is populated with the deposit description. Add deposits done via the auto-deposit (can use existing fields). Auto Deposit (22). Origination is 50, 51,52

    • EligDte string

      Eligibility date

    • ExcludedAmount number <double>

      On a manual claim only, amount the system has deemed ineligible based on pre-configured business rules set up in the system by the administrator (example: amount excluded due to participant ineligible on service dates)

    • ExcludedErrorCode integer <int32>

      Excluded amount error code

    • ExcludedErrorDescription string

      Excluded amount error description

    • FlexAcctId string

      A unique identifier for the employee's account, generated by WCA when the account was first set up.

    • LowFundAmount number <double>

      Both manual and POS claims. The amount in excess of the account balance at the time of the Transaction. Low Funds Amount = Original transaction amount - denied amount – excluded amount – amount applied to deductible – ineligible offset amount.

    • TermDte string

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

    • TransactionPendedAmount number <double>

      Transaction pended amount

    • PayProviderFlag string

      Indicates whether the transaction was reimbursed to a provider or directly to the participant. 0 -Participant Reimbursed Claim 1 -Provider Reimbursed Claims

    • ProviderAddress1 string

      Provider address 1

    • ProviderAddress2 string

      Provider address 2

    • ProviderCity string

      Provider city

    • ProviderID string Required

      Provider ID

    • ProviderState string

      Provider state

    • ProviderZip string

      Provider zip

    • DependentId string

      Unique Dependent Identifier

    • PaymentId string

      Represents the draft # issued by our Integrated Payment vendor.

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

    • ExternalClaimNumber string

      External Claim Number added to transactions to facilitate and track overpayments

    • PinNetworkIndicator boolean

      0 (False) Signature Based 1 (True) PIN Based Will indicate whether the transaction is a PIN based or signature based transaction.

    • ExcludeFromEmployerFunding boolean

      0 (False) 1 (True) Indicates if transaction is excluded from employer funding

    • HSAPostingDate string

      HSA posting date

    • HSACodeDescription string

      HSA code description

    • HSACode integer <int32>

      HSA code

    • HSAReasonForNonPostDescription string

      HSA reason for non post description

    • HSAReasonForNonPostCode integer <int32>

      HSA reason for non post code

    • PostingType string

      Posting type

    • GLAccount string

      General ledger account

    • HoldAmount number <double>

      Hold amount

    • OffsetAmount number <double>

      This field returns the Ineligible Amount – Offset Amount. This is the amount remaining after offsetting. For completely offset transactions, the amount will be 0.