Update existing recurring payment.

Update existing recurring payment.

SecurityoAuth2
Request
path Parameters
recurrenceId
required
number

Reccurence Unique Identifier.

Request Body schema: application/json
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. The value of noOfPayments should not exceed the current value of noOfPayments.

frequency
string <= 35 characters

Frequency associated with the payment recurrence. The valid values are Daily, Weekly, BiWeekly, Monthly, Quarterly, SemiAnnually, Yearly.

amount
number <double>

Payment amount. The payment amount are validated as per the limit set by the payment rails or by the bank for the customer. For the Fedwire payment this will be mapped to {2000} tag.The payment rail limit per transaction are RTP upto 1M$, FedNow upto $500K, Fedwire upto $9,999,999,999.99, Same Day ACH upto 1M$.

nextPaymentDate
string

Format: String with valid format as: MM-DD-YYYY. Required ONLY when updating frequency; otherwise, it is ignored.

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

patch/v1/recurrences/{recurrenceId}
Request samples
application/json
{
  • "endDate": "string",
  • "noOfPayments": 10,
  • "frequency": "Daily",
  • "amount": 175,
  • "nextPaymentDate": "05-08-2024"
}
Response samples
application/json
{
  • "message": "string"
}