Get Recurring Payment

Search based on the unique agreement ID provided by TNS.

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

This is 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.

This is the effective start date of the schedule

This is the effective date on which this recurring schedule becomes invalid.

This is the upcoming effective date on which the recurring payment will be executed.

This is the date of the last executed recurring payment.

This is an auto generated field. Once the schedule contract is confirmed, this id is generated.

This indicates frequency of the schedule for this recurring payment.

The type of tender used for the transaction.

This is the 3 digit ISO 4217 numeric Currency Code.

This indicates the frequency of the recurring payment. For example, if the value is 2 and the frequency type is 'DAILY', then the card will be charged every 2 days.

This specifies the month of the year to charge the card, applicable when the frequency type is 'YEARLY'. Accepted values range from 1 to 12, corresponding to January through December.

This specifies the date of the month on which to charge the card, applicable when the frequency type is 'MONTHLY' or 'YEARLY'. Accepted values range from 1 to 28 to accommodate all months.

This specifies the day of the week on which to charge the card, applicable when the frequency type is 'WEEKLY'. Accepted values range from 1 to 7, where 1 corresponds to Sunday and the numbers follow sequentially through the week.

This indicates the system to perform this Recurring Payment Schedule only on the week days. Applicable when the frequencyType is 'DAILY'.

The name of the merchant as it appears in the merchant portal.

This field indicates whether the Recurring Payment Schedule has been deleted.

This field indicates whether the Recurring Payment Schedule has been paused.

This field indicates whether the Recurring Payment Schedule is active.

List of error messages.

Date time request received.

HTTP Status code.

Error message.

API.