Запрос формируется на стороне торговца и передается методом 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"
}