Assessment
Assess for exemption
Methods
POST
Assess for exemption
Request
Copied!
{
"type": "object",
"required": [
"transactionReference",
"merchant",
"instruction"
],
"properties": {
"transactionReference": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$"
},
"merchant": {
"type": "object",
"required": [
"entity"
],
"properties": {
"entity": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9 ]*$"
}
}
},
"doNotApplyExemption": {
"type": "boolean"
},
"instruction": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"minimum": 0,
"maximum": 999999999
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[A-Z]{3}$"
}
},
"required": [
"amount",
"currency"
]
},
"paymentInstrument": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "card/front"
},
"billingAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"address1": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"address2": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"address3": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"countryCode": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
}
},
"required": [
"address1",
"city",
"postalCode",
"countryCode"
]
},
"cardHolderName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cardExpiryDate": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"year": {
"type": "integer",
"minimum": 1,
"maximum": 9999
}
},
"required": [
"month",
"year"
]
},
"cardNumber": {
"type": "string",
"minLength": 10,
"maxLength": 19,
"pattern": "^[0-9]*$"
}
},
"required": [
"type",
"cardNumber",
"cardExpiryDate"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "card/tokenized"
},
"href": {
"type": "string",
"minLength": 1
}
},
"required": [
"type",
"href"
]
}
]
}
},
"required": [
"value",
"paymentInstrument"
]
},
"riskData": {
"type": "object",
"properties": {
"account": {
"type": "object",
"properties": {
"email": {
"type": "string",
"minLength": 3,
"maxLength": 254,
"pattern": "^.+@.+$"
},
"dateOfBirth": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"format": "date"
}
}
},
"transaction": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 22,
"pattern": "^[a-zA-Z]*$"
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 22,
"pattern": "^[a-zA-Z]*$"
},
"phoneNumber": {
"type": "string",
"minLength": 4,
"maxLength": 20,
"pattern": "^[0-9]*$"
}
}
},
"shipping": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 22,
"pattern": "^[a-zA-Z]*$"
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 22,
"pattern": "^[a-zA-Z]*$"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"address1": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"address2": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"address3": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"postalCode": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"countryCode": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"phoneNumber": {
"type": "string",
"minLength": 4,
"maxLength": 20,
"pattern": "^[0-9]*$"
}
},
"required": [
"address1",
"city",
"postalCode",
"countryCode"
]
}
}
}
}
},
"deviceData": {
"type": "object",
"properties": {
"collectionReference": {
"type": "string",
"minLength": 30,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]*$"
}
}
}
}
}{ "type": "object", "required": [ "transactionReference", "merchant", "instruction" ], "properties": { "transactionReference": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$" }, "merchant": { "type": "object", "required": [ "entity" ], "properties": { "entity": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9 ]*$" } } }, "doNotApplyExemption": { "type": "boolean" }, "instruction": { "type": "object", "properties": { "value": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "maximum": 999999999 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" } }, "required": [ "amount", "currency" ] }, "paymentInstrument": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "card/front" }, "billingAddress": { "type": "object", "properties": { "city": { "type": "string", "minLength": 1, "maxLength": 50 }, "state": { "type": "string", "minLength": 1, "maxLength": 30 }, "address1": { "type": "string", "minLength": 1, "maxLength": 80 }, "address2": { "type": "string", "minLength": 1, "maxLength": 80 }, "address3": { "type": "string", "minLength": 1, "maxLength": 80 }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 15 }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[A-Z]{2}$" } }, "required": [ "address1", "city", "postalCode", "countryCode" ] }, "cardHolderName": { "type": "string", "minLength": 1, "maxLength": 255 }, "cardExpiryDate": { "type": "object", "properties": { "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "year": { "type": "integer", "minimum": 1, "maximum": 9999 } }, "required": [ "month", "year" ] }, "cardNumber": { "type": "string", "minLength": 10, "maxLength": 19, "pattern": "^[0-9]*$" } }, "required": [ "type", "cardNumber", "cardExpiryDate" ] }, { "type": "object", "properties": { "type": { "type": "string", "const": "card/tokenized" }, "href": { "type": "string", "minLength": 1 } }, "required": [ "type", "href" ] } ] } }, "required": [ "value", "paymentInstrument" ] }, "riskData": { "type": "object", "properties": { "account": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254, "pattern": "^.+@.+$" }, "dateOfBirth": { "type": "string", "minLength": 1, "maxLength": 20, "format": "date" } } }, "transaction": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 22, "pattern": "^[a-zA-Z]*$" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 22, "pattern": "^[a-zA-Z]*$" }, "phoneNumber": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[0-9]*$" } } }, "shipping": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 22, "pattern": "^[a-zA-Z]*$" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 22, "pattern": "^[a-zA-Z]*$" }, "address": { "type": "object", "properties": { "city": { "type": "string", "minLength": 1, "maxLength": 50 }, "state": { "type": "string", "minLength": 1, "maxLength": 30 }, "address1": { "type": "string", "minLength": 1, "maxLength": 80 }, "address2": { "type": "string", "minLength": 1, "maxLength": 80 }, "address3": { "type": "string", "minLength": 1, "maxLength": 80 }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 15 }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[A-Z]{2}$" }, "phoneNumber": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[0-9]*$" } }, "required": [ "address1", "city", "postalCode", "countryCode" ] } } } } }, "deviceData": { "type": "object", "properties": { "collectionReference": { "type": "string", "minLength": 30, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]*$" } } } } }
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"noExemption",
"exemption"
]
},
"transactionReference": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"exemption": {
"type": "object",
"properties": {
"placement": {
"type": "string",
"enum": [
"authorization",
"authentication"
]
},
"type": {
"type": "string",
"enum": [
"lowValue",
"lowRisk"
]
}
},
"required": [
"placement",
"type"
]
},
"riskProfile": {
"type": "object",
"properties": {
"href": {
"type": "string",
"minLength": 30,
"maxLength": 1024,
"format": "uri"
}
},
"required": [
"href"
]
}
},
"required": [
"outcome",
"transactionReference",
"riskProfile"
]
}{ "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "noExemption", "exemption" ] }, "transactionReference": { "type": "string", "minLength": 1, "maxLength": 64 }, "exemption": { "type": "object", "properties": { "placement": { "type": "string", "enum": [ "authorization", "authentication" ] }, "type": { "type": "string", "enum": [ "lowValue", "lowRisk" ] } }, "required": [ "placement", "type" ] }, "riskProfile": { "type": "object", "properties": { "href": { "type": "string", "minLength": 30, "maxLength": 1024, "format": "uri" } }, "required": [ "href" ] } }, "required": [ "outcome", "transactionReference", "riskProfile" ] }
Link relationship
exemptions:assessAssess for exemption
An Exemption assessment request using a cardPaymentInstrument where noExemption fraud assessment is returned
POSThttps://try.access.worldpay.com/exemptions/assessment
Copied!
{
"Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=",
"Content-Type": "application/vnd.worldpay.exemptions-v1.hal+json"
}{ "Authorization": "Basic dXNlcjE6cGFzc3dvcmQ=", "Content-Type": "application/vnd.worldpay.exemptions-v1.hal+json" }
Copied!
{
"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"
},
"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"
}
}
}
}{ "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" }, "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" } } } }
200
Copied!
{
"Content-Type": "application/vnd.worldpay.exemptions-v1.hal+json"
}{ "Content-Type": "application/vnd.worldpay.exemptions-v1.hal+json" }
Copied!
{
"outcome": "noExemption",
"transactionReference": "reference",
"riskProfile": {
"href": "https://access.worldpay.com/riskProfile/ewogICJ2IiA6IDEsCiAgImsiIDogMSwKICAiZCIgOiAiU1BtQ0VmZXl3WmlQeFJjVkZqQmExZkpyUlBLYkNjRUtyRVlkL25KY1lYeXBQcDVZTmUrTmVGMjRzRjEyb2VGTFRtSkhtcDMwaSsyZE5uOGl3bURVSXMzaDUyNk5jNVNlSU9Ec0dUVzAwYlNneFdVSlpOeEdHZk9GRGZuU0pNYXl6N2Faek9Qc1JFL1Iva01NYkxpNHNiM1d3MlVxSkk1VVRFNXlPYnM2NUpmZGxqWlBkc0FqaHV4cnl0OHFISEgvTi82d1ZTazJwb2t0RnFON2F6Q2RsZkZvdlVGMVl4ZnAvaGlUME1wdVZ1dTFKc2twa1k1OERubnVjNkRVaXphWnhHVUc5SVFNOERkMjNleEhSSzQ2bWpIRk5xY2QvOEFHWDJrcGd3Vk9KeGJ4NFNOUGRNc2NUM0lJdkpQTXBpTHQwWHFMbEUzQmQwOWdPSnJ1R0kyUlIwREdWZ2t6OUFzNjVmaWEwRmU3L2MvZFdBUHI1RHhmTzNDK0ZQWGNJck8rQ28zRDdnUW1mbGZHbzRtR25VTHZnZjFjKzNoSm5xNXpYR2ZoRWh1NWUzM0s3Um0zWVRvTENkR2YvNi9aa2Zyd3JZYzZmWW1HVUpkZjN2VjRJNVB1TkE9PSIKfQ"
}
}{ "outcome": "noExemption", "transactionReference": "reference", "riskProfile": { "href": "https://access.worldpay.com/riskProfile/ewogICJ2IiA6IDEsCiAgImsiIDogMSwKICAiZCIgOiAiU1BtQ0VmZXl3WmlQeFJjVkZqQmExZkpyUlBLYkNjRUtyRVlkL25KY1lYeXBQcDVZTmUrTmVGMjRzRjEyb2VGTFRtSkhtcDMwaSsyZE5uOGl3bURVSXMzaDUyNk5jNVNlSU9Ec0dUVzAwYlNneFdVSlpOeEdHZk9GRGZuU0pNYXl6N2Faek9Qc1JFL1Iva01NYkxpNHNiM1d3MlVxSkk1VVRFNXlPYnM2NUpmZGxqWlBkc0FqaHV4cnl0OHFISEgvTi82d1ZTazJwb2t0RnFON2F6Q2RsZkZvdlVGMVl4ZnAvaGlUME1wdVZ1dTFKc2twa1k1OERubnVjNkRVaXphWnhHVUc5SVFNOERkMjNleEhSSzQ2bWpIRk5xY2QvOEFHWDJrcGd3Vk9KeGJ4NFNOUGRNc2NUM0lJdkpQTXBpTHQwWHFMbEUzQmQwOWdPSnJ1R0kyUlIwREdWZ2t6OUFzNjVmaWEwRmU3L2MvZFdBUHI1RHhmTzNDK0ZQWGNJck8rQ28zRDdnUW1mbGZHbzRtR25VTHZnZjFjKzNoSm5xNXpYR2ZoRWh1NWUzM0s3Um0zWVRvTENkR2YvNi9aa2Zyd3JZYzZmWW1HVUpkZjN2VjRJNVB1TkE9PSIKfQ" } }
