STATUS request is used for the payment status verification according to orderReference .
The request is generated on the side of the merchant and transferred with the help of POST method to URL https://api.wayforpay.com/regularApi
Possible states of the recurrent payment:
- Active – active recurrent payment
- Suspended – suspended recurrent payment
- Created - recurrent payment is created but not active
- Removed – deleted recurrent payment
- Confirmed – service status
- Completed - regular payment completed
Request parameters
| Parameter | Description | Type |
|---|---|---|
| requestType | Request type: STATUS | Mandatory |
| merchantAccount | Merchant identifier | Mandatory |
| merchantPassword | Merchant password | Mandatory |
| orderReference | Order number in the merchant system, under which there was created successful payment | Mandatory |
Response parameters
| Parameter | Description | Example |
|---|---|---|
| reasonCode | Rejection code | 4100 |
| reason | Rejection reason | Ok |
| orderReference | Order number in the merchant system, under which there was created successful payment | P21435306374431 |
| mode | Write-off frequency | once |
| status | Recurrent payment status | Active |
| amount | Payment amount | 2 |
| currency | Value | UAH |
| | Client e-mail, where there are sent notifications as to recurrent payment | dev.test@mail.com |
| dateBegin | The first payment date | 1435698000 |
| dateEnd | End date | 1436043600 |
| lastPayedDate | The last payment date | null |
| lastPayedStatus | The last payment status | null |
| nextPaymentDate | The next payment status | null |
Response examples
{
"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
}