Credit Card Recurring Payment
Body Parameters
This the unique identifier of the merchant in our system.
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.
This indicates frequency of the schedule for this Recurring Payment Schedule.
DAILYWEEKLYMONTHLYYEARLYThis 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 indicates the specific day of the month when the card will be charged.
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 type of tender used for the transaction.
CREDITCARDTOKENThis is the ISO 4217 currency code. Use "036" for Australian dollar, "840" for United States dollar, "826" for Pound sterling. Please refer https://en.wikipedia.org/wiki/ISO_4217 for list of all currency codes.
List of payment options for this Recurring Payment schedule.
Show child attributes
Response
OK
Response Attributes
This is the unique identifier of the Recurring Payment Schedule in our system
The identifier for the transaction in your system formatted as a string.
The token value of the credit card.
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. This can be used provided when updating the agreement in the future.
Bad Request
Response Attributes
List of error messages.
Show child attributes
Unauthorized
The server is temporarily unavailable. Please try again later.
Internal Server Error
Response Attributes
Date time request received.
HTTP Status code.
Error message.
API.
Base URL
Production:
Sandbox: