Card Verification / Name Inquiry

Request

Verify your customer's card.
Perform a name inquiry to verify the name of the cardholder.

Security

BasicAuth

Acceptstringrequired

Example:application/vnd.worldpay.cardVerifications-v6+json

Content-Typestringrequired

Example:application/vnd.worldpay.cardVerifications-v6+json

Bodyapplication/vnd.worldpay.cardverifications-v6+jsonrequired

Card verification or Cardholder Name Inquiry.

One of:

typestringrequired

Value:"cardVerification"

merchantobjectrequired

Information about the merchant.

transactionReferencestring^[A-Za-z0-9\-_\/!@#$%*=.:;?[\]{}~+]{1,64}$required

A unique reference generated by you. It is used to identify a payment throughout its lifecycle.

64 characters max. We recommend your transactionReference contains between 9-20 characters for ease of onward processing.

Example:"Memory265-13/08/1876"

instructionobjectrequired

channelstring

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 Telephone Order transaction. When channel is not provided, the authorization will be processed as ecommerce ecom by default.

NOTE: 3DS authentication data cannot be supplied for MOTO payments.

Enum:"moto""ecom"

authenticationobject

threeDS can apply OPTIONALLY to any paymentInstrument other than Apple Pay
networkToken only applies to payment instruments: card/networkToken and card/networkToken+applepay networkToken should be mandatory for these instruments
For paymentInstrument card/networkToken then the threeDS object can optionally be supplied along with the networkToken one

recipientobject

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 compliant and avoid potential acquirer refusals.

{
  "type": "cardVerification",
  "merchant": {
    "entity": "default",
    "mcc": "6012",
    "paymentFacilitator": {
      "schemeId": "12345678901",
      "independentSalesOrganizationId": "12345678901",
      "subMerchant": {
        "name": "Merchant Plc",
        "reference": "12345",
        "address": {
          "street": "123 Street",
          "state": "CA",
          "city": "San Francisco",
          "countryCode": "US",
          "postalCode": "94101"
        },
        "taxReference": "12345",
        "phoneNumber": "0123456789",
        "email": "test@email.com",
        "url": "developer.worldpay.com"
      }
    }
  },
  "transactionReference": "Memory265-13/08/1876",
  "instruction": {
    "value": {
      "amount": 250,
      "currency": "GBP"
    },
    "narrative": {
      "line1": "MindPalace",
      "line2": "Memory"
    },
    "customerAgreement": {
      "type": "cardOnFile"
    },
    "paymentInstrument": {
      "type": "card/plain",
      "cardHolderName": "Sherlock Holmes",
      "expiryDate": {
        "month": 5,
        "year": 2050
      },
      "cardNumber": "4444333322221111",
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "Cambridge",
        "countryCode": "GB"
      },
      "cvc": "101"
    }
  }
}

Responses

Successful cardholder name inquiry outcome.

Headers

WP-CorrelationIdstring

This will be echoed from the request header of the same name

Bodyapplication/vnd.worldpay.cardverifications-v6+json

One of:

outcomestring

Result of the Card Verification

Enum:"verified""not verified"

nameInquirystring

Result of the Cardholder Name Inquiry

Enum:"matched""partialMatched""notMatched""notChecked""notSupported"

Response

{
  "outcome": "verified",
  "nameInquiry": "matched"
}