Запит формується на стороні продавця та передається методом POST на URL https://api.wayforpay.com/regularApi
Регулярний платіж можна створити за успішно оплаченому orderReference.
Доступна наступна періодичність регулярних списань:
- одноразове - списати один раз в зазначену дату;
- щоденне - списання, із зазначенням дати старту і дати закінчення щоденних списань;
- щотижня - платіж з періодичністю один раз на тиждень;
- щомісяця - платіж один раз на місяць в встановлену дату.
Параметри запиту:
| Параметр | Опис | Тип |
| requestType | Тип запиту:: CREATE | обов'язкове |
| merchantAccount | ідентифікатор продавця | обов'язкове |
| merchantPassword | пароль продавця | обов'язкове |
| regularMode | Періодичності списання: - once - списання один раз - daily - щодня - weekly - щотижнево - quarterly - щоквартально (раз в три місяці починаючи з дати першого платежу) - monthly - щомісяця - halfyearly - раз на півроку - yearly - раз на рік | обов'язкове |
| amount | Сума регулярного списання | обов'язкове |
| currency | Валюта регулярного списання | обов'язкове |
| dateNext | Дата першого платежу в форматі ДД.ММ.РРРР | обов'язкове |
| dateEnd | Дата закінчення в форматі ДД.ММ.РРРР | обов'язкове |
| orderReference | Номер замовлення в системі торговця, за яким була створена успішна оплата | обов'язкове |
| | email клієнта, на який буде приходити повідомлення про регулярні платежі | обов'язкове |
Параметри відповіді:
| Параметр | Опис | Приклад |
| reasonCode | Код відмови | 4100 |
| reason | Причина відмови | Ok |
Приклад запиту і відповіді:
{
"requestType": "CREATE",
"merchantAccount": "test_merch_n1",
"merchantPassword": "d485396ae413eb60dc251b0899b261c2",
"regularMode": "once",
"amount": "2",
"currency": "UAH",
"dateBegin": "04.05.2015",
"dateEnd": "05.05.2015",
"orderReference": "P21435306374431",
"email": "dev.test@mail.com"
}
{
"reasonCode": 4100,
"reason": "Ok",
"orderReference": "P21435306374431"
}