Cancel recurring series.

Cancel the entire series of recurring payments by recurrence ID.

SecurityoAuth2
Request
path Parameters
recurrenceId
required
number

Recurrence Unique Identifier.

query Parameters
cancelReason
string <= 100 characters

Cancellation reason

cancellationSource
string <= 50 characters

Cancellation source

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Unexpected Error

503

Service unavailable

delete/v1/recurrences/{recurrenceId}
Request samples 
Response samples 
application/json
{
  • "message": "Cancellation request for recurring id: 4059 is success.",
  • "errors": [ ]
}