Participant APIs | REST

Version:
Download Open API Specification

Get HSA payments

https://api.wealthcare.com/participant/services/participant/hsa/payments/{tpaId}/{employerId}/{participantId}

Get HSA payments

  • 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

  • status integer <int32>

    Indicate whether it''s to get the failed payment or pending payment. 1: Failed payment. 0: pending payment

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • array <object>
    • PaymentDate string <date-time>

      Service start date

    • PayeeName string

      Provider name / Payee name

    • PayeeAddress string

      Provider address / Payee address

    • AccountDescription string

      Product partner name

    • Amount number <double>

      Amount of the payment per pay cycle

    • PaymentType integer <int32>

      Method for reimbursing an employee or provider for this transaction { Check = 1, DirectDeposit = 2 }

    • PayeePhone string

      Provider phone number / Payee phone number

    • Memo string

      Memo / Note

    • ErrorCode integer <int32>

      Error code

    • ErrorDescription string

      Error description

    • PayProvider string

      EIN number / Tax ID number

    • TaskSchKey integer <int32>

      Unique key identifier for task scheduling

    • ClaimKey integer <int64>

      Unique key identifier for claim

    • RecurrenceFrequency enum<string>

      Indicates whether the claim will be a recurring claim or not, and what the recurrence is

      Possible values: All None Daily Weekly BiMonthly Monthly Quarterly Yearly SemiMonthly BiWeekly Once
    • TotalRecurrence integer <int32>

      Number of payment that are to be made

    • NextPaymentDate string <date-time>

      Date of next payment

    • TaskSchStartDate string <date-time>

      The start date for the first recurrence of the claim

    • TaskSchEndDate string <date-time>

      The end date for the recurrence

    • TaskScheduleOptions integer <int64>

      Payment schedule options { None = 0, StopSchedule = 8, RecurringNumOfPaymentsSet = 16, CompleteSchedule = 32 }

    • UpdateDte string <date-time>

      Last update date of payment

    • FlexAcctKey integer <int32>

      Unique key identifier for flex account