Participant APIs | REST

Selected Version:
Download Open API File

Get the Authorization Custom Text set from the Online Balance Repayment Template in WCA.

https://api.wealthcare.com/participant/services/repayment/customtext/authorization/{tpaId}/{employerId}/{participantId}

Retrieve the Authorization Custom Text configured in the Online Balance Repayment Template for a specific participant, identified by TPA ID, Employer ID, and Participant ID. This endpoint is useful for displaying customized messages related to repayment options in the WealthCare Portal.

Request

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when 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

    Unique identifier for the participant whose features are being queried.

  • Accept-Language enum<string>

    Indicates the participant’s preferred language for the response. Valid values are "es" for Spanish, "en" for English, and "fr" for French. If the specified language does not have a translation for a field, the English text will be returned by default.

    Possible values: es en fr
  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

  • selectedDepositAccountName string

    The name of the deposit account selected by the participant for repayment. This parameter helps in retrieving the relevant custom text associated with the specified account.

  • paymentAmount number <double>

    The amount intended for payment, represented as a double. This value is used to determine any specific custom text related to the payment amount.

Response

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

AI Assistant Preview

Generating response...