Access Worldpay
/
Query a Payment
/
Query payment status

Payments (5)

Payments root resource, returns links to available payments actions.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Take a one-time payment

To take a payment, you must first create an authorization request. Your response contains links to your next available actions.

Operations

Take repeat payments

Take a payment using a stored credential

Operations

Manage Payments

Cancel, settle, refund or reverse payments

Operations

Query a Payment

Send a request to find out the current status of your payment after it has been authorized.

Operations

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.

Path
linkDatastringrequired

Action link that's received in your request

Headers
Content-Typestringrequired
Example: application/vnd.worldpay.payments-v5+json
Acceptstring
Example: application/vnd.worldpay.payments-v5.hal+json
No request payload

Responses

Retrieve the last event of a payment

Bodyapplication/vnd.worldpay.payments-v5.hal+json
lastEventstringrequired
Response
application/vnd.worldpay.payments-v5.hal+json

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
      }
    ]
  }
}

Query payment status Recovery

Request

Send a request to find out the current status of your payment after it has been authorized using the events action link. This action is only to be used for recovery purposes. Use this action if your authorization requests timed out. The response determines if your authorization request was successful and your next available actions are returned.

No request payload

Responses

Retrieve the last event of a payment

Bodyapplication/vnd.worldpay.payments-v5.hal+json
lastEventstringrequired
Response
application/vnd.worldpay.payments-v5.hal+json

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
      }
    ]
  }
}