Participant APIs | REST

Version:
Download Open API Specification

Get the confirmation custom text

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

Retrieve the custom confirmation text for a specific participant's repayment process, identified by their unique TPA ID, Employer ID, and Participant ID.

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

    Specify the participant’s language preference for the response. The API will return text in the specified language (Spanish, French, or English). If the requested language is unavailable for a specific 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.

  • paymentAmount number <double>

    The amount that needs to be paid in the repayment process. This value is used to tailor the confirmation text based on the payment amount.