Sign in

v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Recurring Charges

Add Recurring Charge

Add Recurring Charge

post/RecurringPayments/AddRecurringCharge/{uid}

Path parameters

uidstring required

Recurring payment uid

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

terminal_uidstring required

Unique identifier for terminal

card_tokenstring required

This field is not required if it's bank recurring order

cvvstring

In case the terminal is opened as recurring, this field is mandatory for initialization transactions when a new recurring order is created.

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.

charge_datestring required

Example: 2020-12-16

validboolean required

Affects recurring Charge status

extra_infostring

Extra Info

Response

200

Example response

{
  "result": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "recurring_charge_uid": "4df4d693-bf7f-4ce8-b92f-f0247228faf6"
  }
}