Worldpay Verifications API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Verifications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
3 operations
across 3 paths,
and defines 43 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 operations3 paths43 schemas3 POST
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 Verifications 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 POST. Each is listed below with its method, path, parameters, and response codes.
Generate required data for 3DS Device Data Collection
deviceDataInitialize2 paramsbody→ 200400502503
POST
/verifications/customers/3ds/authentication
Initiate the 3DS authentication
authenticate2 paramsbody→ 200400502503
POST
/verifications/customers/3ds/verification
Verify the 3DS challenge response
verify2 paramsbody→ 200400502503
Schemas 43
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are authenticationResponseCartesBancaires (11 properties), 3DS_verify_400_response (8 properties), 3DS_deviceDataInitialize_400_response (8 properties), 3DS_authenticate_400_response (8 properties). Each schema is shown below with its type and property counts.
3DS_verify_200_response_unavailable
object
4 properties
3DS_authenticate
object
6 properties5 required
3DS_deviceDataInitialize_502_response
object
5 properties2 required
3DS_authenticate_200_response_unavailable
object
3 properties1 required
enrolled
string
Status of authentication eligibility. - Y - Bank is participating in 3DS - N - Bank is not participating in 3DS - U - The Directory Server (DS) or Access Contr…
status
string
Indicates the outcome of the authentication or verification request. - Y - Successful authentication - N - Failed authentication - U - Unable to complete authe…
3DS_deviceDataInitialize_200_response
object
4 properties2 required
3DS_authenticate_200_response
object
7 properties1 required
3DS_verify_400_response
object
8 properties2 required
3DS_verify_200_response
object
7 properties
deviceDataCollection
object
Object containing device data collection related information
Object that contains authentication related information.
11 properties
3DS_verify_200_response_failed
object
7 properties
card_front
object
5 properties3 required
validation_errors
object
3 properties3 required
3DS_authenticate_200_response_cartes_bancaires
object
7 properties1 required
transactionReference
string
A unique reference for authentication. For example, e-commerce order code. Use the same transactionReference across all 3 potential request types (deviceDataIn…
merchant
object
An object that contains information about the merchant and API level configuration.
1 property1 required
3DS_deviceDataInitialize_503_response
object
5 properties2 required
transactionId
string
Directory server transaction Id, if provided should be used in the payment authorization authentication object
eci
string
Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication. | ECI | Meaning | |---|---| | 02 or 05 | Fully Authenticated Transaction…
version
string
The version of 3DS used to process the transaction.
acsTransactionId
string
An identifier assigned by the Access Control Server (ACS) to identify a single transaction. Used primarily for Mastercard 3RI subsequent transactions to link t…
3DS_deviceDataInitialize
object
3 properties2 required
card_tokenized
object
2 properties2 required
3DS_verify
object
3 properties3 required
billingAddress
object
An object containing the billing address information.
7 properties4 required
cardHolderName
string
The name on your customer's card. This is not a mandatory field, however we recommend that you supply this to improve authentication rates.
3DS_authenticate_challenged_200_response
object
5 properties1 required
3DS_authenticate_502_response
object
5 properties2 required
card_wallet_googlepay
object
3 properties2 required
challengeResponse
object
Object containing challenge related information in case of a "challenged" flow
4 properties
3DS_deviceDataInitialize_400_response
object
8 properties2 required
3DS_verify_200_response_signature_failed
object
4 properties
authentication
object
Object that contains authentication related information.
4 properties
3DS_authenticate_200_response_bypassed
object
6 properties1 required
authenticationValue
string
A cryptographic value that provides evidence of the outcome of a 3DS verification. - Visa - Cardholder Authentication Verification Value (CAVV) - Mastercard -…
