Skip to content
APIs/SCA Exemptions/
Exemption assessment

Last updated: 30 September 2024 | Change log

Exemption assessment

POST your request to the exemptions:assess action link.

Assessment example request

POST https://try.access.worldpay-bsh.securedataplatform.com/exemptions/assessment

Risk assessment request body:

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

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"
      }
    }
  }
}

View the full API request schema

Assessment responses

The response contains the outcome of your assessment request.

Applying the exemption

You must apply the riskProfile from the exemption assessment response in the Card Payments API to link the Worldpay payment and apply the exemption that was granted.

See applying the exemption for details.

Note:
  • We return a WP-CorrelationId in the headers of service responses. We highly recommend you log this. We can use the WP-CorrelationId to examine individual service requests.
  {
      "outcome": "exemption",
      "transactionReference": "Memory265-13/08/1876",
      "exemption": {
          "placement": "authorization",
          "type": "lowValue"
      },
      "riskProfile": {
          "href": "https://access.worldpay-bsh.securedataplatform.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"
      }
  }

View the full API response schema

Applying the exemption

If the placement is authorization

In the event that the exemption is not successful (honoured + authorized) when applied in the payment, the issuer responds with a soft decline (refusal code 65). The next logical step is, to proceed with 3DS authentication.

If the placement is authentication

If no exemption is provided

Next steps

Exemption testing