Query payment status

Request

Send a request to find out the current status of your payment after it has been authorized using the events action link. Note: It can take up to 15 minutes for a payment event to update.

Security

BasicAuth

Path

linkDatastringrequired

Action link that's received in your request

Content-Typestringrequired

Example:application/vnd.worldpay.payments-v5+json

Acceptstring

Example:application/vnd.worldpay.payments-v5.hal+json

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/{linkData}' \
  -H 'Accept: application/vnd.worldpay.payments-v5.hal+json' \
  -H 'Content-Type: application/vnd.worldpay.payments-v5+json'

Responses

Retrieve the last event of a payment

Bodyapplication/vnd.worldpay.payments-v5.hal+json

lastEventstringrequired

Response

An example of querying a payment event with a transaction reference REF123

{
  "lastEvent": "Authorized",
  "_links": {
    "payments:cancel": "/payments/authorizations/cancellations/:linkData",
    "payments:settle": "/payments/settlements/full/:linkData",
    "payments:partialSettle": "/payments/settlements/partials/:linkData",
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}