Administrative APIs | REST

Version:
Download Open API Specification

Create Recurring Expense

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

Used to create a recurring expense using an existing transaction as a template

  • tpaId string Required

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

  • effectiveFrom string <date-time>

    Format of YYYY-MM-DD. Set date for recurring expense to begin. Date can be set prior to, equal to, or after the date of the POS transaction but MUST be within the plan year.

  • effectiveTo string <date-time>

    Format of YYYY-MM-DD. Set date for recurring expense to end. Cannot be later than plan year end date.

  • settlementDate string <date-time> Required

    Format of YYYYMMDD. This is the settlement date of the "template" transaction. Using the settlement date and the settlement sequence number is a way to uniquely identify a transaction within the system.

  • settlementSequenceNumber integer <int32> Required

    This is the sequence number of the "template" transaction. 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.