Participant APIs | REST

Selected Version:
Download Open API File

Get HSA payment details

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

Retrieve detailed information about a specific HSA payment for a participant, identified by TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining payment specifics such as amounts, dates, and provider information.

Security

Security page anchor

Path parameters

Path parameters page anchor
  • 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

Query parameters

Query parameters page anchor
  • claimKey integer <int32> Required

    Unique identifier for the claim associated with the HSA payment, used to retrieve specific payment details.

  • decrypt integer <int32>

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

Header parameters

Header parameters page anchor
  • Api-Version string

    The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

    Value: 23.0

Response

Response body

Response body page anchor
  • 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

  • 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

  • UpdateDte string <date-time>

    Last update date of payment

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

  • 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

  • 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

  • UpdateDte string <date-time>

    Last update date of payment

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

  • 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

  • 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

  • UpdateDte string <date-time>

    Last update date of payment

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

  • 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

  • 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

  • UpdateDte string <date-time>

    Last update date of payment

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

https://beta.api.wealthcare.com/participant/services/participant/hsa/payments/{tpaId}/{employerId}/{participantId}/details
Change Stored Access Token
The access token of the currently logged in user will be used to send this request
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
Participant Id
Unique identifier for the claim associated with the HSA payment, used to retrieve specific payment details.
Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

Response

Response Headers 
No response yet.
Response Body 
No response yet.

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...