Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.
Access Worldpay
/
SCA Exemptions

SCA Exemptions (1)

Maximize a frictionless checkout experience by using issuer data insights to apply exemptions. Exemptions are supported for Visa, Mastercard and Maestro.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License Worldpay
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Exemption Assessment

Request

Assess for exemption.

Headers
Content-Typestring
Example:

application/vnd.worldpay.exemptions-v1.hal+json

Acceptstring
Example:

application/vnd.worldpay.exemptions-v1.hal+json

Bodyapplication/vnd.worldpay.exemptions-v1.hal+json
transactionReferencestring[ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$required

A unique reference for authentication. For example, e-commerce order code.

merchantobjectrequired

An object that contains information about the merchant and API level configuration.

entitystring[ 1 .. 64 ] characters^[A-Za-z0-9 ]*$required

Used to route the request in Access Worldpay, created as part of on-boarding.

instructionobjectrequired

The object that contains all the payment information related to the authentication request.

valueobjectrequired

An object that contains information about the value of the authentication.

amountinteger[ 0 .. 999999999 ]required

The authentication amount. This is a whole number with an exponent.

currencystring= 3 characters^[A-Z]{3}$required

The three digit currency code.

paymentInstrumentanyrequired

An object that contains the card details or token location.

typestring(card/front)required

An identifier for the paymentInstrument being used.

Discriminator
cardExpiryDateobjectrequired

Object containing card expiry information

cardNumberstring[ 10 .. 19 ] characters^[0-9]*$required

Clear card number (PAN)

billingAddressobject

An object containing the billing address information.

cardHolderNamestring[ 1 .. 255 ] charactersrequired

The name on the customer's card.

doNotApplyExemptionboolean

Request an exemption but don't apply it in the payment. Used for the initial go-live to build up the data model and have more reliable exemption predictions.

riskDataobject

An object that holds risk related information that might help in improving the accuracy of fraud assessment.

accountobject

Object containing all customer account related risk data.

emailstring[ 3 .. 254 ] characters^.+@.+$

The customer's email address.

dateOfBirthstring(date)[ 1 .. 20 ] characters

The customer's date of birth.

shopperIdstring[ 1 .. 128 ] characters

A unique identifier for the customer. Use it to create manual fraud rules and identify your customers.

transactionobject

Object containing all customer transaction related risk data.

firstNamestring[ 1 .. 22 ] characters^[a-zA-Z]*$

Customer's first name.

lastNamestring[ 1 .. 22 ] characters^[a-zA-Z]*$

Customer's last name.

phoneNumberstring[ 4 .. 20 ] characters^[0-9]*$

Customer's phone number.

shippingobject

Object containing all data related to how the order is shipped.

firstNamestring[ 1 .. 22 ] characters^[a-zA-Z]*$

First name of the shipping recipient.

lastNamestring[ 1 .. 22 ] characters^[a-zA-Z]*$

Last name of the shipping recipient.

addressobject

An object containing the shipping address information.

customobject

Object containing custom fields

number1integer[ -2147483648 .. 2147483647 ]

Custom number field 1

number2integer[ -2147483648 .. 2147483647 ]

Custom number field 2

number3integer[ -2147483648 .. 2147483647 ]

Custom number field 3

number4integer[ -2147483648 .. 2147483647 ]

Custom number field 4

number5integer[ -2147483648 .. 2147483647 ]

Custom number field 5

number6integer[ -2147483648 .. 2147483647 ]

Custom number field 6

number7integer[ -2147483648 .. 2147483647 ]

Custom number field 7

number8integer[ -2147483648 .. 2147483647 ]

Custom number field 8

number9integer[ -2147483648 .. 2147483647 ]

Custom number field 9

number10integer[ -2147483648 .. 2147483647 ]

Custom number field 10

string1string[ 1 .. 100 ] characters

Custom string field 1

string2string[ 1 .. 100 ] characters

Custom string field 2

string3string[ 1 .. 100 ] characters

Custom string field 3

string4string[ 1 .. 100 ] characters

Custom string field 4

string5string[ 1 .. 100 ] characters

Custom string field 5

string6string[ 1 .. 100 ] characters

Custom string field 6

string7string[ 1 .. 100 ] characters

Custom string field 7

string8string[ 1 .. 100 ] characters

Custom string field 8

string9string[ 1 .. 100 ] characters

Custom string field 9

string10string[ 1 .. 100 ] characters

Custom string field 10

deviceDataobject

Object containing device data information.

collectionReferencestring[ 30 .. 128 ] characters^[A-Za-z0-9_-]*$

Use the sessionId specified in the ThreatMetrix Device Data Collection to link this data to the assessment.

application/vnd.worldpay.exemptions-v1.hal+json

An Exemption assessment request using a cardPaymentInstrument where noExemption fraud assessment is returned

{
  "transactionReference": "reference",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "paymentInstrument": {
      "type": "card/front",
      "cardHolderName": "ex-noExemption",
      "cardNumber": "4444333322221111",
      "cardExpiryDate": {
        "month": 5,
        "year": 2035
      },
      "billingAddress": {
        "address1": "Worldpay",
        "address2": "1 Milton Road",
        "address3": "The Science Park",
        "postalCode": "CB4 0WE",
        "city": "Cambridge",
        "state": "Cambridgeshire",
        "countryCode": "GB"
      }
    },
    "value": {
      "currency": "GBP",
      "amount": 250
    }
  },
  "riskData": {
    "account": {
      "email": "test@test.com",
      "dateOfBirth": "1990-09-09",
      "shopperId": "shopperId123"
    },
    "transaction": {
      "firstName": "John",
      "lastName": "Appleseed",
      "phoneNumber": "00000000000000"
    },
    "shipping": {
      "firstName": "Bob",
      "lastName": "Smith",
      "address": {
        "address1": "Worldpay",
        "address2": "1 Milton Road",
        "address3": "The Science Park",
        "postalCode": "CB4 0WE",
        "city": "Cambridge",
        "state": "Cambridgeshire",
        "countryCode": "GB",
        "phoneNumber": "00000000000000"
      }
    }
  }
}

