Update existing recurring payment.

Update existing recurring payment.

SecurityoAuth2
Request
path Parameters
paymentUID
required
number

Payment Unique Identifier

recurrenceId
required
number

Reccurence Unique Identifier

Request Body schema: application/json
frequency
required
string

Allowed values are daily, weekly, biweekly, Monthly, quarterly, semiannually and yearly.

payUntil
string

Allowed values are Cancelled, EndDate and NumberOfPayments.

endDate
string

Recurring End Date date in MM/dd/yyyy format. End Date should not be less than the current date.The end date is mandatory when payUntil is EndDate.

noOfPayments
number

The number of payment should be at least 1. Number of payment is mandatory when pay until is NumberOfPayments.

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

Internal server error

503

Service unavailable

put/v4/payments/{paymentUID}/recurring/{recurrenceId}
Request samples
application/json
{
  • "frequency": "Monthly",
  • "payUntil": "NumberOfPayments",
  • "endDate": "string",
  • "noOfPayments": 10
}
Response samples
application/json
{
  • "message": "string"
}