v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Recurring Payments

Update

This endpoint allows you to update an existing recurring payment.

post/RecurringPayments/Update/{uid}

Path parameters

uidstring required

Recurring Payment unique identifier

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

terminal_uidstring required

Terminal unique identifier

customer_uidstring required

Customer unique identifier

card_tokenstring required

Saved card unique identifier.

bank_account_uidstring

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

company_bank_account_uidstring

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

cashier_uidstring required

Cashier unique identifier

currency_code'ILS' | 'USD' | 'EUR' | 'GPB' required

instant_first_paymentboolean required

Process the initial payment immediately on-site

recurring_type0 | 1 | 2 required

0 - Daily 1 - Weekly 2 - Monthly

recurring_rangeinteger required

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_chargesinteger required

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

start_datestring 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_datestring

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

one_time_charge_datestring

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

successful_invoiceboolean

Triggers and invoice creation if the charge is successful.

send_customer_success_emailboolean

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

customer_failure_emailboolean

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

send_customer_success_smsboolean

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

customer_failure_smsboolean

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

extra_infostring

Additional information about the recurring payment.

Response

200