Search Recurring Payment

Provide a list of merchant IDs you want to fetch records. Please note that this field is optional and should only be utilized when employing a level API key and secret. If you are utilizing an API key and secret of a merchant, by default, this will retrieve data associated with the merchant tagged with the API key and secret.

Start date is a conditional field. It is mandatory when the date type is specified as EXPIRING_PAYMENT. In the case of date type selected as CONTRACT, it is solely utilized to retrieve records within the specified date range. The start date adheres to UTC and follows the format YYYY-MM-DD.

End date is a conditional field. It is mandatory when the date type is specified as EXPIRING_PAYMENT. In the case of date type selected as CONTRACT, it is solely utilized to retrieve records within the specified date range. The end date adheres to UTC and follows the format YYYY-MM-DD.

When a date range is chosen, the date type is applicable to either of the following values.

Search based on the unique agreement ID provided by TNS.

Search based on the Recurring Payment schedule frequency.

Recurring Payment schedule contract status

Fetch Recurring Payment schedule for provided transaction amount. Amount is provided in lowest unit of currency formatted as a string. Send the amount without a decimal in it. e.g. $10.25 should be sent as 1025.

Search based on the payment type selected for the Recurring Payment schedule

Search transaction based on the token value

Search based on the card holder name

Search based on PAN first six digit

Search based on PAN last four digit

Search based on the card expiry date. Formatted as MMYY.

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

This is the unique identifier of the merchant in our system.

Merchant time zone as mentioned in the merchant record.

Recurring Payment schedule start date and time in UTC format.

Recurring Payment schedule end date and time in UTC format.

This is the date of the last executed recurring payment.

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

If the Recurring Payment is paused, this defines the date when Recurring Payment schedule will become active again.

True if the Recurring Payment schedule is deleted.

True if the Recurring Payment schedule is currently paused.

True if the Recurring Payment schedule is currently active.

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

The recurring payment amount, to be charged to the customer for every recurring schedule. Amount is provided in lowest unit of currency i.e. $10.25 should be sent as 1025.

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

Recurring Payment schedule created by user name.

Date time the Recurring Payment schedule was created.

Recurring Payment schedule updated by user name.

Date time the Recurring Payment schedule was updated.

Selected payment method for Recurring Payment schedule.

Token value in case of payment method selected as token.

First six digit of the PAN.

Last four digit of the PAN.

Card holder name.

Card expiry date.

This indicates frequency of the schedule for this recurring payment.

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 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'. 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.

Last executed transaction status.

This is the 3 digit ISO 4217 numeric code. Please refer https://en.wikipedia.org/wiki/ISO_4217 for list of all currency codes.

Masked card number if payment method is selected as credit card.

List of error messages.

Request date and time.

HTTP Status code.

Error message.

API path.