- Home
- All APIs
- Access Worldpay
- Exemptions API
- Exemption assessment
Note: This API is for preview purposes only and is subject to change.
Exemption assessment
POST
your request to the exemptions:assess
action link.
Assessment example request
POST https://try.access.worldpay.com/exemptions/assessment
Risk assessment request body:
Copied!
{
"transactionReference": "unique-transactionReference",
"merchant": {
"entity": "default"
},
"instruction": {
"paymentInstrument": {
"type": "card/front",
"cardHolderName": "John Appleseed",
"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": "unique-transactionReference", "merchant": { "entity": "default" }, "instruction": { "paymentInstrument": { "type": "card/front", "cardHolderName": "John Appleseed", "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": "unique-transactionReference",
"merchant": {
"entity": "default"
},
"instruction": {
"paymentInstrument": {
"type": "card/tokenized",
"href": "https://try.access.worldpay.com/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"
},
"value": {
"currency": "GBP",
"amount": 250
}
},
"riskData": {
"account": {
"email": "test@test.com",
"dateOfBirth": "1990-09-09"
},
"transaction": {
"firstName": "John",
"lastName": "Appleseed",
"phoneNumber": "00000000000000"
},
"shipping": {
"address": {
"firstName": "Bob",
"lastName": "Smith",
"address1": "Worldpay",
"address2": "1 Milton Road",
"address3": "The Science Park",
"postalCode": "CB4 0WE",
"city": "Cambridge",
"state": "Cambridgeshire",
"countryCode": "GB",
"phoneNumber": "00000000000000"
}
}
}
}
{ "transactionReference": "unique-transactionReference", "merchant": { "entity": "default" }, "instruction": { "paymentInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay.com/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng" }, "value": { "currency": "GBP", "amount": 250 } }, "riskData": { "account": { "email": "test@test.com", "dateOfBirth": "1990-09-09" }, "transaction": { "firstName": "John", "lastName": "Appleseed", "phoneNumber": "00000000000000" }, "shipping": { "address": { "firstName": "Bob", "lastName": "Smith", "address1": "Worldpay", "address2": "1 Milton Road", "address3": "The Science Park", "postalCode": "CB4 0WE", "city": "Cambridge", "state": "Cambridgeshire", "countryCode": "GB", "phoneNumber": "00000000000000" } } } }
Parameter | Required | Description |
---|---|---|
transactionReference | A reference for the assessment. For example, e-commerce order code. | |
merchant.entity | Used to route the assessment request in Access Worldpay, created as part of on-boarding. | |
instruction | The object that contains all the payment information related to the assessment request. | |
instruction.paymentInstrument | An object that contains the card details or token location. | |
paymentInstrument.type | An identifier for the paymentInstrument being used.type : card/front
type : card/tokenized
| |
paymentInstrument.billingAddress | An object containing the billing address information. If included you must send at least:
|
Additional fields in Assessment request
We recommend providing this data, if you have it, as it improves the accuracy of the exemption assessment.
There are three riskData
objects you can include in your request:
Descriptions of your additional account riskData
parameters:
Parameter | Mandatory | Description |
---|---|---|
account | Object containing all customer account related risk data. | |
account.email | The customer's email address. | |
account.dateOfBirth | The customer's date of birth. |
Descriptions of your additional transaction riskData
parameters:
Parameter | Required | Description |
---|---|---|
transaction | Object containing all customer transaction related risk data. | |
transaction.firstName | Customer's first name. | |
transaction.lastName | Customer's last name. | |
transaction.phoneNumber | Customer's phone number. |
Descriptions of your additional shipping riskData
parameters:
Parameter | Required | Description |
---|---|---|
shipping | Object containing all data related to how the order is shipped. | |
shipping.firstName | First name used on the shipping address | |
shipping.lastName | Last name used on the shipping address | |
shipping.address | An object containing the shipping address information. If included you must send at least:
|
Assessment responses
The response contains the outcome of your assessment
request.
Copied!
{
"outcome": "exemption",
"transactionReference": "123456",
"exemption": {
"placement": "authentication",
"type": "lowRisk"
},
"riskProfile": {
"href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"
}
}
{ "outcome": "exemption", "transactionReference": "123456", "exemption": { "placement": "authentication", "type": "lowRisk" }, "riskProfile": { "href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ" } }
{
"outcome": "exemption",
"transactionReference": "123456",
"exemption": {
"placement": "authorization",
"type": "lowValue"
},
"riskProfile": {
"href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"
}
}
{ "outcome": "exemption", "transactionReference": "123456", "exemption": { "placement": "authorization", "type": "lowValue" }, "riskProfile": { "href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ" } }
{
"outcome": "noExemption",
"transactionReference": "123456",
"riskProfile": {
"href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"
}
}
{ "outcome": "noExemption", "transactionReference": "123456", "riskProfile": { "href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ" } }
Parameter | Description |
---|---|
outcome | The recommendation from exemptions:
outcomes and how to reproduce them, see |
exemption.placement |
|
exemption.type | The type of exemption to apply
|
riskProfile.href | A resource to be used in the payment authorisation request that represents the outcome of exemption assessment. Used to:
|
Next steps