Recover payments

Operations

Recover payment status

Request

Send a request to find out the current status of your payment after it has been authorized using its associated transactionReference and entity.

Important:

Only use this for recovery purposes for example when your authorization request has timed out or you are unable to locate a payment through our Payment Queries API. If the query returns results, you can manage the payment using the next action links returned in the response of your GET request.

Security

BasicAuth

Query

transactionRefstring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$required

A unique reference generated by you that is used to identify a payment throughout its lifecycle.

Example:transactionRef=Memory265-13/08/1876

entitystring, [ 1 .. 32 ] characters^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$required

An identifier we provide during onboarding. Some merchants may have more than one entity. Direct your payment accordingly to assist with billing, reporting and reconciliation.

Example:entity=default

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?transactionRef=Memory265-13%2F08%2F1876&entity=default' \
  -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 Cancelation	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
      }
    ]
  }
}