Update

This endpoint allows you to update an existing recurring payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Recurring Payment unique identifier

Body Params
string
required

Terminal unique identifier

string
required

Customer unique identifier

string
required

Saved card unique identifier.

string

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

string

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

string
required

Cashier unique identifier

string
enum
required
Allowed:
boolean
required
Defaults to false

Process the initial payment immediately on-site

integer
enum
required

0 - Daily 1 - Weekly 2 - Monthly

Allowed:
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.

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

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.

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
string

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

boolean
Defaults to false

Triggers and invoice creation if the charge is successful.

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

string

Additional information about the recurring payment.

Headers
string
required

API Key

string
required

Secret Key

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json