CancelRecurringPayment

Endpoint

Overview

The "CancelRecurringPayment" endpoint is a POST request. It is used to cancel a recurring payment.

The endpoint on Swagger is: Payment_CancelRecurringPayment.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

📘

Request Header

Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.


Request Model

The request is a POST request with the following query string parameter:

Input ParameterTypeDescription
recurringIdstring

Response Model

After viewing the Response Model that you will get, the result of your request is a boolean in the Data parameter.


Sample Messages

/v2/CancelRecurringPayment?recurringId=RECUR2175
{
   "IsSuccess":true,
   "Message":"Canceled successfully",
   "ValidationErrors":null,
   "Data":true
}