Add

post

https://restapi.payplus.co.il/api/v1.0/RecurringPayments/Add

This endpoint allows you to create a recurring payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

terminal_uid

string

required

Terminal unique identifier

customer_uid

string

required

Customer unique identifier

card_token

string

required

Saved card unique identifier.

bank_account_uid

string

Customer bank account uid. This field is required in case this is bank masav order.

company_bank_account_uid

string

This field is required in case this is bank masav order.

cashier_uid

string

required

Cashier unique identifier

currency_code

string

enum

required

Allowed:

instant_first_payment

boolean

required

Process the first payment immediately. If set to true, please make sure to set the recurring payment start_date to next charge due date - this will prevent duplicate charges. If set to false, the first charge will be processed on the start_date.

recurring_type

integer

enum

required

0 - Daily 1 - Weekly 2 - Monthly

Allowed:

recurring_range

integer

required

Defaults to 1

Determines the charges frequency. For example, if recurring_type is set to Monthly and recurring_range is set to 2, the charges will be processed every 2 months.

number_of_charges

integer

required

If set to 0, the recurring payment will be unlimited. If set to a positive number, the recurring payment will stop after that many charges.

start_date

string

required

Can't be the same date as today. This is the date when the first charge will be processed. If you want to charge immediately, set instant_first_payment to true and start_date to the next charge due date.

end_date

string

When the recurring will stop, in case the recurring is unlimited.

items

array of objects

required

List of products or services included in the recurring payment.

items*

one_time_items

array of objects

List of products or services for one-time charges.

one_time_items

one_time_charge_date

string

Sets when the one time charge will be processed. This is only required if you have one_time_items.

successful_invoice

boolean

Defaults to false

Triggers and invoice creation if the charge is successful.

send_customer_success_email

boolean

Defaults to false

Send e-mail to customer if the charge is successful.

customer_failure_email

boolean

Defaults to false

Send e-mail to the customer for failure payment and inform him to contact the business to update payment details.

send_customer_success_sms

boolean

Defaults to false

Send SMS to customer if the charge is successful. This requires an SMS package to be purchased.

customer_failure_sms

boolean

Defaults to false

Send SMS to customer if the charge fails. This requires an SMS package to be purchased.

extra_info

string

Additional information about the recurring payment.

Headers

api-key

string

required

API Key

secret-key

string

required

Secret Key

Responses

200200

400400