Responses

The authentication has been created

Bodyapplication/vnd.worldpay.exemptions-v1.hal+json
outcomestringrequired

The outcome of the exemption assessment request.

Enum"noExemption""exemption"
transactionReferencestring[ 1 .. 64 ] charactersrequired

A unique reference for assessment that was passed in the request.

riskProfileobjectrequired

An object that holds the risk profile link.

hrefstring(uri)[ 30 .. 1024 ] charactersrequired

A link to a resource to be used in the payment authorisation request that represents the outcome of exemption assessment.

exemptionobject

An object that holds information about the exemption if it is granted.

placementstringrequired

Indicates whether the exemption is provided to be placed in a payment authorization request or 3DS authentication request.

Enum"authorization""authentication"
typestringrequired

The type of exemption to apply.

Enum"lowValue""lowRisk"
Response
application/vnd.worldpay.exemptions-v1.hal+json

An Exemption assessment request using a cardPaymentInstrument where noExemption fraud assessment is returned

{
  "outcome": "noExemption",
  "transactionReference": "reference",
  "riskProfile": {
    "href": "https://access.worldpay.com/riskProfile/ewogICJ2IiA6IDEsCiAgImsiIDogMSwKICAiZCIgOiAiU1BtQ0VmZXl3WmlQeFJjVkZqQmExZkpyUlBLYkNjRUtyRVlkL25KY1lYeXBQcDVZTmUrTmVGMjRzRjEyb2VGTFRtSkhtcDMwaSsyZE5uOGl3bURVSXMzaDUyNk5jNVNlSU9Ec0dUVzAwYlNneFdVSlpOeEdHZk9GRGZuU0pNYXl6N2Faek9Qc1JFL1Iva01NYkxpNHNiM1d3MlVxSkk1VVRFNXlPYnM2NUpmZGxqWlBkc0FqaHV4cnl0OHFISEgvTi82d1ZTazJwb2t0RnFON2F6Q2RsZkZvdlVGMVl4ZnAvaGlUME1wdVZ1dTFKc2twa1k1OERubnVjNkRVaXphWnhHVUc5SVFNOERkMjNleEhSSzQ2bWpIRk5xY2QvOEFHWDJrcGd3Vk9KeGJ4NFNOUGRNc2NUM0lJdkpQTXBpTHQwWHFMbEUzQmQwOWdPSnJ1R0kyUlIwREdWZ2t6OUFzNjVmaWEwRmU3L2MvZFdBUHI1RHhmTzNDK0ZQWGNJck8rQ28zRDdnUW1mbGZHbzRtR25VTHZnZjFjKzNoSm5xNXpYR2ZoRWh1NWUzM0s3Um0zWVRvTENkR2YvNi9aa2Zyd3JZYzZmWW1HVUpkZjN2VjRJNVB1TkE9PSIKfQ"
  }
}