Get Recent Transactions

https://api.wealthcare.com/participant/services/participant/transactions/recent/{tpaId}/{employerId}/{participantId}

Get Recent Transactions - return TaxYear, Pre Tax amount and Post Tax Amount

Path parameters

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.
participantId string Required

Participant Id

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Possible values: es en fr

Query parameters

flexAccountKey integer <int32>

A unique identifier representing the flex account that was created by WCA when the account was first inserted.
decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
includereceipts integer <int32>

Indicate if the receipt should be included in the response. 1 = include receipt Any other value will result in the receipt not being included.
opt integer <int32>

If a returned claim is for a dependent, this flag indicates whether to mask certain information on the claim or not. 0: do not mask 1: mask provider information on dependent claim. PRIVATE will be returned for the claim description, claim provider description, claim provder ID, service category code, service category code description, and merchant name. 2: mask provider information on dependent claim only if Dependency Privacy is enabled. PRIVATE will be returned for the claim description, claim provider description, claim provder ID, service category code, service category code description, and merchant name.
year integer <int32>

If sent, only transactions with service start dates in that calendar year will be included. This should be a 4-digit year (I.e., 2022). If 0 is sent, transactions from all applicable years will be sent.
pageNumber integer <int32>

Used in conjunction with pageSize, this field indicates which batch of transactions to return. The transactions are returned in descending order of their service start dates. Examples: 1.) If pageNumber is 2 and pageSize is 10, the API will return transactions 11-20. 2.) If top 100 transactions are needed, set pageNumber as 1 and pageSize as 100. 3.) If there are 3000 transactions, and the page number is passed as 1 with a page size of 2000 (which is the upper limit), the API will return 2000 transactions belonging to page 1. To get the the next 1000 transactions, make a second request with pageNumber set to 2 and pageSize as 2000.
pageSize integer <int32>

Used in conjunction with pageNumber, this field indicates how many transactions to return in each batch (max 2000). The transactions are returned in descending order of their service start dates. Examples: 1.) If pageNumber is 2 and pageSize is 10, the API will return transactions 11-20. 2.) If top 100 transactions are needed, set pageNumber as 1 and pageSize as 100. 3.) If there are 3000 transactions, and the page number is passed as 1 with a page size of 2000 (which is the upper limit), the API will return 2000 transactions belonging to page 1. To get the the next 1000 transactions, make a second request with pageNumber set to 2 and pageSize as 2000. 4.) If the pageNumber is 1 and pageSize is 50 in the first request and pageNumber is 2 and pageSize is 100 in the second request, then the system re-calculates the results based on the requested pageNumber and pageSize, ensuring accurate pagination for each request.

Response

PageNumber integer <int32>
PageSize integer <int32>
TotalPages integer <int32>
TotalCount integer <int32>
Items array <object>
- DepositDetails object
  - AppliedAmount number <double>
    
    For future use only.
  - ForfeitedAmount number <double>
    
    For future use only.
- 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.
- ShowGreenColorFlag boolean
  
  This field returns true (1) when RealTime Employer Funding is enabled. Otherwise returns false (0).
- ShowHoverHelpFlag boolean
  
  This field returns true (1) when RealTime Employer Funding is enabled and transaction is not Posted. Otherwise returns false (0)
- BalanceDue number <double>
  
  When a participant’s debit card transaction is marked as ineligible, or if a reimbursement is issued which is later reversed, the ineligible or reversed amount is tracked as a ‘balance due’. This field returns that amount.
- FXClaimStatus integer <int32>
  
  For an FX claim, this will be a number 1 through 9 representing the status of the claim. The FXClaimStatusDesc field will include the corresponding description. 1 = Paid 2 = Approved 3 = Applied to Deductible 4 = Denied 5 = Eligible for Reimbursement 6 = Reversed 8 = Overpaid 9 = Partially Approved
- FXClaimStatusDesc string
  
  For an FX claim, this will be a human friendly description of the claim status, correpsonding to the FXClaimStatus field. 1 = Paid 2 = Approved 3 = Applied to Deductible 4 = Denied 5 = Eligible for Reimbursement 6 = Reversed 8 = Overpaid 9 = Partially Approved
- FXClaimReimbursedTotalAmt number <double>
  
  For an FX claim, this is the amount that has been reimbursed in total (to the participant or paid to the provider)
- FXClaimReimbursedToMemberTotalAmt number <double>
  
  For an FX claim, this is the amount that has already been reimbursed to the participant
- FXClaimRequestedTotalAmt number <double>
  
  For an FX claim, this is the total amount charged by the provider
- FXClaimDeductibleTotalAmt number <double>
  
  For an FX claim on a deductible account, this will be the transaction amount that will be used for deductible tracking. For FX claims on all other accounts, this will be the deductible amount of the transaction.
- AdjustedClaimLine integer <int32>
  
  If this field is provided, then it is used to look up the prior claim on an adjustment transaction. If the adjustment claim is received and the original claim line has not been reversed, then this claim is rejected as a duplicate. For example, you may reverse claim line 1 and then send an adjustment with claim line 2 and original claim line 1.
- RenderingProvider string
  
  The provider who provided the service to the participant (this may be different than the billing provider name). It is recommended to use this field as the Provider Name to display.
- RenderingProviderId string
  
  Provider ID for the provider who performed the service for the participant.
- OutOfPocketAmt number <double>
  
  The amount the participant has paid towards this claim
- PayProviderKey integer <int32>
  
  Unique identifier key for the Provider, generated by WCA when the provider was first created in the system
- ProviderId string
  
  For Pay Provider HSA Transactions, this will be the an identier for the provider the payment was made to
- ProviderName string
  
  For Pay Provider HSA Transactions, this will be the name of the provider the payment was made to
- MerchantName string
  
  Name of merchant associated with transaction.
- TransactionEligibleAmt 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
- FirstName string
  
  First name of Employee
- LastName string
  
  Last name of Employee
- ExternalClaimID string
  
  For an FX claim, this is the external identifier for the claim
- ClaimLine integer <int32>
  
  Number for the claim line being provided to distinguish distinct services that are submitted on the same claim
- OriginCde enum<string>
  
  An integer indicating the source of the transaction
  
  Possible values: None POSCardSwipe POSKeyedIn POSPhonedIn POSMbiSubmitted ManualScreen ManualEFT ManualAgent ParticipantManualScreen ParticipantMobileScreen HZDirect eClaimManagerManual eClaimManagerTPS WebServiceClaim
- TransactioAdjudCde enum<string>
  
  The adjudication status for the transaction
  
  Possible values: Approved Reversed Ineligible Pending ResolvedEmployeePay ResolvedPayrollDeduction New Denied Unknown ResolvedNoRefund IneligiblePartiallyOffset ResolvedOffsetbyManualClaim InsufficientDocumentation EnteredNotReviewed ClaimReversal Overpayment OverpaymentPartiallyResolved OverpaymentResolved NonPost Returned Resubmitted
- TransactioAdjudDetailCde string
  
  Description of transaction adjudication code
- TransactionCde integer <int32>
  
  Code to identify the type of transaction.|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
- TransactionDate string <date-time>
  
  Date when transaction was entered into WCA
- TransactionType string
  
  Indicates if the transaction is a deposit, other deposit, POS, or manual. It will always return a value in English regardless of the Accept-Language header.
- TranslatedTransactionType string
  
  This field is the translated version of the transaction type based on the selected language preference. If the TPA has the multilingual feature enabled and the request includes an Accept-Language header with es (Spanish) or fr (French), it will return the translated value in the preferred language. Otherwise it will return the English value for TransactionType.
- Description string
  
  The transaction description text to display to participants. For Claims - This will be Claim Description or Provider Name. For POS - this will be Merchant Name. For Product Partner Transactions - This will be the merchant name (check number will also be included if applicable).
- TransactionAmt number <double>
  
  Total amount of transaction
- HSATransactionType string
  
  Refers to how the transaction is reported to the IRS, such as a normal distribution, non-reportable, or normal contribution
- TransactionStatus string
  
  Current status of the transaction. It will always return a value in English, regardless of the Accept-Language header. Valid values are |Approved|Ineligible|Pending|Resolved Employee Pay|Resolved Payroll Deduction|New|Denied|Unkown|Resolved No Refund|Ineligible Partially Offset|Resolved Offset by Manual Claim|Unauthorized Refund|Insufficient Documentation|Entered but not reviewed|Reversed|Claim Reversal|Overpayment|Overpayment partially resolved|Overpayment resolved|Non-post|Returned|Resubmitted
- TranslatedTransactionStatus string
  
  This field is the translated version of the transaction status based on the selected language preference. If the TPA has the multilingual feature enabled and the request includes an Accept-Language header with es (Spanish) or fr (French), it will return the translated value in the preferred language. Otherwise it will return the English value for TransactionStatus.
- TxnStatusToolTipText boolean
  
  Tool tip to display transaction status. This returns true for many unapproved transaction statuses, where the participant will likely need guidance on next steps.|1 – Display tool tip|0 – Don't display tool tip
- TransactionId string
  
  A unique identifier the transaction, generated by WCA when the transaction was first inserted
- SeqNumber integer <int32>
  
  Unique number assigned to transactions in WCA
- SettlementDate string
  
  Date when the transaction settlement occurred
- CanUploadReceipt boolean
  
  Indicates whether a receipt can be uploaded. This is derived from adjudication detail code. A receipt is required when the adjudication detail code is in one of the following statuses: "AUP2", "AUP3", "AUP4", "AUP6", "AUP7", "AUP8", "AUP9", "AUPA", "AUPB", "AUPC", "AUPD", "AUPE", "AUPI", "AUPM", "AUPN", "AUPO", "AUPQ”|1 – Participant can upload a receipt|0 – Participant cannot upload a receipt
- HasReceipt boolean
  
  Indicates whether the transaction has any receipts attached to it.|1= Yes|0 = No
- ReceiptExpired boolean
  
  If a claim is submitted and not adjudicated for the 30 days, the receipt will be deleted by WCA. This flag indicates if the receipt was deleted by WCA.|1 – the receipt has been deleted|0 – no receipt has been deleted
- ReceiptsInfo array <object>
  
  Collection of ReceiptInfo
  - TpaId string
    
    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
  - FileKey integer <int32>
    
    A system generated ID used to identify the receipt file.
  - DocId string
    
    A system generated ID created when a file is submitted through a document queue instead of by a participant.
  - DocDisplayName string
    
    Document Display Name
  - OriginalFileName string
    
    Original File Name
  - UploadDate string <date-time>
    
    The date the receipt file was uploaded.
- Claimant string
  
  Employee/Dependent who claims the amount
- ServiceStartDate string <date-time>
  
  Start date of the service for which the transaction is for
- AcctTypeCode string
  
  The Account Type Code for the transaction, such as FSA, FS2, etc.
- AcctTypeDesc string
  
  The account type description for the benefit account the transaction is processed under. This will be custom plan description if this is configured.
- FlexAcctKey integer <int32>
  
  Unique identifier for the flex account, generated by WCA when the account was created
- DisplayName string
  
  For transactions with an individual amount, this will be the cardholder name in the format of LastName, FirstName