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 Query a payment API

The Query a payment API from Worldpay — 2 operation(s) for query a payment.

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

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

This API exposes 2 operations across 2 paths, and defines 4 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.

2 operations 2 paths 4 schemas 2 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 Query a payment API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Query a payment 2
GET
/payments/events/{linkData}
Query payment status
eventQuery 3 params → 200400401404415500
GET
/payments/events
Query payment status recovery
eventRecovery 2 params → 200400401404415500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ValidationErrorResponse (3 properties), ErrorResponse (2 properties), payments_events_recovery_200_response (1 property), payments_events_200_response (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties
ValidationErrorResponse
object
3 properties
payments_events_200_response
object
1 property 1 required
payments_events_recovery_200_response
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-query-a-payment-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