Determine the validity of the account to maximize authorization rates.
Determine the validity of the account to maximize authorization rates.
Card verification or Cardholder Name Inquiry.
Information about the merchant.
This should map to a profile from the Onboarding Domain. For more information contact your Relationship Manager or Implementation Manager.
A Merchant Category Code (MCC) can be applied to an individual request. You can only supply mcc
, if we have enabled the dynamic MCC feature during boarding. If enabled but not provided, merchant.mcc
defaults to a configured value. For more information contact your Relationship Manager or Implementation Manager.
6012
An object containing your payment facilitator information.
This parameter is only required for verification if you are a payment facilitator.
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.
"Memory265-13/08/1876"
If you are registered with Visa as a Consumer Bill Payment Service (CBPS), you must set this to true for any payments associated with the CBPS.
true
Set this field to true
to automatically retry a failed verification with a nominal amount. This only is in effect if no "value.amount" is submitted with the verification request.
true
Currency and value of transaction. If value is nominal, retry is requested.
Text to appear on the customer's billing statement. Sometimes referred to as a billing descriptor. If this isn't set, the value from your merchant profile is used.
An object that contains your customer's payment details.
An object that contains your customer's payment details.
An element that contains your customer's payment card number.
"4444333322221111"
An object containing the billing address information. Applicable for paymentInstrument type as card/plain only. If included you must send at least: [address1, city, countryCode, postalCode]
Contains specific customer agreements for the transaction.
Contains specific customer agreements for the transaction.
Contains details of the funds transfer request, which is a money movement for a reason other than the purchase of goods or services (also known as Account Funding Transaction).
Specify the type of the funds transfer.
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.
Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS verification.
02 or 05 - Fully Authenticated Transaction
01 or 06 - Attempted Authentication Transaction
00 or 07 - Non 3-D Secure Transaction
Mastercard - 02, 01, 00
Visa - 05, 06, 07
Amex - 05, 06, 07
JCB - 05, 06, 07
Diners - 05, 06, 07
"06"
A cryptographic value that provides evidence of the outcome of a 3DS verification.
Visa - Cardholder Authentication Verification Value (CAVV)
Mastercard - Universal Cardholder Authentication Field (UCAF)
For version 3DS2 authenticationValue is required if authentication.eci value is 01, 02, 05 or 06. It must be base64-encoded.
"AAIBBmISWQAAAAB3JxJZkAAAAAA="
Required, if authentication.eci value is 01, 02, 05 or 06. A unique authentication transaction identifier, generated by the issuer.
For version 3DS2: transactionId must be a UUID and 36 characters in length.
"a09b446d-5c0d-4003-9c99-21fb73d75999"
The version of 3DS used to process the transaction.
Only 3DS2 version 2.1.0 or more recent
"2.2.0"
"noPreference"
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": { "merchantId": "123456789012345", "name": "Example Shop", "street": "123 Street", "state": "CA", "city": "San Francisco", "countryCode": "826", "postalCode": "94101", "taxReference": "987-65-4321" } } }, "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" } } }
{ "outcome": "verified", "nameInquiry": "matched" }
Used to route the verification request in Access Worldpay, created as part of on-boarding.
Possible values: checking, savings, corporate, corporateSavings.
{ "merchant": { "entity": "default" }, "transactionReference": "1234567", "paymentInstrument": { "type": "bankAccountUS", "accountType": "corporateSavings", "accountNumber": "1234567890", "routingNumber": "011400495", "companyName": "companyName", "billToAddress": { "firstName": "John", "lastName": "Smith", "address1": "address1", "address2": "address2", "address3": "address3", "city": "city", "region": "state", "postalCode": "postalCode", "countryCode": "US", "telephoneNumber": "4085551212" } } }
{ "outcome": "verified", "checkedAt": "2021-09-27T18:02:16.475Z" }
No request payload
Successful query request
Card issuer's scheme (not all issuers return this)
"2024-03-26T19:38:29.543195Z"
List of risks involved in this verification.
[{"type":"cvc","risk":"notSupplied"},{"type":"avs","detail":"postcode","risk":"notSupplied"},{"type":"avs","detail":"address","risk":"notSupplied"}]
A bank identification number is the first four to six numbers that appear on payment cards.
654321
Querying of a successful verification for oneTime
{ "outcome": "verified", "checkedAt": "2018-09-01T10:37:36.923Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain+masked", "cardBin": "444433", "lastFour": "1111", "countryCode": "GB", "expiryDate": { "month": 12, "year": 2029 }, "brand": "visa", "fundingType": "debit", "issuerName": "cardIssuer", "category": "consumer", "paymentAccountReference": "reference" }, "_links": { "cardVerifications: verification": { "href": "https://try.access.worldpay.com/cardVerifications/{resource}" } } }