Статус регулярного платежа

Запрос STATUS  используется для проверки статуса платежа по orderReference . 

Запрос формируется на стороне торговца и передается методом   POST на URL https://api.wayforpay.com/regularApi

 

Возможные состояния регулярки:

  • Active - регулярный платеж активный, работает
  • Suspended - регулярный платеж приостановлен
  • Created - регулярный платеж создан, но не активирован
  • Removed - регулярный платеж удален
  • Confirmed - служебный статус 
  • Completed - регулярный платеж завершен

Параметры запроса

Параметр

Описание

Тип

requestType

Тип запроса: STATUS

Обязательное

merchantAccount

Идентификатор продавца

Обязательное

merchantPassword

Пароль продавца

Обязательное

orderReference

Номер заказа в системе торговца, по которому была создана успешная оплата

Обязательное

Параметры ответа

Параметр

Описание

Пример

reasonCode

Код отказа

  4100

reason

Причина отказа

  Ok

orderReference

Номер заказа в системе торговца, по которому была создана успешная оплата

 
P21435306374431

mode

Периодичности списания

 
once

status

Статус регулярки

 
Active

amount

Сумма платежа

2

currency

Валюта

UAH

email

email клиента, на который приходит уведомление о регулярных платежах

 
dev.test@mail.com

dateBegin

Дата первого платежа

 
1435698000

dateEnd

Дата окончания

 
1436043600

lastPayedDate

Дата последнего платежа

 
null

lastPayedStatus

Статус последнего платежа

 
null

nextPaymentDate

Дата следующего платежа

 
null

Параметры ответа

Пример запроса:
{
"requestType": "STATUS",
"merchantAccount": "test_merch_n1",
"merchantPassword": "d485396ae413eb60dc251b0899b261c2",
"orderReference": "P21435306374431"
}
 
Пример ответа:
{
"reasonCode": 4100,
"reason": "Ok",
"orderReference": "P21435306374431",
"mode": "once",
"status": "Active",
"amount": 2,
"currency": "UAH",
"card": "PAN****LAST4",
"email": "dev.test@mail.com",
"dateBegin": 1435698000,
"dateEnd": 1436043600,
"lastPayedDate": null,
"lastPayedStatus": null,
"nextPaymentDate": null
}