Stop recurring payment

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

Update the status of a recurring payment to stop future transactions for a specified participant. This operation is typically used when a participant wishes to discontinue automatic payments.

Path parameters

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.

Query parameters

taskScheduleKey integer <int32>

Unique identifier for the scheduled payments associated with a recurring payment. This key is returned by the GetFutureRecurringPayments API and is essential for identifying which payment schedule to cancel.
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.