{"items":[{"type":"link","label":"SCA Exemptions","link":"/products/sca-exemptions/openapi","routeSlug":"/products/sca-exemptions/openapi","content":{"contentType":"overview","meta":{"name":"SCA Exemptions"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/sca-exemptions/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/sca-exemptions/@v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"SCA Exemptions (1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions. Exemptions are supported for Visa, Mastercard and Maestro."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for any request you send to our Exemptions API. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept/Content-Type header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Content-Type: application/vnd.worldpay.exemptions-v1.hal+json\nAccept: application/vnd.worldpay.exemptions-v1.hal+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content-Type: application/vnd.worldpay.exemptions-v1.hal+json\nAccept: application/vnd.worldpay.exemptions-v1.hal+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Exemptions API. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Whitelist the following URLs:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay.com/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"danger","name":"Applying the exemption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You must apply the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the exemption assessment response in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/card-payments/authorize-a-payment#sca-exemptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Payments API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link the Worldpay payment and apply the exemption that was granted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/sca-exemptions/assessment#applying-the-exemption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applying the exemption"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details. "},"children":[]}]}]}]}]}],"sectionId":"/products/sca-exemptions/openapi"}],"sectionId":"/products/sca-exemptions/openapi"}]}]}},{"label":"Exemption assessment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/sca-exemptions/openapi/other/assessment","routeSlug":"/products/sca-exemptions/openapi/other/assessment","metadata":{"seo":{"title":"Exemption assessment","description":"Assess for exemption."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assessment","name":"Exemption assessment","isWebhook":false,"pointer":"/paths/~1exemptions~1assessment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exemption assessment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assess for exemption."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_431"},{"name":"Accept","in":"header","schemaId":"schema_431"}],"pointer":"/paths/~1exemptions~1assessment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment","exampleIds":["paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"]}},"schemaId":"components/schemas/exemptions_assessment","exampleIds":["paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"],"pointer":"/paths/~1exemptions~1assessment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exemptions/assessment","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/vnd.worldpay.exemptions-v1.hal+json","schemaId":"schema_431"},{"name":"Accept","in":"header","example":"application/vnd.worldpay.exemptions-v1.hal+json","schemaId":"schema_431"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment","exampleIds":["paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"]}},"responseCodes":["200","400","401","503"],"pointer":"/exemptions/assessment","href":"other/assessment","openApiOperationId":"assessment","summary":"Exemption assessment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/exemptions_assessment","exampleIds":["paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"],"mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment","exampleIds":["paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized","paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The authentication has been created","mediaType":"application/vnd.worldpay.exemptions-v1.hal+json","mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_200_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication"]}},"schemaId":"components/schemas/exemptions_assessment_200_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication"]},{"code":"400","description":"Assessment request contains invalid values","mediaType":"application/vnd.worldpay.exemptions-v1.hal+json","mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_400_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method"]}},"schemaId":"components/schemas/exemptions_assessment_400_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method"]},{"code":"401","description":"Assessment request is unauthorized","mediaType":"application/vnd.worldpay.exemptions-v1.hal+json","mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header"]}},"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header"]},{"code":"503","description":"The requested service is unavailable","mediaType":"application/vnd.worldpay.exemptions-v1.hal+json","mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1exemptions~1assessment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/exemptions_assessment_200_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication"],"mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_200_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization","paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication"]}}},{"code":"400","schemaId":"components/schemas/exemptions_assessment_400_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method"],"mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_400_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header","paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method"]}}},{"code":"401","schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header"],"mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header"]}}},{"code":"503","schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable"],"mediaTypes":["application/vnd.worldpay.exemptions-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.exemptions-v1.hal+json":{"schemaId":"components/schemas/exemptions_assessment_401_response","exampleIds":["paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/assessment"}],"panels":[]}]},"httpPath":"/exemptions/assessment"}],"store":{"schemaStore":{"components/schemas/billingAddress":{"id":"components/schemas/billingAddress","kind":"json-schema","title":"billingAddress","data":{"required":["address1","city","postalCode","countryCode"],"type":"object","description":"An object containing the billing address information.","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"Billing address city"},"address1":{"maxLength":80,"minLength":1,"type":"string","description":"Billing address line 1"},"postalCode":{"maxLength":15,"minLength":1,"type":"string","description":"Billing address postal code"},"countryCode":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","description":"Billing address country code"},"state":{"maxLength":30,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address state. Should only be provided following the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO-3611-2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" two-character sub division (e.g.“CA” for California)."},"children":[]}]}]}]},"address2":{"maxLength":80,"minLength":1,"type":"string","description":"Billing address line 2"},"address3":{"maxLength":80,"minLength":1,"type":"string","description":"Billing address line 3"}}}},"components/schemas/card_front":{"id":"components/schemas/card_front","kind":"json-schema","title":"card_front","data":{"required":["type","cardNumber","cardHolderName","cardExpiryDate"],"type":"object","properties":{"type":{"type":"string","format":"card/front","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being used."},"children":[]}]}]}]},"cardExpiryDate":{"required":["month","year"],"type":"object","description":"Object containing card expiry information","properties":{"month":{"maximum":12,"minimum":1,"type":"integer","description":"Card expiry month"},"year":{"maximum":9999,"minimum":1,"type":"integer","description":"Card expiry year"}}},"cardNumber":{"maxLength":19,"minLength":10,"pattern":"^[0-9]*$","type":"string","description":"Clear card number (PAN)."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"},"cardHolderName":{"maxLength":255,"minLength":1,"type":"string","description":"The name on the customer's card."}}}},"components/schemas/card_tokenized":{"id":"components/schemas/card_tokenized","kind":"json-schema","title":"card_tokenized","data":{"required":["type","href"],"type":"object","properties":{"type":{"type":"string","format":"card/tokenized","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being used."},"children":[]}]}]}]},"href":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address that contains your link to an Access Token"},"children":[]}]}]}]}}}},"components/schemas/card_networktoken":{"id":"components/schemas/card_networktoken","kind":"json-schema","title":"card_networktoken","data":{"required":["type","tokenNumber","cardExpiryDate"],"type":"object","properties":{"type":{"type":"string","format":"card/networkToken","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being used."},"children":[]}]}]}]},"cardExpiryDate":{"required":["month","year"],"type":"object","description":"Object containing card expiry information","properties":{"month":{"maximum":12,"minimum":1,"type":"integer","description":"Card expiry month"},"year":{"maximum":9999,"minimum":1,"type":"integer","description":"Card expiry year"}}},"tokenNumber":{"maxLength":19,"minLength":10,"pattern":"^[0-9]*$","type":"string","description":"The network token number"},"cardHolderName":{"maxLength":255,"minLength":1,"type":"string","description":"The name on the customer's card."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}}},"components/schemas/exemptions_assessment":{"id":"components/schemas/exemptions_assessment","kind":"json-schema","title":"exemptions_assessment","data":{"required":["transactionReference","merchant","instruction"],"type":"object","properties":{"transactionReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"A unique reference for authentication. For example, e-commerce order code."},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant and API level configuration.","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9 ]*$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding."}}},"exemption":{"required":["capability"],"type":"object","default":"authorizationOnly","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that contains information about the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested exemption."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If this object is not used in the request the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is limited to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationOnly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"capability":{"type":"string","enum":["authorizationOnly","authenticationOnly","authorizationAndAuthentication"],"x-enumDescriptions":{"authorizationOnly":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCA Exemptions service can only return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"authenticationOnly":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCA Exemptions service can only return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"authorizationAndAuthentication":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SCA Exemptions service can return either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":"Indicates whether the exemption requested from us, can return a placement of authorization (payment) and/or authentication (3DS)."},"request":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object used to control the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested exemption. If not provided, we decide the best placement and type (optimized)."},"children":[]}]}]}],"properties":{"placement":{"type":"string","default":"optimized","enum":["optimized","authorization","authentication"],"x-enumDescriptions":{"optimized":"We select the best performing placement based on its data.","authorization":"A request for an exemption placed within the authorization.","authentication":"A request for an exemption placed within the authentication (3DS)."},"description":"Defines where the exemption is being requested."},"type":{"type":"string","default":"optimized","enum":["optimized","lowValue","lowRisk"],"x-enumDescriptions":{"optimized":"We select the best performing type based on its data.","lowValue":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An exemption for an authorization that is under €30."},"children":[]}]}]}],"lowRisk":"An exemption for an authorization that has been through Transaction Risk Analysis (TRA)."},"description":"Defines which type of exemption is being requested."}}}}},"instruction":{"required":["value","paymentInstrument"],"type":"object","description":"The object that contains all the payment information related to the authentication request.","properties":{"value":{"required":["amount","currency"],"type":"object","description":"An object that contains information about the value of the authentication.","properties":{"amount":{"maximum":999999999,"minimum":0,"type":"integer","description":"The authentication amount. This is a whole number with an exponent."},"currency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string","description":"The three digit currency code."}}},"paymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/card_front"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_networktoken"}],"description":"An object that contains the card details or token location.","discriminator":{"mapping":{"card/front":"#/components/schemas/card_front","card/tokenized":"#/components/schemas/card_tokenized","card/networkToken":"#/components/schemas/card_networktoken"},"propertyName":"type"}}}},"doNotApplyExemption":{"type":"boolean","description":"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."},"riskData":{"type":"object","description":"An object that holds risk related information that might help in improving the accuracy of fraud assessment.","properties":{"account":{"type":"object","description":"Object containing all customer account related risk data.","properties":{"email":{"maxLength":254,"minLength":3,"pattern":"^.+@.+$","type":"string","description":"The customer's email address."},"dateOfBirth":{"maxLength":20,"minLength":1,"type":"string","format":"date","description":"The customer's date of birth."},"shopperId":{"maxLength":128,"minLength":1,"type":"string","description":"A unique identifier for the customer. Use it to create manual fraud rules and identify your customers."}}},"transaction":{"type":"object","description":"Object containing all customer transaction related risk data.","properties":{"firstName":{"maxLength":22,"minLength":1,"pattern":"^[a-zA-Z]*$","type":"string","description":"Customer's first name."},"lastName":{"maxLength":22,"minLength":1,"pattern":"^[a-zA-Z]*$","type":"string","description":"Customer's last name."},"phoneNumber":{"maxLength":20,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"Customer's phone number."}}},"shipping":{"type":"object","description":"Object containing all data related to how the order is shipped.","properties":{"firstName":{"maxLength":22,"minLength":1,"pattern":"^[a-zA-Z]*$","type":"string","description":"First name of the shipping recipient."},"lastName":{"maxLength":22,"minLength":1,"pattern":"^[a-zA-Z]*$","type":"string","description":"Last name of the shipping recipient."},"address":{"required":["address1","city","postalCode","countryCode"],"type":"object","description":"An object containing the shipping address information.","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"Shipping address city"},"address1":{"maxLength":80,"minLength":1,"type":"string","description":"Shipping address line 1"},"postalCode":{"maxLength":15,"minLength":1,"type":"string","description":"Postcode of shipping address"},"countryCode":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","description":"Shipping address country code"},"state":{"maxLength":30,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping address state. Should only be provided following the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO-3611-2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" two-character sub division (e.g.“CA” for California)."},"children":[]}]}]}]},"address2":{"maxLength":80,"minLength":1,"type":"string","description":"Shipping address line 2"},"address3":{"maxLength":80,"minLength":1,"type":"string","description":"Shipping address line 3"},"phoneNumber":{"maxLength":20,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"Shipping recipient's phone number."}}}}},"custom":{"type":"object","description":"Object containing custom fields","properties":{"number1":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 1"},"number2":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 2"},"number3":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 3"},"number4":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 4"},"number5":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 5"},"number6":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 6"},"number7":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 7"},"number8":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 8"},"number9":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 9"},"number10":{"maximum":2147483647,"minimum":-2147483648,"type":"integer","description":"Custom number field 10"},"string1":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 1"},"string2":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 2"},"string3":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 3"},"string4":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 4"},"string5":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 5"},"string6":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 6"},"string7":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 7"},"string8":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 8"},"string9":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 9"},"string10":{"maxLength":100,"minLength":1,"type":"string","description":"Custom string field 10"}}}}},"deviceData":{"type":"object","description":"Object containing device data information.","properties":{"collectionReference":{"maxLength":128,"minLength":30,"pattern":"^[A-Za-z0-9_-]*$","type":"string","description":"Use the sessionId specified in the ThreatMetrix Device Data Collection to link this data to the assessment."}}}}}},"components/schemas/exemptions_assessment_200_response":{"id":"components/schemas/exemptions_assessment_200_response","kind":"json-schema","title":"exemptions_assessment_200_response","data":{"required":["outcome","transactionReference","riskProfile"],"type":"object","properties":{"outcome":{"enum":["noExemption","exemption"],"x-enumDescriptions":{"noExemption":"no exemption granted, proceed to 3DS authentication","exemption":"exemption granted, follow placement and type"},"type":"string","description":"The outcome of the exemption assessment request."},"transactionReference":{"maxLength":64,"minLength":1,"type":"string","description":"A unique reference for assessment that was passed in the request."},"riskProfile":{"required":["href"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A resource you can use in the payment authorization request that represents the outcome of the exemption assessment. Used to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"apply the exemption (if provided)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update the data model so future assessments are more accurate"},"children":[]}]}]}]}],"properties":{"href":{"maxLength":1024,"minLength":30,"type":"string","format":"uri","description":"A link to a resource to be used in the payment authorisation request that represents the outcome of exemption assessment."}}},"exemption":{"required":["placement","type"],"type":"object","description":"An object that holds information about the exemption if it is granted.","properties":{"placement":{"enum":["authorization","authentication"],"x-enumDescriptions":{"authorization":"Apply the exemption in the payment authorization","authentication":"Apply the exemption in the 3DS authentication"},"type":"string","description":"Indicates whether the exemption is provided to be placed in a payment authorization request or 3DS authentication request.\n"},"type":{"enum":["lowValue","lowRisk"],"x-enumDescriptions":{"lowValue":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply a lowValue exemption, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(only applicable to a placement in authorization)"},"children":[]}]}]}]}],"lowRisk":"Apply a lowRisk exemption."},"type":"string","description":"The type of exemption to apply."}}}}}},"components/schemas/exemptions_assessment_400_response":{"id":"components/schemas/exemptions_assessment_400_response","kind":"json-schema","title":"exemptions_assessment_400_response","data":{"required":["message","errorName"],"type":"object","properties":{"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message"},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name"},"validationErrors":{"description":"Object containing details of validation errors occurred","type":"array","items":{"$ref":"#/components/schemas/validation_errors"}}}}},"components/schemas/exemptions_assessment_401_response":{"id":"components/schemas/exemptions_assessment_401_response","kind":"json-schema","title":"exemptions_assessment_401_response","data":{"required":["message","errorName"],"type":"object","properties":{"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message"},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name"}}}},"components/schemas/exemptions_assessment_503_response":{"id":"components/schemas/exemptions_assessment_503_response","kind":"json-schema","title":"exemptions_assessment_503_response","data":{"required":["message","errorName"],"type":"object","properties":{"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message"},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name"}}}},"components/schemas/validation_errors":{"id":"components/schemas/validation_errors","kind":"json-schema","title":"validation_errors","data":{"type":"object","required":["errorName","jsonPath","message"],"properties":{"errorName":{"maxLength":2048,"minLength":1,"type":"string","description":"Unique name of the validation error"},"jsonPath":{"maxLength":2048,"minLength":1,"type":"string","description":"Location of the field in request body for which the error occurred"},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"Error description message"}}}},"schema_431":{"kind":"json-schema","data":{"type":"string","example":"application/vnd.worldpay.exemptions-v1.hal+json"},"id":"schema_431"}},"exampleStore":{"components/examples/assessment-request-card":{"id":"components/examples/assessment-request-card","value":{"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"}}}},"description":"Exemption assessment using the card instrument"},"components/examples/assessment-request-token":{"id":"components/examples/assessment-request-token","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"doNotApplyExemption":false,"exemption":{"capability":"authorizationAndAuthentication","request":{"placement":"authorization","type":"lowValue"}},"instruction":{"paymentInstrument":{"type":"card/tokenized","href":"https://try.access.worldpay.com/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"},"value":{"currency":"GBP","amount":250}},"deviceData":{"collectionReference":"0_4XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX8G6"},"riskData":{"account":{"email":"test@test.com","dateOfBirth":"1990-09-09"},"transaction":{"firstName":"Sherlock","lastName":"Holmes","phoneNumber":"02031234321"},"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"}}}},"description":"Exemption assessment using a Worldpay Token"},"components/examples/assessment-request-networkToken":{"id":"components/examples/assessment-request-networkToken","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"doNotApplyExemption":false,"exemption":{"capability":"authorizationAndAuthentication","request":{"placement":"authorization","type":"lowValue"}},"instruction":{"paymentInstrument":{"type":"card/networkToken","tokenNumber":"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"}}}},"description":"Exemption assessment using a network token"},"components/examples/assessment-response-no-exemption":{"id":"components/examples/assessment-response-no-exemption","value":{"outcome":"noExemption","transactionReference":"Memory265-13/08/1876","riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"description":"No exemption is granted, use 3DS authentication"},"components/examples/assessment-response-exemption-authorization-lowvalue":{"id":"components/examples/assessment-response-exemption-authorization-lowvalue","value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authorization","type":"lowValue"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"description":"lowValue exemption granted to be applied in payment authorization request"},"components/examples/assessment-response-exemption-authorization-lowrisk":{"id":"components/examples/assessment-response-exemption-authorization-lowrisk","value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authorization","type":"lowRisk"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"description":"lowRisk exemption granted to be applied in payment authorization request"},"components/examples/assessment-response-exemption-authentication-lowrisk":{"id":"components/examples/assessment-response-exemption-authentication-lowrisk","value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authentication","type":"lowRisk"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"description":"lowRisk exemption granted to be applied in 3DS authentication request"},"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front":{"value":{"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"}}}},"key":"card/front","summary":"card/front","description":"Exemption assessment using the card instrument","id":"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1front"},"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"doNotApplyExemption":false,"exemption":{"capability":"authorizationAndAuthentication","request":{"placement":"authorization","type":"lowValue"}},"instruction":{"paymentInstrument":{"type":"card/tokenized","href":"https://try.access.worldpay.com/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"},"value":{"currency":"GBP","amount":250}},"deviceData":{"collectionReference":"0_4XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX8G6"},"riskData":{"account":{"email":"test@test.com","dateOfBirth":"1990-09-09"},"transaction":{"firstName":"Sherlock","lastName":"Holmes","phoneNumber":"02031234321"},"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"}}}},"key":"card/tokenized","summary":"card/tokenized","description":"Exemption assessment using a Worldpay Token","id":"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1tokenized"},"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"doNotApplyExemption":false,"exemption":{"capability":"authorizationAndAuthentication","request":{"placement":"authorization","type":"lowValue"}},"instruction":{"paymentInstrument":{"type":"card/networkToken","tokenNumber":"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"}}}},"key":"card/networkToken","summary":"card/networkToken","description":"Exemption assessment using a network token","id":"paths/~1exemptions~1assessment/post/requestBody/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/card~1networkToken"},"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted":{"value":{"outcome":"noExemption","transactionReference":"Memory265-13/08/1876","riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"key":"No exemption is granted","summary":"No exemption is granted","description":"No exemption is granted, use 3DS authentication","id":"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/No exemption is granted"},"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization":{"value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authorization","type":"lowValue"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"key":"Exemption granted - lowValue/authorization","summary":"Exemption granted - lowValue/authorization","description":"lowValue exemption granted to be applied in payment authorization request","id":"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowValue~1authorization"},"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization":{"value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authorization","type":"lowRisk"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"key":"Exemption granted - lowRisk/authorization","summary":"Exemption granted - lowRisk/authorization","description":"lowRisk exemption granted to be applied in payment authorization request","id":"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authorization"},"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication":{"value":{"outcome":"exemption","transactionReference":"Memory265-13/08/1876","exemption":{"placement":"authentication","type":"lowRisk"},"riskProfile":{"href":"https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ"}},"key":"Exemption granted - lowRisk/authentication","summary":"Exemption granted - lowRisk/authentication","description":"lowRisk exemption granted to be applied in 3DS authentication request","id":"paths/~1exemptions~1assessment/post/responses/200/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/Exemption granted - lowRisk~1authentication"},"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body":{"value":{"errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"stringFailedRegexCheck","message":"Email must be a valid email address","jsonPath":"$.riskData.account.email"},{"errorName":"stringIsTooShort","message":"Email must be between 3 and 254 characters inclusive","jsonPath":"$.riskData.account.email"}],"message":"The json body provided does not match the expected schema"},"key":"An Exemption assessment request with invalid value in request body","summary":"An Exemption assessment request with invalid value in request body","description":"An Exemption assessment request using an email which is 2 characters long","id":"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid value in request body"},"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header":{"value":{"errorName":"headerHasInvalidValue","message":"A valid 'Content-Type' header must be provided"},"key":"An Exemption assessment request using invalid header","summary":"An Exemption assessment request using invalid header","description":"An Exemption assessment request using invalid 'Content-Type' header","id":"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid header"},"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method":{"value":{"errorName":"methodNotAllowed","message":"method GET not allowed for this request"},"key":"An Exemption assessment request using invalid http method","summary":"An Exemption assessment request using invalid http method","description":"An Exemption assessment request using GET method instead of POST","id":"paths/~1exemptions~1assessment/post/responses/400/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request using invalid http method"},"paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header":{"value":{"errorName":"unAuthorized","message":"Invalid access token"},"key":"An Exemption assessment request with invalid Authorization header","summary":"An Exemption assessment request with invalid Authorization header","description":"An Exemption assessment request using invalid Authorization header","id":"paths/~1exemptions~1assessment/post/responses/401/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/An Exemption assessment request with invalid Authorization header"},"paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service unavailable"},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1exemptions~1assessment/post/responses/503/content/application~1vnd.worldpay.exemptions-v1.hal+json/examples/The requested service is unavailable"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/sca-exemptions/@v1/openapi.json?download"},{"url":"/access/_bundle/products/sca-exemptions/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"SCA Exemptions","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions. Exemptions are supported for Visa, Mastercard and Maestro.<br><br> __Authentication header__\n  ```\n    Authorization: {your_credentials}\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager. <br /> <br />\nYou **must** use the `Authorization` header for any request you send to our Exemptions API. <br><br> __Accept/Content-Type header__\n  ```\n  Content-Type: application/vnd.worldpay.exemptions-v1.hal+json\n  Accept: application/vnd.worldpay.exemptions-v1.hal+json\n  ```\n  <br>\n\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Exemptions API. <br><br> We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`. <br /><br />\n__DNS whitelisting__ <br><br> Whitelist the following URLs:<br><br> * `https://try.access.worldpay.com/`<br> * `https://access.worldpay.com/`<br><br>\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting.\n{% admonition type=\"danger\" name=\"Applying the exemption\" %} You must apply the `riskProfile` from the exemption assessment response in the [Card Payments API](/products/card-payments/authorize-a-payment#sca-exemptions) to link the Worldpay payment and apply the exemption that was granted. \nSee [applying the exemption](/products/sca-exemptions/assessment#applying-the-exemption) for details. {% /admonition %}","category":["3DS","SCA Exemptions"],"business":["Enterprise"],"catalog-list":true,"generated":false}},"baseSlug":"/products/sca-exemptions/openapi","routesMapping":{}}