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 CardVerifications API

The CardVerifications API from Worldpay — 2 operation(s) for cardverifications.

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

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

This API exposes 2 operations across 2 paths, and defines 51 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 51 schemas 1 GET1 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 CardVerifications 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 — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

CardVerifications 2
POST
/cardVerifications
Card Verification / Name Inquiry
cardVerify 2 params body → 200201400401403404415500
GET
/cardVerifications/{linkData}
Query a previous verification
getCardVerificationByResourceId 3 params → 200400401403404415500

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are paymentInstrumentCardDetails (10 properties), response200 (9 properties), instruction (7 properties), typeCardVerification (7 properties). Each schema is shown below with its type and property counts.

typeCardVerification
object
7 properties 4 required
response200
object
9 properties 3 required
cardExpiryDate
object
The expiry date of the card
2 properties 2 required
paymentInstrument
An object that contains your customer's payment details.
subscription
object
2 properties 1 required
customerAgreementType
string
The processing arrangement agreed with your customer.
storedCardUsage
string
If this optional field is not provided, first will be used. Set to first for original verification or subsequent to use a previously stored card.
cardApplepayDecrypted
object
5 properties 3 required
type
object
cardToken-ani
object
3 properties 2 required
firstNameInquiry
string
given name
cardToken
object
4 properties 2 required
AccountNameInquiryResponseWithOutcomeNotVerifiedWithRefusalCode
object
5 properties
typeNameInquiry
object
3 properties 3 required
cardSamsungpayDecrypted
object
5 properties 3 required
channel
string
The payment channel indicates the interaction of the cardholder with the merchant. Supply a value of moto to process an authorization as a Mail Order or Teleph…
recipient
object
The details of the recipient of the payment. We highly recommend you supply this, if your MCC is 6012 or 6051. Sending this field ensures you remain PSD2 compl…
4 properties
riskFactors
array
List of risks involved in this verification.
2 required
nameInquiry
string
Result of the Cardholder Name Inquiry
merchant
object
Information about the merchant.
3 properties 1 required
instruction
object
7 properties 2 required
cardGooglepayDecrypted
object
5 properties 3 required
cardOnFile
object
2 properties 1 required
transactionReference
string
A unique reference generated by you. It is used to identify a payment throughout its lifecycle. 64 characters max. We recommend your transactionReference conta…
validationError
object
3 properties 2 required
unscheduled
object
2 properties 1 required
cardPlain-ani
object
4 properties 2 required
postalCode
string
Recipient's postal code.
outcome
string
Result of the Card Verification
middleNameInquiry
string
middle name or initial
AccountNameInquiryResponseWithRiskFactors
object
3 properties
cardExpiryDate-ani
object
The expiry date of the card. Must be present if CVC is provided
2 properties 2 required
AccountNameInquiryResponseWithOutcomeNotVerified
object
5 properties
cardNetworkToken
object
5 properties 3 required
refusalDescription
string
The [description of the 'refusalCode'](/products/reference/refusal-response)
refusalCode
string
The [refusal response code](/products/reference/refusal-response) from the acquirer
checkedAt
string
scheme
object
Card issuer's scheme (not all issuers return this)
1 property 1 required
lastNameInquiry
string
surname
paymentInstrument-ani
object
An object that contains your customer's payment details.
value
object
Currency and value of transaction. If value is nominal, retry is requested.
2 properties 1 required
authentication
object
threeDS can apply OPTIONALLY to any paymentInstrument other than Apple Pay networkToken only applies to payment instruments: card/networkToken and card/network…
2 properties
cardPlain
object
6 properties 3 required
cardHolder
object
An object with card holder's name details.
3 properties 1 required
installmentType
string
Defines the type of installments service. Only merchant is available for card verification.
aniMerchant
object
Information about the merchant.
1 property 1 required
lastName
string
surname
advice
object
The [MAC (Merchant Advice Code)](/products/reference/refusal-responserefusal-advice-codes) returned by Mastercard
1 property 1 required
installment
object
3 properties 1 required
AccountNameInquiryResponseMatched
object
3 properties
paymentInstrumentCardDetails
object
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-cardverifications-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