Cancel recurring payment
If you (or your customer) need(s) to cancel a recurring payment, the Cancel Recurrence API is used. Provide recurrenceId in path merchant/recurrences/{RecurrenceId}/cancel
No more recurring payments can be initiated with canceled recurrenceId.
Update recurring payment
If you need to make changes for existing recurring payments, you can use the Update Recurrence API.
Details that can be updated:
| Property | Value | Description |
|---|---|---|
payment.instructedAmount.amount | e.g. 12.00 | The amount that needs to be changed. This is valid only for recurring payments (for unscheduled MITs, it can be changed via Initiate Recurring Payment API) |
payment.instructedAmount.currency | e.g. EUR | Currency that needs to be changed. Possible values: GBP, SEK, NOK, DKK, PLN, USD |
recurrence.endDate | e.g. 2023-12-02 | Date format. Last date of recurring payment. Only future dates can be used. No longer than 4 years from the date of a request. It can be changed to null to remove the end date. |
recurrence.frequency.days | e.g. 1 | The period between payments. Min value: 1 Max value: 366 |
Each property can be updated separately; therefore, all are optional.