Change the status of a payment by the order reference (http POST)
Using the ‘status’ command the status of a payment with the specified order reference can be changed.
The <command> value in the url must be replaced by: status/<entity key>/<status>/<order reference>
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 payment must get. The following values are allowed:
| ||||||||||||||||||||||||||
| order reference | The unique reference of the order that must be searched. |
Example
https://api.paybylink.com/payment/status/e7140a88-cbba-4cc2-be9f-6e90536703ef/Expired/2016REF-A
https://api.paybylink.com/payment/status/e7140a88-cbba-4cc2-be9f-6e90536703ef/Expired/2016REF-A
Return values
When the status of the payment could be successfully changed, an http-code 200 will be returned. If the status of the payment could not be changed, a ‘BadRequest’ with a describing message is returned.
Date updated: 2019-10-09
