This endpoint and its parameters are used to process recurring payments.For recurring payments to be processed, the order_type parameter must be set to 1 and the following parameters must not be empty:recurring_payment_interval
order_type#
Required
Type: Integer
Value : 1Determines the type of the order.
recurring_payment_number#
Required
Type: IntegerDefines the total number of recurring payments.
Example:
If the initial amount is 100 USD and recurring_payment_number is set to 5, the total processed amount will be 100 USD × 5 = 500 USD.
Additional transaction fees may apply for each installment.
recurring_payment_cycle#
Required
Type : StringSpecifies the unit type of the recurring interval.
Possible values:
recurring_payment_interval#
Required
Type: StringDefines the frequency of the recurring payment based on the selected cycle.**Example: **
recurring_payment_cycle = M
recurring_payment_interval = 1
means that payment is charged every month.
recurring_web_hook_key#
Required
Type: StringA key used to receive notifications regarding the recurring payment status in your system.
This key can be obtained from the Sipay panel.
The initial payment is sent to the sale webhook, while subsequent payments are sent to the recurring webhook.
The hash key must be send in the request.
Sample hash keys can be found in the request form panel on the side, corresponding to the selected programming language.