ResumeRecurringPayment

Endpoint

Overview

The "ResumeRecurringPayment" endpoint is a POST request. It is used to manually retry a failed recurring payment created by the vendor account. The Request is used only with the uncompleted recurring payment which means that the recurring status is inactive.

The endpoint on Swagger is: Payment_ResumeRecurringPayment.

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 Parameter

Type

recurringId

string


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/ResumeRecurringPayment?recurringId=RECUR2175
{
  "IsSuccess": true,
  "Message": "Recurring Resumed successfully",
  "ValidationErrors": null,
  "Data": true
}
{
  "IsSuccess": false,
  "Message": "Invalid data",
  "ValidationErrors": [
    {
      "Name": "RecurringId",
      "Error": "This recurring cannot be resumed as it is active or the status is not Uncompleted"
    }
  ],
  "Data": false
}


Did this page help you?