SCA Exemptions

SCA Exemptions (1)

Download OpenAPI specification:Download

License: Worldpay

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

Servers

testing (try)

https://try.access.worldpay.com/

live

https://access.worldpay.com/

Exemption Assessment

Assess for exemption.

SecurityHTTP: BasicAuth

Request

header Parameters

Content-Type	string Example: application/vnd.worldpay.exemptions-v1.hal+json
Accept	string Example: application/vnd.worldpay.exemptions-v1.hal+json

Request Body schema: application/vnd.worldpay.exemptions-v1.hal+json

transactionReference required	string [ 1 .. 64 ] characters ^[-A-Za-z0-9_!@#$%()=.:;?\[\]{}~`/+]$ A unique reference for authentication. For example, e-commerce order code.
required	object An object that contains information about the merchant and API level configuration.
required	object The object that contains all the payment information related to the authentication request.
doNotApplyExemption	boolean 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.
	object An object that holds risk related information that might help in improving the accuracy of fraud assessment.
	object Object containing device data information.

post
/exemptions/assessment

Request samples

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

200

The authentication has been created

Response Schema: application/vnd.worldpay.exemptions-v1.hal+json

outcome required	string The outcome of the exemption assessment request. Enum: "noExemption" "exemption"
transactionReference required	string [ 1 .. 64 ] characters A unique reference for assessment that was passed in the request.
required	object An object that holds the risk profile link.
	object An object that holds information about the exemption if it is granted.

400

Assessment request contains invalid values

401

Assessment request is unauthorized

503

The requested service is unavailable

Response samples