If it is required to suspend the possibility of recurrent payments from the card, the merchant may pause the payment. In such a case the recurrent payment will not be made till their renewal.
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
Request parameters:
Parameter | Description | Type |
---|---|---|
requestType | Request type: SUSPEND | 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 | ок |
Examples of request and response
Request example:
{
"requestType": "SUSPEND",
"merchantAccount": "test_merch_n1",
"merchantPassword": "d485396ae413eb60dc251b0899b261c2",
"orderReference": "P21435306374431"
}
Request example:
{
"reasonCode": 4100,
"reason": "Ok"
}