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

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

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

 

Можливі стани регулярки:

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

 

Параметри запиту

Параметр

Опис

Тип

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
}