Update Recurring Token Payment

This the unique identifier of the merchant in our system.

Based on the timezone, the execution time of the recurring payment is calculated. The value of this field aligns with the geographic area's standard time and daylight saving adjustments. It is formatted as "Country/Region" and defaults to the merchant's timezone.

The agreementId you want to update as returned when you first setup the recurring agreement.

This is the effective start date of the Recurring Payment Schedule in UTC, formatted as YYYY-MM-DD.

This is the effective date on which this Recurring Payment Schedule becomes invalid. This value is in UTC, formatted as YYYY-MM-DD.

The type of tender used for the transaction.

Pause the Recurring Payment schedule.

If the agreement type should remain active or be marked as inactive.

This indicates frequency of the schedule for this Recurring Payment Schedule.

This indicates the frequency of the Recurring Payment Schedule. For example, if the value is 2 and the frequency type is 'Weekly', then the card will be charged every 2 weeks.

This specifies the month of the year to charge the card, applicable when the frequency type is 'YEARLY'.

This indicates the specific day of the month when the card will be charged.

This specifies the day of the week on which to charge the card, applicable when the frequency type is 'WEEKLY'.

Set false if the Recurring Payment schedule is expected to run on weekdays only. Applecable if frequency type is 'WEEKLY'.

This is the unique identifier of the Recurring Payment Schedule in our system

This the unique identifier of the merchant in our system.

The merchant timezone configured for the recurring agreement.

Recurring payment setup creation date.

Recurring payment setup last modified date.

This is an auto generated field. Once the schedule contract is confirmed, this id is generated. For update always a new agreement Id is generated.

The last run date of a recurring transaction for this agreement.

The next scheduled run date for this agreement

When the recurring agreement is due to resume

If the agreement is deleted and no longer active.

If the agreement is currently paused

If the agreement is currently active

The merchant account that the agreement was created on

If the agreement has been updated

The frequency type of the recurring transaction

The unique id of a recurringSchedule

The countryCode of the recurring transaction for the merchant

The numeric currency code of the agreement id.

The reporting level id that the recurring transaction is related to.

The transaction status of the agreement

The identifier for the transaction in your system formatted as a string.

The token value of the credit card.

The type of payment method being used for the recurring transaction

The masked card number for the agreement type

The cardholder name for the agreement type if supplied

the MMYY for the expiry of the card

This is the total amount of the transaction in the designated currency in decimal

List of error messages.

Request date and time.

HTTP Status code.

Error message.

API path.