Exemption assessment

Request

Assess for exemption.

Security

BasicAuth

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.

exemptionobject

An object that contains information about the type and placement of the requested exemption.

Note: If this object is not used in the request the capability is limited to authorizationOnly.

Default:"authorizationOnly"

instructionobjectrequired

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

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.

deviceDataobject

Object containing device data information.

Exemption assessment using the card instrument

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "doNotApplyExemption": false,
  "exemption": {
    "capability": "authorizationAndAuthentication",
    "request": {
      "placement": "authorization",
      "type": "lowValue"
    }
  },
  "instruction": {
    "paymentInstrument": {
      "type": "card/front",
      "cardHolderName": "Sherlock Holmes",
      "cardNumber": "4444333322221111",
      "cardExpiryDate": {
        "month": 5,
        "year": 2035
      },
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      }
    },
    "value": {
      "currency": "GBP",
      "amount": 250
    }
  },
  "deviceData": {
    "collectionReference": "0_4XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX8G6"
  },
  "riskData": {
    "account": {
      "email": "sherlock.holmes@example.com",
      "dateOfBirth": "1990-09-09"
    },
    "transaction": {
      "firstName": "Sherlock",
      "lastName": "Holmes",
      "phoneNumber": "00000000000000"
    },
    "shipping": {
      "firstName": "James",
      "lastName": "Moriarty",
      "address": {
        "address1": "The Palatine Centre",
        "address2": "Durham University",
        "address3": "Stockton Road",
        "postalCode": "DH1 3LE",
        "city": "Durham",
        "state": "County Durham",
        "countryCode": "GB",
        "phoneNumber": "01911234321"
      }
    }
  }
}

Responses

The authentication has been created

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

outcomestringrequired

The outcome of the exemption assessment request.

Enum Value	Description
noExemption	no exemption granted, proceed to 3DS authentication
exemption	exemption granted, follow placement and type

transactionReferencestring, [ 1 .. 64 ] charactersrequired

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

riskProfileobjectrequired

A resource you can use in the payment authorization request that represents the outcome of the exemption assessment. Used to:

apply the exemption (if provided)
update the data model so future assessments are more accurate

exemptionobject

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

Response

No exemption is granted, use 3DS authentication

{
  "outcome": "noExemption",
  "transactionReference": "Memory265-13/08/1876",
  "riskProfile": {
    "href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"
  }
}