Query payment status

Query payment status
Deprecated - Use Payment Queries API
deprecated

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-v7+json

Acceptstringrequired

Example:application/vnd.worldpay.payments-v7+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-v7+json' \
  -H 'Content-Type: application/vnd.worldpay.payments-v7+json'

Responses

Retrieve the last event of a payment

Bodyapplication/vnd.worldpay.payments-v7+json

lastEventstringrequired

Enum Value	Description
Authorized	The payment has been approved and the funds have been reserved in your customer's account.
Refused	Your payment request has been declined.
Sent for Settlement	A request has been made to move the reserved funds in your customer's account and transfer them to your Worldpay account.
Sent for Refund	A request has been made to send funds back to your customer's account.
Sent for Cancellation	A request has been made to cancel the payment without sending it for settlement.
Refund failed	A refund request couldn't be processed and the funds were returned to your account.
Settlement failed	A settlement request couldn't be processed. Funds have not been transferred to your Worldpay account.
Settled	We have received the funds and are preparing to transfer them to your bank account. This event is only available in certain use cases.
Refunded	The card issuer has received the refund request and they will return the funds to your customer's account. This event is only available in certain use cases.
Error	The payment wasn't completed. You may want to reattempt the payment.
Expired	The authorization validity period ended before a settlement or cancel request was made.

Response

Querying a payment event with a transaction reference

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