Change the status of a mandate by the mandate number (http POST)
Using the ‘status’ command the status of a mandate request with the specified mandate can be changed.
The <command> value in the URL must be replaced by: status/<entity key>/<status>/<mandate number>
A secure connection, as described in the ‘API connection’ page, must be created.
| URL PARAMETER | DESCRIPTION | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entity key | Every PayByLink entity within the system has its own unique key. When connecting to the PayByLink system, this key must be supplied as well so PayByLink knows within which entity the payment must be created. | ||||||||||||||||||
| status | The status that the mandate must get. The following values are allowed:
| ||||||||||||||||||
| mandate number | The unique mandate number of the mandate request that must be searched. |
Example
https://api.paybylink.com/mandate/status/e7140a88-cbba-4cc2-be9f-6e90536703ef/Expired/PAYBY95
https://api.paybylink.com/mandate/status/e7140a88-cbba-4cc2-be9f-6e90536703ef/Expired/PAYBY95
Return values
When the status of the mandate request could be successfully changed, an http-code 200 will be returned. If the status of the request could not be changed, a ‘BadRequest’ with a describing message is returned.
Date updated: 2019-10-09
