Test login
Productie login
Gratis testen

API manual

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 PARAMETERDESCRIPTION
entity keyEvery 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:

LinkSentOnly allowed from statuses: Booked, SendError
SendErrorOnly allowed from statuses: Booked, LinkSent
MailDeliveredOnly allowed from statuses: Booked, LinkSent
MailOpenedOnly allowed from statuses: Booked, LinkSent, MailDelivered
LinkClickedOnly allowed from statuses: Booked, LinkSent, MailDelivered, MailOpened
PaymentInProgressAllowed from all statuses except: Expired, Aborted, Success, Error
PaymentPendingAllowed from all statuses except: Expired, Aborted. Success, Error
PaymentFailedAllowed form all statuses except: Expired, Aborted, Success, Error
PaymentDeclinedAllowed from all statuses except: Expired, Aborted, Success, Error
SuccessAllowed from all statuses except: Aborted
AbortedAllowed from all statuses except Expired, Success
ExpiredAllowed from all statuses except: Success, Aborted, Error
ErrorAllowed from all statuses except: Expired, Success, Aborted
order referenceThe unique reference of the order that must be searched.

Example

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.