Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldpay PaymentQueries API

The PaymentQueries API from Worldpay — 3 operation(s) for paymentqueries.

Worldpay PaymentQueries API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PaymentQueries. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 45 schemas. It is described by OpenAPI 3.0.1, at version 3.

Requests are made against 2 base URLs: https://try.access.worldpay.com, https://access.worldpay.com.

3 operations 3 paths 45 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3
Base URL
https://access.worldpay.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Worldpay PaymentQueries API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

PaymentQueries 3
GET
/paymentQueries/payments
Query payments
queryByDateRange 11 params → 200400
GET
/paymentQueries/payments/{paymentId}
Retrieve a payment
retrieveByPaymentId 2 params → 200404
GET
/paymentQueries/archivedPayments
Query historical payments
queryArchivedPayments 3 params → 200400

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are pq_querybypaymentid_200_response (15 properties), authorizationRefused (6 properties), refundRequested (6 properties), saleRefused (6 properties). Each schema is shown below with its type and property counts.

authorizationTimedOut
object
3 properties 1 required
cancellationRequested
object
3 properties 1 required
reversalRequested
object
4 properties 1 required
reversalRequestSubmitted
object
3 properties 1 required
sentForSettlementLinks
object
1 property 1 required
reversalRequestSubmissionTimedOut
object
3 properties 1 required
authorizationSucceededLinks
object
1 property 1 required
saleRequested
object
3 properties 1 required
pq_querybydaterange_200_response
object
2 properties 2 required
saleTimedOut
object
3 properties 1 required
cancellationRequestSubmissionFailed
object
3 properties 1 required
partialSettleLinks
object
1 property 1 required
partialCancelLinks
object
1 property 1 required
reversalLinks
object
1 property 1 required
lastEvent
string
The last event received for the payment
refundRequestSubmissionTimedOut
object
3 properties 1 required
settlementRequested
object
6 properties 1 required
fullRefundLinks
object
1 property 1 required
refundRequested
object
6 properties 1 required
saleSucceeded
object
4 properties 1 required
authorizationFailed
object
4 properties 1 required
reversalRequestSubmissionFailed
object
3 properties 1 required
saleRefused
object
6 properties 1 required
refundRequestSubmissionFailed
object
3 properties 1 required
authorizationRequested
object
3 properties 1 required
fullSettleLinks
object
1 property 1 required
saleFailed
object
4 properties 1 required
settlementRequestSubmitted
object
3 properties 1 required
authorizationRefused
object
6 properties 1 required
authorizationSucceeded
object
4 properties 1 required
cancellationRequestSubmitted
object
3 properties 1 required
selfLinkOnly
object
1 property 1 required
pq_querybypaymentid_404_response
object
2 properties
pq_querybypaymentid_200_response
object
15 properties
cancellationRequestSubmissionTimedOut
object
3 properties 1 required
pq_queryhistoricalpayments_200_response
object
2 properties 2 required
fullCancelLinks
object
1 property 1 required
settlementRequestSubmissionFailed
object
3 properties 1 required
commandId
string
Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
partialRefundLinks
object
1 property 1 required
paymentId
string
Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
pq_querybydaterange_400_response
object
2 properties 2 required
pq_queryhistoricalpayments_400_response
object
2 properties 2 required
settlementRequestSubmissionTimedOut
object
3 properties 1 required
refundRequestSubmitted
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-paymentqueries-api-openapi.yml Raw ↑

Other APIs Worldpay publishes across the network.

Worldpay Tokens API
Worldpay Card Payouts API
Worldpay Account Payouts API
Worldpay FraudSight API
Worldpay 3DS API
Worldpay APMs API
Worldpay FX API
Worldpay Hosted Payment Pages API
Worldpay Events API
Worldpay Beneficiary Account Verifications API
Worldpay Split Payments API
Worldpay Statements API