Participant APIs | REST

Selected Version:
Download Open API File

Stop recurring payment

https://api.wealthcare.com/participant/services/participant/transactions/cancelpayment/{tpaId}/{employerId}/{participantId}

Stop recurring payment

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 user whose feature information is being retrieved.

  • taskScheduleKey integer <int32>

    Unique Identifier that identifies the scheduled payments for a Recurring Payment. This is a database Key that is returned on the Getfuturerecurringpayments API.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

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

AI Assistant Preview

Generating response...