Query your payments data based on a variety of parameters
Authentication
Set your headers:
Authorization: {your_credentials}
Accept: application/vnd.worldpay.payment-queries-v1.hal+json
Replace {your_credentials}
with your base64-encoded Basic Auth username and password.
DNS Whitelisting
Whitelist the following URLs:
https://try.access.worldpay.com/
https://access.worldpay.com/
Please ensure you use DNS whitelisting, not explicit IP whitelisting.
https://try.access.worldpay.com/
https://access.worldpay.com/
Query payments within a specified date time range.
These payments can be filtered by currency, minAmount, maxAmount, last4Digits & receivedEvents.
The API returns data for payments processed after 25 June 2024. For payments processed before then use our query for historical payments.
An ISO 8601 date-time supplied as a string. Filters for payments that occurred after the specified date-time. Must be supplied alongside endDate.
An ISO 8601 date-time supplied as a string. Filters for payments that occurred below the specified date-time. Must be supplied alongside startDate.
The maximum number of payments to be returned in the response (max 300).
This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250
).
This is a whole number including the currency exponent (e.g. GBP has an exponent of 2, so for £2.50 supply:250
).
Merchant entity names.
Name of the event.
https://try.access.worldpay.com/paymentQueries/payments
https://access.worldpay.com/paymentQueries/payments
No request payload
Query payments within a specified date time range
{ "_links": { "self": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-31T21:30:20Z&pageSize=5" }, "next": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-30T09:49:31.410Z&paymentId=44809b32-6b71-4bd0-9b8c-ac29beb65059&pageSize=5" } }, "_embedded": { "payments": [ { "timestamp": "2024-05-30T19:44:19.836Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:50:17.051Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/network" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:49.843Z", "transactionReference": "7a5d0292-251f-48ed-a5c0-13c4c78d4487", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:45.962Z", "transactionReference": "89197aeb-c94a-456e-8014-1272fbcb64eb", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:31.410Z", "transactionReference": "db0eea07-cd96-417f-8f78-90cc3908c81b", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } } ] } }
Retrieve a payment by payment ID.
The API returns detailed data for payments processed after 25 June 2024. For payments processed before then use our query for historical payments.
https://try.access.worldpay.com/paymentQueries/payments/{paymentId}
https://access.worldpay.com/paymentQueries/payments/{paymentId}
No request payload
Retrieve complete details of a payment including the event history & next action links.
A unique reference generated by you, used to identify a payment throughout its lifecycle.
An object that contains identification and further details of the merchant.
An object that contains information about the payment type.
An object that contains payment amount and currency.
An array that contains the history of events of a payment.
Query payments within a specified date time range
{ "_links": { "self": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-31T21:30:20Z&pageSize=5" }, "next": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-30T09:49:31.410Z&paymentId=44809b32-6b71-4bd0-9b8c-ac29beb65059&pageSize=5" } }, "_embedded": { "payments": [ { "timestamp": "2024-05-30T19:44:19.836Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:50:17.051Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/network" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:49.843Z", "transactionReference": "7a5d0292-251f-48ed-a5c0-13c4c78d4487", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:45.962Z", "transactionReference": "89197aeb-c94a-456e-8014-1272fbcb64eb", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:31.410Z", "transactionReference": "db0eea07-cd96-417f-8f78-90cc3908c81b", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } } ] } }
https://try.access.worldpay.com/paymentQueries/archivedPayments
https://access.worldpay.com/paymentQueries/archivedPayments
No request payload
Query payments within a specified date time range
{ "_links": { "self": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-31T21:30:20Z&pageSize=5" }, "next": { "href": "/paymentQueries/payments?startDate=2024-04-28T21:30:20Z&endDate=2024-05-30T09:49:31.410Z&paymentId=44809b32-6b71-4bd0-9b8c-ac29beb65059&pageSize=5" } }, "_embedded": { "payments": [ { "timestamp": "2024-05-30T19:44:19.836Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:50:17.051Z", "transactionReference": "Memory265-13/08/1876", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/network" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:49.843Z", "transactionReference": "7a5d0292-251f-48ed-a5c0-13c4c78d4487", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:45.962Z", "transactionReference": "89197aeb-c94a-456e-8014-1272fbcb64eb", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain" }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } }, { "timestamp": "2024-05-30T09:49:31.410Z", "transactionReference": "db0eea07-cd96-417f-8f78-90cc3908c81b", "transactionType": "oneTime", "authorizationType": "authorization", "entity": "default", "paymentInstrument": { "type": "card/plain+masked", "card": { … } }, "value": { "currency": "GBP", "amount": 250 }, "_links": { "self": { … } } } ] } }