Administrative APIs | REST

Version:
Download Open API Specification

Get Recurring Expenses

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

This operation returns a list of recurring expenses that were created from a given transaction.

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

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

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

  • array <object>
    • CardTypeCode enum<string>

      Indicates the type of card used for the recurring expense.

      Possible values: None MasterCard VISA AmericanExpress All
    • EffectiveDate string

      Format of YYYYMMDD. The date when the recurring expense starts.

    • ExpenseAmount number <double>

      Amount of each recurring expense.

    • ExpireDate string

      Format of YYYYMMDD. The date when the recurring expense ends.

    • Mtc string

      Merchant Type Code (MTC) encoded into the terminal by issuing bank and transmitted with every transaction. Identifies the type of merchant submitting the transaction. If the transaction is accepted, because of a terminal, merchant or employee exception, it is the converted MTC code. (Known as MCC for Mastercard and SIC for Visa)

    • MtcDescription string

      Description of the MTC.

    • SettlementDate string

      Format of 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.

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

    • TpaId string

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