Theme switcher

Create Monthly Recurring Payment

Body Parameters

merchantIdstring Required

This the unique identifier of the merchant in our system.

startDatestring Required

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

endDatestring Required

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

frequencyTypestring Required

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

Enum values:
DAILY
Charge the card Daily.
WEEKLY
Charge the card every week on the given day of the week.
MONTHLY
Charge the card every month on the given day of the month.
YEARLY
Charge the card annually on the given month and day of the year.
frequencystring

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.

dateOfMonthnumber Required

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

timezonestring

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.

paymentMethodstring Required

The type of tender used for the transaction.

Enum values:
CREDITCARDTOKEN
paymentDetailsarray Required
currencyCodestring Required

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

Response

200
Object

OK

Response Attributes

recurringPaymentSetupIdstring

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

transactionReferencestring

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

tokenstring

The token value of the credit card.

createdDatestring

Recurring payment setup creation date.

updatedDatestring

Recurring payment setup last modified date.

agreementIdstring

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

400
Object

Bad Request

Response Attributes

errorsarray

List of error messages.

401
Object

Unauthorized

404
Object

The server is temporarily unavailable. Please try again later.

500
Object

Internal Server Error

Response Attributes

timestampstring

Date time request received.

statusnumber

HTTP Status code.

errorstring

Error message.

pathstring

API.

Was this section helpful?

Base URL

Production:

Sandbox:

POST

/

Select
1

Response

Was this section helpful?