Administrative APIs | REST

Version:
Download Open API Specification

Get Transaction By TN

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

This is used to retrieve transaction information using the tracking number as the identifier

  • tpaId string Required

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

  • TrackingNumber string

    Tracking Number assigned by the system importing the transaction to WCA

  • array <object>
    • AccountTypeCode string

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

    • 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

    • CardholderName string

      Name of owner of the debit card.

    • CardNumber string

      Card number belonging to the debit card.

    • 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

    • DisplayDate string <date-time>

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

    • 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

    • EmployeeName string

      Name of the employee who owns the account.

    • ErrorCode string

      Error code for the reason the operation failed

    • 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

    • MerchantName string

      Name assigned to the Merchant ID, which appears on the transaction. If this field is blank and is for a Card transaction, WealthCare Admin populates it with the description for the Original Merchant Type Code (MTC) field. All refund codes, whether for Card or manual transactions, are listed under Transaction Code 14. This change affects only Card transactions. Thus, if the Merchant Name field is blank, the MTC description will appear only for the Card transactions. This field will be populated for charge backs as follows when a Code 14 Card Refund has been identified as a charge back transaction: Initial charge back - 'PROV CRED - merchant name' Reversal - 'CRED REVS - merchant name'

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

      The service end date of the transaction

    • ServiceStartDate string <date-time>

      The date for the first recurrence of the service

    • SettlementDate string

      Format is YYYYMMDD. Date the transactions 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.

    • StatusDateTime string <date-time>

      The date and time of the most recent adjudication activity

    • TerminalId string

      The terminal unique identifier received on the card authorization request (for card transactions)

    • TpaId string

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

    • TrackingNumber string

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

    • TransactionAmount number <double>

      Amount of this transaction.

    • TransactionDateTime string <date-time>

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

    • TransactionType enum<string>
      Possible values: Deposit POS Manual OtherDeposit All
    • UserUpdatingStatus string

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

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

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

    • PaymentId string

      Represents the draft # issued by our Integrated Payment vendor.

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

    • 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

      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.

    • 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