{"items":[{"type":"link","label":"3DS","link":"/products/3ds/20261201/openapi","routeSlug":"/products/3ds/20261201/openapi","content":{"contentType":"overview","meta":{"name":"3DS"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/3ds/@20261201/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/3ds/@20261201/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-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"3DS (2026-12-01)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"danger","name":"Preview only"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a preview of the next major version and is subject to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated availability: Late 2026"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify your customer's identity to minimize fraud. Use our Strong Customer Authentication (SCA) to benefit from liability shift."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: {your_credentials} \nContent-Type: application/json  \nWP-Api-Version: 2026-12-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: {your_credentials} \nContent-Type: application/json  \nWP-Api-Version: 2026-12-01\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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"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":"code","inline":true,"attributes":{"content":"https://try.access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/3ds/20261201/openapi"}],"sectionId":"/products/3ds/20261201/openapi"}]}]}},{"type":"group","label":"3DS Authentication","link":"/products/3ds/20261201/openapi/authentication","routeSlug":"/products/3ds/20261201/openapi/authentication","items":[{"label":"Authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/20261201/openapi/authentication/authenticate","routeSlug":"/products/3ds/20261201/openapi/authentication/authenticate","metadata":{"seo":{"title":"Authentication","description":"Authenticate your customer by submitting order and risk data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authentication","isWebhook":false,"pointer":"/paths/~1authentications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticate your customer by submitting order and risk data.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_248","description":"The API version.","required":true,"example":"2026-12-01"}],"pointer":"/paths/~1authentications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/3DS_authenticate_request","exampleIds":["paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"]}},"schemaId":"components/schemas/3DS_authenticate_request","exampleIds":["paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"],"pointer":"/paths/~1authentications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentications","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2026-12-01","schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/3DS_authenticate_request","exampleIds":["paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"]}},"responseCodes":["200","400","502","503"],"pointer":"/authentications","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Live"}],"schemaId":"components/schemas/3DS_authenticate_request","exampleIds":["paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/3DS_authenticate_request","exampleIds":["paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token","paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted","paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"]}},"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/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_authenticate_200_response_redirect","exampleIds":["paths/~1authentications/post/responses/200/content/application~1json/examples/redirect"]}},"schemaId":"components/schemas/3DS_authenticate_200_response_redirect","exampleIds":["paths/~1authentications/post/responses/200/content/application~1json/examples/redirect"]},{"code":"400","description":"The request has encountered validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]}},"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]},{"code":"502","description":"Invalid response received from upstream.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream"]}},"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream"]},{"code":"503","description":"The requested service is unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1authentications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/3DS_authenticate_200_response_redirect","exampleIds":["paths/~1authentications/post/responses/200/content/application~1json/examples/redirect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_authenticate_200_response_redirect","exampleIds":["paths/~1authentications/post/responses/200/content/application~1json/examples/redirect"]}}},{"code":"400","schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]}}},{"code":"502","schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream"]}}},{"code":"503","schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/authentications"},{"label":"Query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/20261201/openapi/authentication/authenticationquery","routeSlug":"/products/3ds/20261201/openapi/authentication/authenticationquery","metadata":{"seo":{"title":"Query","description":"Query for the latest authentication state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticationQuery","name":"Query","isWebhook":false,"pointer":"/paths/~1authentications~1{authenticationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query for the latest authentication state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_249","description":"Unique identifier for a single 3ds authentication. Generated by us.","required":true}],"pointer":"/paths/~1authentications~1{authenticationId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_248","description":"The API version.","required":true,"example":"2026-12-01"}],"pointer":"/paths/~1authentications~1{authenticationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authentications/{authenticationId}","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Live"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_249"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2026-12-01","schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","502","503"],"pointer":"/authentications/{authenticationId}","href":"authentication/authenticationquery","openApiOperationId":"authenticationQuery","summary":"Query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Live"}],"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/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_query_200_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect"]}},"schemaId":"components/schemas/3DS_query_200_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect"]},{"code":"400","description":"The request has encountered validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]}},"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]},{"code":"502","description":"Invalid response received from upstream.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream"]}},"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream"]},{"code":"503","description":"The requested service is unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1authentications~1{authenticationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/3DS_query_200_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_query_200_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated","paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect"]}}},{"code":"400","schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_400_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header","paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"]}}},{"code":"502","schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream"]}}},{"code":"503","schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3DS_502_response","exampleIds":["paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticationquery"}],"panels":[]}]},"httpPath":"/authentications/{authenticationId}"}],"content":{"contentType":"group","meta":{"name":"authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3DS Authentication","showPageActions":true},{"nodeType":"markdoc","content":"3DS authentication request. \n\nMerchant facing API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authentications","summary":"Authentication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false},{"title":"/authentications/{authenticationId}","summary":"Query","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/authenticationquery","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/device_data_request":{"id":"components/schemas/device_data_request","kind":"json-schema","title":"device_data_request","data":{"type":"object","properties":{"collectionReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"postMessage for the device data collection form (web)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or for native (iOS/Android), returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consumerSessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as part of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDK initialization"},"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":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If device data collection fails you can attempt the payment without this value, but you will see an increased number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challenged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and even "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationFailure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" outcomes, if this happens for a lot of requests."},"children":[]}]}]}],"example":"0_3XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX6b5"},"deviceData":{"$ref":"#/components/schemas/device_data"}}}},"components/schemas/challenge":{"id":"components/schemas/challenge","kind":"json-schema","title":"challenge","data":{"type":"object","description":"An object that contains challenge related information.","properties":{"preference":{"enum":["noPreference","noChallengeRequested","challengeRequested","challengeMandated","noChallengeRequestedTRAPerformed"],"type":"string","description":"Preference regarding issuer displaying challenge to the customer. The interpretation of this field varies from issuer to issuer, so we cannot guarantee any particular behavior on their part as a result of you setting this field.","x-enumDescriptions":{"noPreference":"Default (decision to challenge owned by issuer).","noChallengeRequested":"Prefer no challenge performed.","challengeRequested":"Prefer challenge is performed.","challengeMandated":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Local or regional mandates meaning a challenge must be performed. For SCA mandated countries you should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeMandated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the authentication request as part of the first CIT payment in an MIT series."},"children":[]}]}]}],"noChallengeRequestedTRAPerformed":"Prefer no challenge performed due to an exemption to SCA. Only use this when Transaction Risk Analysis (TRA) has been performed using an approved third party vendor and an SCA exemption has been recommended for the authentication."}}}}},"components/schemas/value":{"id":"components/schemas/value","kind":"json-schema","title":"value","data":{"required":["amount","currency"],"type":"object","description":"An object that contains information about the value of the authentication.","properties":{"amount":{"maximum":99999999999,"minimum":0,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authentication amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/useful-tables/#currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency table"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The authentication amount should be equal to the authorization amount. We recommend you delay authentication until the amount is known, or ensure it's greater than the total transaction amount."},"children":[]}]}]}]},"currency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three digit currency code. See list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/useful-tables/#currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GBP"}}}},"components/schemas/device_data":{"id":"components/schemas/device_data","kind":"json-schema","title":"device_data","data":{"required":["acceptHeader","userAgentHeader"],"type":"object","description":"Object containing device data information.","properties":{"acceptHeader":{"maxLength":2048,"minLength":1,"type":"string","description":"Used by the issuer to check if the customer's browser is compatible with the issuer challenge display."},"userAgentHeader":{"maxLength":2048,"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":"Used by issuers as part of risk analysis and to correctly display the challenge. Must conform to RFC 7321 e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"browserLanguage":{"maxLength":8,"minLength":1,"type":"string","description":" Your customer's browser language that can be used by the issuer in risk analysis. Must conform to the language tags defined by IETF, e.g. en-GB, fr-FR. "},"ipAddress":{"type":"string","description":" A unique identifier for your customer's physical location that\n            can be used by the issuer in risk analysis. Must be in IPv4 or IPv6 format,\ne.g. 192.0.0.0. "},"browserJavaEnabled":{"type":"boolean","description":"Defines whether Java is enabled on your customer's browser."},"browserColorDepth":{"type":"integer","description":"The color depth of your customers browser. Between 1 and 99.","minimum":1,"maximum":99},"browserScreenHeight":{"type":"integer","pattern":"^[0-9]{1,6}$","description":"Defines the pixel height of the customers browser."},"browserScreenWidth":{"type":"integer","pattern":"^[0-9]{1,6}$","description":"Defines the pixel width of the customers browser."},"timeZone":{"pattern":"^[+-]?\\d{1,4}$","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time zone offset in minutes between UTC and your customer's browser local time."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example time zone offset values in minutes:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If UTC -5 hours:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"300"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+300"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If UTC +5 hours:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-300"},"children":[]}]}]}]},"browserJavascriptEnabled":{"type":"boolean","description":"Defines whether Javascript is enabled on your customer's browser."},"channel":{"type":"string","description":"The channel used e.g. browser.","enum":["browser","native","ucpBrowser"],"x-enumDescriptions":{"browser":"web browser","native":"iOS and Android native display","ucpBrowser":"display within UCP web AI assistant"}}}}},"components/schemas/shipping":{"id":"components/schemas/shipping","kind":"json-schema","title":"shipping","data":{"type":"object","properties":{"nameMatchesAccountName":{"type":"boolean","description":"If customer name on account is identical to the shipping name."},"method":{"type":"string","description":"The shipping method used.","x-enumDescriptions":{"billingAddress":"Ship to customer's billing address.","verifiedAddress":"Ship to another verified address on file with merchant.","otherAddress":"Ship to address that is different than billing address.","store":"Ship to store (store address should be populated on request).","digital":"Digital goods.","unshippedTickets":"Travel and event tickets, not shipped.","other":"Other."},"enum":["billingAddress","verifiedAddress","otherAddress","store","digital","unshippedTickets","other"]},"timeFrame":{"type":"string","enum":["electronic","sameDay","nextDay","twoDaysPlus"]},"email":{"maxLength":128,"minLength":3,"pattern":"^.+@.+$","type":"string","description":"The email address used for an electronic delivery."},"phone":{"maxLength":20,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"The phone number used for delivery."},"firstName":{"maxLength":22,"minLength":1,"type":"string","description":"First name used on the shipping address."},"lastName":{"maxLength":22,"minLength":1,"type":"string","description":"Last name used on the shipping address."},"address":{"$ref":"#/components/schemas/PaymentsShippingAddress"}}}},"components/schemas/PaymentsShippingAddress":{"id":"components/schemas/PaymentsShippingAddress","kind":"json-schema","title":"PaymentsShippingAddress","data":{"required":["address1","city","countryCode","postalCode"],"type":"object","properties":{"address1":{"maxLength":80,"minLength":1,"type":"string","description":"Address line 1."},"address2":{"maxLength":80,"minLength":1,"type":"string","description":"Address line 2."},"address3":{"maxLength":80,"minLength":1,"type":"string","description":"Address line 3."},"postalCode":{"maxLength":15,"minLength":1,"type":"string","description":"Address postal code."},"city":{"maxLength":50,"minLength":1,"type":"string","description":"Address city."},"stateCode":{"type":"string","maxLength":2,"minLength":1,"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":[]}]}]}]},"countryCode":{"type":"string","description":"The supported ISO 3166-1 alpha-2 country code.","format":"ISO 3166-1 alpha-2"}}}},"components/schemas/customer":{"id":"components/schemas/customer","kind":"json-schema","title":"customer","data":{"type":"object","properties":{"firstName":{"maxLength":22,"minLength":1,"type":"string","description":"Customer's first name."},"lastName":{"maxLength":22,"minLength":1,"type":"string","description":"Customer's last name."},"phone":{"maxLength":20,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"Customer's phone number."},"email":{"maxLength":128,"minLength":3,"pattern":"^.+@.+$","type":"string","description":"Customer's email address used for the ecommerce account."}}}},"components/schemas/payments_gift_cards_purchase":{"id":"components/schemas/payments_gift_cards_purchase","kind":"json-schema","title":"payments_gift_cards_purchase","data":{"type":"object","properties":{"totalValue":{"$ref":"#/components/schemas/value"},"quantity":{"type":"integer","description":"The number of gift cards being purchased.","format":"int32"}},"description":"If the order is being used to purchase a gift card."}},"components/schemas/transaction_history":{"id":"components/schemas/transaction_history","kind":"json-schema","title":"transaction_history","data":{"type":"object","properties":{"attemptsLastDay":{"maximum":999,"minimum":0,"type":"integer","description":"Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours."},"attemptsLastYear":{"maximum":999,"minimum":0,"type":"integer","description":"Number of transactions (successful or abandoned) for this cardholder account within the last year."},"completedLastSixMonths":{"maximum":9999,"minimum":0,"type":"integer","description":"Number of purchases with this customer account during the previous six months."},"addCardsLastDay":{"maximum":999,"minimum":0,"type":"integer","description":"Number of attempts to add a card in the last 24hrs."},"shippingAddressFirstUsedAt":{"type":"string","format":"date","description":"When the shipping address used for the transaction was first used. Provide in ISO 8601 format.","example":"2021-06-20"}},"description":"Object containing details of the last transaction."}},"components/schemas/account_history":{"id":"components/schemas/account_history","kind":"json-schema","title":"account_history","data":{"type":"object","properties":{"createdAt":{"type":"string","format":"date","description":"When the account was created. Provide in ISO 8601 format.","example":"2019-11-18"},"modifiedAt":{"type":"string","format":"date","description":"When the account was last modified. Provide in ISO 8601 format.","example":"2020-05-12"},"passwordModifiedAt":{"type":"string","format":"date","description":"When the account password was last changed. Provide in ISO 8601 format.","example":"2021-03-15"},"paymentAccountEnrolledAt":{"type":"string","format":"date","description":"Date the payment account was added to the cardholder account. Provide in ISO 8601 format.","example":"2021-06-20"}},"description":"Customer account history.","example":{"createdAt":"2019-11-18","modifiedAt":"2020-05-12","passwordModifiedAt":"2021-03-15","paymentAccountEnrolledAt":"2021-06-20"}}},"components/schemas/order_reference":{"id":"components/schemas/order_reference","kind":"json-schema","title":"order_reference","data":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"Merchant specific reference for the order (e.g. generated ecommerce system order number). Does not have to be unique as multiple payments may apply to a single order.","example":"order-1234"}},"components/schemas/transaction_reference":{"id":"components/schemas/transaction_reference","kind":"json-schema","title":"transaction_reference","data":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"A unique reference per authentication request provided by you that is used to identify the authentication throughout its lifecycle.","example":"request-5678"}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"merchant","data":{"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":"We use this to route your request. We create the entity as part of on-boarding.","example":"default"},"overrideName":{"type":"string","description":"Used to override the merchant name that's both submitted to issuers as well as displayed to the customer in the authentication process. PayFac merchants should submit the name of their submerchant."},"acquirerId":{"type":"string","maxLength":20,"minLength":1,"example":"01234567","pattern":"^[0-9]*$","description":"Instructs the issuer that the following authorization will be completed with an external acquirer."}}}},"components/schemas/billing_address":{"id":"components/schemas/billing_address","kind":"json-schema","title":"billing_address","data":{"required":["address1","city","postalCode","countryCode"],"type":"object","description":"An object containing the billing address information.","properties":{"address1":{"maxLength":80,"minLength":1,"type":"string","description":"Billing address line 1.","example":"221B Baker Street"},"address2":{"maxLength":80,"type":"string","description":"Billing address line 2."},"address3":{"maxLength":80,"type":"string","description":"Billing address line 3."},"city":{"maxLength":50,"minLength":1,"type":"string","description":"Billing address city.","example":"London"},"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). We recommend you provide this for US and China addresses."},"children":[]}]}]}]},"postalCode":{"maxLength":15,"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 postal code. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/useful-tables/#postalcode-optional"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See country codes with optional postalCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"NW1 6XE"},"countryCode":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","description":"Billing address country code.","example":"GB"}}}},"components/schemas/card_holder_name":{"id":"components/schemas/card_holder_name","kind":"json-schema","title":"card_holder_name","data":{"maxLength":255,"minLength":1,"type":"string","description":"The name on your customer's card. This is not a mandatory field, however we recommend that you supply this to improve authentication rates.","example":"Sherlock Holmes"}},"components/schemas/eci":{"id":"components/schemas/eci","kind":"json-schema","title":"eci","data":{"maxLength":2,"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":"Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ECI"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02 or 05"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fully Authenticated Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"01 or 06"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempted Authentication Transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00 or 07"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non 3-D Secure Transaction"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02, 01, 00"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05, 06, 07"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amex"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05, 06, 07"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05, 06, 07"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diners"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"05, 06, 07"},"children":[]}]}]}]}]}]}]}},"components/schemas/authentication_value":{"id":"components/schemas/authentication_value","kind":"json-schema","title":"authentication_value","data":{"maxLength":64,"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":"A cryptographic value that provides evidence of the outcome of a 3DS verification."},"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":"Visa - Cardholder Authentication Verification Value (CAVV)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mastercard - Universal Cardholder Authentication Field (UCAF)"},"children":[]}]}]}]}]}},"components/schemas/ds_transaction_id":{"id":"components/schemas/ds_transaction_id","kind":"json-schema","title":"ds_transaction_id","data":{"maxLength":64,"minLength":1,"type":"string","description":"Directory server transaction ID, if provided should be used in the payment authorization authentication object."}},"components/schemas/acs_transaction_id":{"id":"components/schemas/acs_transaction_id","kind":"json-schema","title":"acs_transaction_id","data":{"maxLength":64,"minLength":1,"type":"string","description":"ACS transaction ID, if provided should be used in the payment authorization authentication object."}},"components/schemas/enrolled":{"id":"components/schemas/enrolled","kind":"json-schema","title":"enrolled","data":{"maxLength":1,"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":"Status of authentication eligibility."},"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":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Bank is participating in 3DS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Bank is not participating in 3DS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The Directory Server (DS) or Access Control Server (ACS) were not available at the time of the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Merchant authentication rule is triggered to bypass authentication (3DS premium only)"},"children":[]}]}]}]}]}},"components/schemas/status":{"id":"components/schemas/status","kind":"json-schema","title":"status","data":{"maxLength":2,"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":"Indicates the outcome of the authentication or verification request."},"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":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Successful authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Failed authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unable to complete authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Successful attempts authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Challenged authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authentication rejected (merchant "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submit for authorization)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Exemption acknowledged"},"children":[]}]}]}]}]}},"components/schemas/version":{"id":"components/schemas/version","kind":"json-schema","title":"version","data":{"maxLength":10,"minLength":1,"type":"string","description":"The version of 3DS used to process the transaction."}},"components/schemas/challenge_response":{"id":"components/schemas/challenge_response","kind":"json-schema","title":"challenge_response","data":{"type":"object","description":"Object containing challenge related information in case of a \"challenged\" flow","properties":{"reference":{"maxLength":20,"minLength":1,"type":"string","description":"This links the authentication response to the subsequent challenge form and verification request."},"url":{"maxLength":2048,"minLength":1,"type":"string","description":"POST action on the challenge form. Used to redirect to the issuers challenge page as part of the challenge form."},"jwt":{"maxLength":2048,"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":"A digitally signed token that contains additional details, such as the URL to return to after the challenge screen. Expires in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minutes on Try and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30 sec"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on Live"},"children":[]}]}]}]},"payload":{"maxLength":2048,"minLength":1,"type":"string","description":"JSON container with extra data required for the challenge. This is used by the native SDK (iOS/Android) only."}}}},"components/schemas/card_front":{"id":"components/schemas/card_front","kind":"json-schema","title":"card_front","data":{"required":["type","cardNumber","expiryDate"],"type":"object","properties":{"type":{"type":"string","format":"card/plain","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":[]}]}]}],"example":"card/plain"},"cardHolderName":{"$ref":"#/components/schemas/card_holder_name"},"expiryDate":{"required":["month","year"],"type":"object","description":"Object containing card expiry information.","properties":{"month":{"maximum":12,"minimum":1,"type":"integer","description":"Card expiry month.","example":1},"year":{"maximum":9999,"minimum":1,"type":"integer","description":"Card expiry year.","example":2028}}},"cardNumber":{"maxLength":19,"minLength":10,"pattern":"^[0-9]*$","type":"string","description":"Clear card number (PAN).","example":"4444333322221111"},"billingAddress":{"$ref":"#/components/schemas/billing_address"}}}},"components/schemas/card_networktoken":{"id":"components/schemas/card_networktoken","kind":"json-schema","title":"card_networktoken","data":{"required":["type","tokenNumber","expiryDate"],"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":[]}]}]}]},"expiryDate":{"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":{"$ref":"#/components/schemas/card_holder_name"},"billingAddress":{"$ref":"#/components/schemas/billing_address"}}}},"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/token","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/googlepay_encrypted":{"id":"components/schemas/googlepay_encrypted","kind":"json-schema","title":"googlepay_encrypted","data":{"required":["type","walletToken"],"type":"object","properties":{"type":{"enum":["googlepay/encrypted"],"type":"string","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":[]}]}]}]},"walletToken":{"type":"string"},"billingAddress":{"$ref":"#/components/schemas/billing_address"}}}},"components/schemas/self_link":{"id":"components/schemas/self_link","kind":"json-schema","title":"self_link","data":{"type":"object","properties":{"href":{"type":"string"}},"description":""}},"components/schemas/cryptogram_algorithm":{"id":"components/schemas/cryptogram_algorithm","kind":"json-schema","title":"cryptogram_algorithm","data":{"maxLength":99999,"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":"Indicates the algorithm used to generate the cryptogram. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be applied in the following authorization request."},"children":[]}]}]}]}},"components/schemas/challenge_preference":{"id":"components/schemas/challenge_preference","kind":"json-schema","title":"challenge_preference","data":{"maxLength":64,"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":"Indicates the preferred challenge behavior. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be applied in the following authorization request."},"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":"code","inline":true,"attributes":{"content":"noPreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noChallengeRequested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeRequested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeMandated"},"children":[]}]}]}]}]}},"components/schemas/authentication_flow":{"id":"components/schemas/authentication_flow","kind":"json-schema","title":"authentication_flow","data":{"maxLength":64,"minLength":1,"enum":["challenge","frictionless"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates which flow the customer has been directed to. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be applied in the following authorization request."},"children":[]}]}]}]}},"components/schemas/status_reason":{"id":"components/schemas/status_reason","kind":"json-schema","title":"status_reason","data":{"maxLength":2,"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":"Provides further information relating to the outcome of the authentication. Returned for failed authentications only. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only."},"children":[]}]}]}]}]}},"components/schemas/cancellation_indicator":{"id":"components/schemas/cancellation_indicator","kind":"json-schema","title":"cancellation_indicator","data":{"maxLength":2,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indicator as to why the authentication was cancelled. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only."},"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":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cardholder selected cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Reserved for future use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authentication timed out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authentication timed out at ACS provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction timed out at SDK"},"children":[]}]}]}]}]}},"components/schemas/network_score":{"id":"components/schemas/network_score","kind":"json-schema","title":"network_score","data":{"maxLength":2,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The global score calculated by the Cartes Bancaires scoring platform. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/brand":{"id":"components/schemas/brand","kind":"json-schema","title":"brand","data":{"maxLength":64,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card brand used in the authentication. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Cartes Bancaires authentications only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be applied in the following authorization."},"children":[]}]}]}]}},"components/schemas/decision":{"id":"components/schemas/decision","kind":"json-schema","title":"decision","data":{"type":"string","description":"Explains why bypassed was returned, either from manual rules or from recommendation by the authentication optimization service.","enum":["authenticationOptimization","rules"],"x-enumDescriptions":{"authenticationOptimization":"Decision from the authentication optimization service.","rules":"Manual rule (applies to Bypassed only)."}}},"components/schemas/3DS_authenticate_request":{"id":"components/schemas/3DS_authenticate_request","kind":"json-schema","title":"3DS_authenticate_request","data":{"required":["orderReference","transactionReference","merchant","instruction","deviceData"],"type":"object","properties":{"orderReference":{"$ref":"#/components/schemas/order_reference"},"transactionReference":{"$ref":"#/components/schemas/transaction_reference"},"merchant":{"$ref":"#/components/schemas/merchant"},"instruction":{"required":["value","paymentInstrument"],"type":"object","description":"The object that contains all the payment information related to the authentication request.","properties":{"value":{"$ref":"#/components/schemas/value"},"paymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/card_front"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_networktoken"},{"$ref":"#/components/schemas/googlepay_encrypted"}],"description":"An object that contains the card details or token location.","discriminator":{"mapping":{"card/plain":"#/components/schemas/card_front","card/token":"#/components/schemas/card_tokenized","card/networkToken":"#/components/schemas/card_networktoken","googlepay/encrypted":"#/components/schemas/googlepay_encrypted"},"propertyName":"type"}}}},"deviceData":{"$ref":"#/components/schemas/device_data"},"customer":{"$ref":"#/components/schemas/customer"},"challenge":{"$ref":"#/components/schemas/challenge"},"previousSuspiciousActivity":{"type":"boolean","description":"Has the account been flagged for suspicious activity."},"userType":{"type":"string","enum":["guestUser","registeredUser","federatedAccount","issuerCredentials","thirdPartyAuthentication","fidoAuthenticator"]},"accountHistory":{"$ref":"#/components/schemas/account_history"},"reorder":{"type":"boolean","description":"Repeat of a previous order."},"preOrderDate":{"type":"string","format":"date","description":"Expected date that a pre-ordered purchase will be available. Provide in ISO 8601 format.","example":"2021-12-25"},"transactionHistory":{"$ref":"#/components/schemas/transaction_history"},"giftCardsPurchase":{"$ref":"#/components/schemas/payments_gift_cards_purchase"},"shipping":{"$ref":"#/components/schemas/shipping"}}}},"components/schemas/3DS_query_200_response_authenticated":{"id":"components/schemas/3DS_query_200_response_authenticated","kind":"json-schema","title":"3dsAuthenticated","data":{"title":"3dsAuthenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_attempted":{"id":"components/schemas/3DS_query_200_response_attempted","kind":"json-schema","title":"attempted","data":{"title":"attempted","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_exempted":{"id":"components/schemas/3DS_query_200_response_exempted","kind":"json-schema","title":"exempted","data":{"title":"exempted","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_outage":{"id":"components/schemas/3DS_query_200_response_outage","kind":"json-schema","title":"authenticationOutage","data":{"title":"authenticationOutage","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_query_200_response_already_authenticated":{"id":"components/schemas/3DS_query_200_response_already_authenticated","kind":"json-schema","title":"alreadyAuthenticated","data":{"title":"alreadyAuthenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_device_200_response_authenticated":{"id":"components/schemas/3DS_device_200_response_authenticated","kind":"json-schema","title":"authenticated","data":{"title":"authenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_attempted":{"id":"components/schemas/3DS_device_200_response_attempted","kind":"json-schema","title":"attempted","data":{"title":"attempted","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_outage":{"id":"components/schemas/3DS_device_200_response_outage","kind":"json-schema","title":"authenticationOutage","data":{"title":"authenticationOutage","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_challenge_200_response_authenticated":{"id":"components/schemas/3DS_challenge_200_response_authenticated","kind":"json-schema","title":"authenticated","data":{"title":"authenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_challenge"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_authenticate_200_response_redirect":{"id":"components/schemas/3DS_authenticate_200_response_redirect","kind":"json-schema","title":"3dsRedirect","data":{"title":"3dsRedirect","type":"object","properties":{"outcome":{"enum":["3dsRedirect"],"type":"string","description":"Redirect."},"authenticationId":{"type":"string","example":"3dsLfC-vuhv7J2nEw2m9ca_e0","description":"Unique identifier for a single 3ds authentication, generated by Worldpay"},"redirect":{"type":"string","description":"The URL to redirect your customer to."},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_redirect":{"id":"components/schemas/3DS_query_200_response_redirect","kind":"json-schema","title":"3dsRedirect","data":{"title":"3dsRedirect","type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"redirect":{"type":"string","description":""},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_challenged":{"id":"components/schemas/3DS_device_200_response_challenged","kind":"json-schema","title":"challenged","data":{"title":"challenged","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"challenge":{"$ref":"#/components/schemas/challenge_response"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_not_authenticated":{"id":"components/schemas/3DS_query_200_response_not_authenticated","kind":"json-schema","title":"notAuthenticated","data":{"title":"notAuthenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_challenge_failed":{"id":"components/schemas/3DS_query_200_response_challenge_failed","kind":"json-schema","title":"challengeFailed","data":{"title":"challengeFailed","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_rejected":{"id":"components/schemas/3DS_query_200_response_rejected","kind":"json-schema","title":"rejected","data":{"title":"rejected","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_not_authenticated":{"id":"components/schemas/3DS_device_200_response_not_authenticated","kind":"json-schema","title":"notAuthenticated","data":{"title":"notAuthenticated","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_rejected":{"id":"components/schemas/3DS_device_200_response_rejected","kind":"json-schema","title":"rejected","data":{"title":"rejected","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_unavailable":{"id":"components/schemas/3DS_query_200_response_unavailable","kind":"json-schema","title":"unavailable","data":{"title":"unavailable","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"status":{"$ref":"#/components/schemas/status"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_unavailable":{"id":"components/schemas/3DS_device_200_response_unavailable","kind":"json-schema","title":"unavailable","data":{"title":"unavailable","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"transactionReference":{"$ref":"#/components/schemas/transaction_reference"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_exempted":{"id":"components/schemas/3DS_device_200_response_exempted","kind":"json-schema","title":"exempted","data":{"title":"exempted","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_device"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"cryptogramAlgorithm":{"$ref":"#/components/schemas/cryptogram_algorithm"},"challengePreference":{"$ref":"#/components/schemas/challenge_preference"},"authenticationFlow":{"$ref":"#/components/schemas/authentication_flow"},"statusReason":{"$ref":"#/components/schemas/status_reason"},"cancellationIndicator":{"$ref":"#/components/schemas/cancellation_indicator"},"networkScore":{"$ref":"#/components/schemas/network_score"},"brand":{"$ref":"#/components/schemas/brand"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_query_200_response_bypassed":{"id":"components/schemas/3DS_query_200_response_bypassed","kind":"json-schema","title":"bypassed","data":{"title":"bypassed","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"decision":{"$ref":"#/components/schemas/decision"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_device_200_response_bypassed":{"id":"components/schemas/3DS_device_200_response_bypassed","kind":"json-schema","title":"bypassed","data":{"title":"bypassed","required":["outcome"],"type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_query"},"decision":{"$ref":"#/components/schemas/decision"},"enrolled":{"$ref":"#/components/schemas/enrolled"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"acsTransactionId":{"$ref":"#/components/schemas/acs_transaction_id"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_400_response":{"id":"components/schemas/3DS_400_response","kind":"json-schema","title":"3DS_400_response","data":{"required":["message","errorName"],"type":"object","properties":{"path":{"type":"string","maxLength":2048,"minLength":1,"description":"The request URI path."},"status":{"maxLength":3,"minLength":3,"type":"integer","description":"The HTTP status returned from server."},"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message."},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name."},"headerName":{"type":"string","maxLength":2048,"minLength":1,"description":"The name of the header containing invalid value."},"allowedMethods":{"type":"array","description":"List of HTTP methods that are allowed.","items":{"type":"string"}},"validationErrors":{"description":"Object containing details of validation errors occurred.","type":"array","items":{"$ref":"#/components/schemas/validation_errors"}},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_502_response":{"id":"components/schemas/3DS_502_response","kind":"json-schema","title":"3DS_502_response","data":{"required":["message","errorName"],"type":"object","properties":{"path":{"type":"string","maxLength":2048,"minLength":1,"description":"The request URI path."},"status":{"maxLength":3,"minLength":3,"type":"integer","description":"The HTTP status returned from server."},"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message."},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name."},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_503_response":{"id":"components/schemas/3DS_503_response","kind":"json-schema","title":"3DS_503_response","data":{"required":["message","errorName"],"type":"object","properties":{"path":{"type":"string","maxLength":2048,"minLength":1,"description":"The request URI path."},"status":{"maxLength":3,"minLength":3,"type":"integer","description":"The HTTP status returned from server."},"message":{"type":"string","maxLength":2048,"minLength":1,"description":"The error description message."},"errorName":{"type":"string","maxLength":2048,"minLength":1,"description":"The unique error name."},"_links":{"$ref":"#/components/schemas/links"}}}},"components/schemas/3DS_challenge_200_response_not_authenticated":{"id":"components/schemas/3DS_challenge_200_response_not_authenticated","kind":"json-schema","title":"authenticationFailed","data":{"title":"authenticationFailed","type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_challenge"},"version":{"$ref":"#/components/schemas/version"},"eci":{"$ref":"#/components/schemas/eci"},"authenticationValue":{"$ref":"#/components/schemas/authentication_value"},"dsTransactionId":{"$ref":"#/components/schemas/ds_transaction_id"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/3DS_challenge_200_response_unavailable":{"id":"components/schemas/3DS_challenge_200_response_unavailable","kind":"json-schema","title":"unavailable","data":{"title":"unavailable","type":"object","properties":{"outcome":{"$ref":"#/components/schemas/outcome_challenge"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self_link"}}}}}},"components/schemas/links":{"id":"components/schemas/links","kind":"json-schema","title":"Links","data":{"title":"Links","type":"object","additionalProperties":true}},"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."}}}},"components/schemas/3DS_query_200_response":{"id":"components/schemas/3DS_query_200_response","kind":"json-schema","title":"3DS_query_200_response","data":{"type":"object","discriminator":{"propertyName":"outcome","mapping":{"3dsAuthenticated":"#/components/schemas/3DS_query_200_response_authenticated","3dsAttempted":"#/components/schemas/3DS_query_200_response_attempted","3dsRejected":"#/components/schemas/3DS_query_200_response_rejected","3dsNotAuthenticated":"#/components/schemas/3DS_query_200_response_not_authenticated","3dsUnavailable":"#/components/schemas/3DS_query_200_response_unavailable","3dsChallengeFailed":"#/components/schemas/3DS_query_200_response_challenge_failed","3dsOutage":"#/components/schemas/3DS_query_200_response_outage","3dsBypassed":"#/components/schemas/3DS_query_200_response_bypassed","3dsExempted":"#/components/schemas/3DS_query_200_response_exempted","3dsAlreadyAuthenticated":"#/components/schemas/3DS_query_200_response_already_authenticated","3dsRedirect":"#/components/schemas/3DS_query_200_response_redirect"}},"properties":{"outcome":{"type":"string"}}}},"components/schemas/3DS_device_200_response":{"id":"components/schemas/3DS_device_200_response","kind":"json-schema","title":"3DS_device_200_response","data":{"type":"object","discriminator":{"propertyName":"outcome","mapping":{"3dsAuthenticated":"#/components/schemas/3DS_device_200_response_authenticated","3dsChallenged":"#/components/schemas/3DS_device_200_response_challenged","3dsAttempted":"#/components/schemas/3DS_device_200_response_attempted","3dsRejected":"#/components/schemas/3DS_device_200_response_rejected","3dsNotAuthenticated":"#/components/schemas/3DS_device_200_response_not_authenticated","3dsUnavailable":"#/components/schemas/3DS_device_200_response_unavailable","3dsOutage":"#/components/schemas/3DS_device_200_response_outage","3dsBypassed":"#/components/schemas/3DS_device_200_response_bypassed","3dsExempted":"#/components/schemas/3DS_device_200_response_exempted"}},"properties":{"outcome":{"type":"string"}}}},"components/schemas/3DS_challenge_200_response":{"id":"components/schemas/3DS_challenge_200_response","kind":"json-schema","title":"3DS_challenge_200_response","data":{"type":"object","discriminator":{"propertyName":"outcome","mapping":{"3dsAuthenticated":"#/components/schemas/3DS_challenge_200_response_authenticated","3dsNotAuthenticated":"#/components/schemas/3DS_challenge_200_response_not_authenticated","3dsUnavailable":"#/components/schemas/3DS_challenge_200_response_unavailable"}}}},"components/schemas/3DS_ddi_200_response":{"id":"components/schemas/3DS_ddi_200_response","kind":"json-schema","title":"3DS_ddi_200_response","data":{"type":"object","discriminator":{"propertyName":"provider","mapping":{"cardinal":"#/components/schemas/3DS_ddi_200_response_cardinal","ravelin":"#/components/schemas/3DS_ddi_200_response_ravelin"}},"properties":{"outcome":{"type":"string"}}}},"components/schemas/3DS_ddi_200_response_cardinal":{"id":"components/schemas/3DS_ddi_200_response_cardinal","kind":"json-schema","title":"cardinal","data":{"title":"cardinal","required":["provider"],"type":"object","properties":{"provider":{"enum":["cardinal","ravelin"],"type":"string","description":"The outcome of the authentication request."},"jwt":{"maxLength":2048,"minLength":1,"type":"string","description":"A digitally signed token that contains additional details required for DDC."},"url":{"maxLength":2048,"minLength":1,"type":"string","description":"A POST action on the DDC form. Used to redirect to the issuers DDC page."},"bin":{"type":"string","description":"First six digits of the card number (Bank Identification Number), used as part of DDC. Returned if a token resource, network payment token or card number is included in the request."}}}},"components/schemas/3DS_ddi_200_response_ravelin":{"id":"components/schemas/3DS_ddi_200_response_ravelin","kind":"json-schema","title":"ravelin","data":{"title":"ravelin","required":["provider"],"type":"object","properties":{"provider":{"enum":["cardinal","ravelin"],"type":"string","description":"The outcome of the authentication request."},"acsUrl":{"maxLength":2048,"minLength":1,"type":"string","description":"Issuer ACS Url to perform device data collection."}}}},"components/schemas/outcome_query":{"id":"components/schemas/outcome_query","kind":"json-schema","title":"outcome_query","data":{"type":"string","description":"The latest outcome state for a given request authenticationId.","enum":["3dsAuthenticated","3dsAttempted","3dsRejected","3dsNotAuthenticated","3dsUnavailable","3dsChallengeFailed","3dsOutage","3dsBypassed","3dsExempted","3dsAlreadyAuthenticated","3dsRedirect"],"x-enumDescriptions":{"3dsAuthenticated":"Cardholder successfully authenticated by card issuer.","3dsAttempted":"3DS attempted but card issuer not participating. Stand-in authentication by the scheme.","3dsRejected":"Issuer rejects the authentication, do not proceed with payment.","3dsNotAuthenticated":"Authentication failure by card issuer (system issue).","3dsUnavailable":"Authentication unavailable at this current time.","3dsChallengeFailed":"Failed cardholder challenge.","3dsOutage":"Issuer recognized outage. Can attempt authentication outage exemption.","3dsBypassed":"3DS bypassed based on rules or recommendation from authentication optimization service.","3dsExempted":"Successful exemption in 3DS authentication.","3dsAlreadyAuthenticated":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided token is already SCA compliant. E.g. the google encrypted payload provided is 3DS_CRYPTOGRAM (authenticated) and not PAN_ONLY."},"children":[]}]}]}],"3dsRedirect":"3DS hosted redirect Url provided by Worldpay for clientside interaction."}}},"components/schemas/outcome_device":{"id":"components/schemas/outcome_device","kind":"json-schema","title":"outcome_device","data":{"type":"string","description":"The outcome of the device data complete request","enum":["3dsAuthenticated","3dsAttempted","3dsChallenged","3dsRejected","3dsNotAuthenticated","3dsUnavailable","3dsOutage","3dsBypassed","3dsExempted"],"x-enumDescriptions":{"3dsAuthenticated":"Cardholder successfully authenticated by card issuer","3dsAttempted":"3DS attempted but card issuer not participating. Stand-in authentication by the scheme.","3dsChallenged":"Issuer requests an identity check using the challenge screen","3dsRejected":"Issuer rejects the authentication, do not proceed with payment","3dsNotAuthenticated":"Authentication failure by card issuer (system issue)","3dsUnavailable":"Authentication unavailable at this current time","3dsOutage":"Issuer recognized outage. Can attempt authentication outage exemption","3dsBypassed":"3DS bypassed based on rules or recommendation from authentication optimization service","3dsExempted":"Successful exemption in 3DS authentication"}}},"components/schemas/outcome_challenge":{"id":"components/schemas/outcome_challenge","kind":"json-schema","title":"outcome_challenge","data":{"type":"string","description":"The outcome of the challenge complete request","enum":["3dsAuthenticated","3dsChallengeFailed","3dsUnavailable"],"x-enumDescriptions":{"3dsAuthenticated":"Cardholder successfully authenticated by card issuer","3dsChallengeFailed":"Failed cardholder challenge","3dsUnavailable":"Authentication unavailable at this current time"}}},"schema_248":{"kind":"json-schema","data":{"type":"string","enum":["2026-12-01"]},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"string"},"id":"schema_249"}},"exampleStore":{"components/examples/502":{"id":"components/examples/502","value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"An invalid response is received from upstream"},"components/examples/503":{"id":"components/examples/503","value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"The requested service is unavailable"},"components/examples/card":{"id":"components/examples/card","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/plain","cardNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"description":"Card authentication request with minimum recommended values"},"components/examples/card-all":{"id":"components/examples/card-all","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default","overrideName":"string","acquirerId":"01234567"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/plain","cardNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","browserLanguage":"en-GB","ipAddress":"192.168.1.1","browserJavaEnabled":true,"browserColorDepth":15,"browserScreenHeight":1200,"browserScreenWidth":1920,"timeZone":"-300","browserJavascriptEnabled":true,"channel":"browser"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"},"challenge":{"preference":"noPreference"},"previousSuspiciousActivity":true,"userType":"guestUser","accountHistory":{"createdAt":"2019-11-18","modifiedAt":"2020-05-12","passwordModifiedAt":"2021-03-15","paymentAccountEnrolledAt":"2021-06-20"},"reorder":true,"preOrderDate":"2021-12-25","transactionHistory":{"attemptsLastDay":0,"attemptsLastYear":0,"completedLastSixMonths":0,"addCardsLastDay":0,"shippingAddressFirstUsedAt":"2021-06-20"},"giftCardsPurchase":{"totalValue":{"amount":99999999999,"currency":"GBP"},"quantity":0},"shipping":{"nameMatchesAccountName":false,"method":"billingAddress","timeFrame":"electronic","email":"sherlock.holmes@example.com","phone":"01911234321","firstName":"James","lastName":"Moriarty","address":{"address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","postalCode":"DH1 3LE","city":"Durham","countryCode":"GB"}}},"description":"Full card authentication request with all key values"},"components/examples/token":{"id":"components/examples/token","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/token","href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"description":"Worldpay Token authentication request with minimum recommended values"},"components/examples/networkToken":{"id":"components/examples/networkToken","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/networkToken","tokenNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"description":"Network token authentication request with minimum recommended values"},"components/examples/googlepay-encrypted":{"id":"components/examples/googlepay-encrypted","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"googlepay/encrypted","walletToken":"{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}","billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"description":"Google pay encrypted payment"},"components/examples/googlepay-encrypted-ucp":{"id":"components/examples/googlepay-encrypted-ucp","value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"googlepay/encrypted","walletToken":"{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}","billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","channel":"ucpBrowser"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"description":"Google pay encrypted payment"},"components/examples/redirect":{"id":"components/examples/redirect","value":{"outcome":"3dsRedirect","authenticationId":"3dsLfC-Tuhv7J2nEw2m9ca_e0","redirect":"https://hpp-test.worldpay-bsh.securedataplatform.co.uk/all/hosted-threeds/3dsLfC-Tuhv7J2nEw2m9ca_e0","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/{authenticationId}"}}},"description":"Use a hosted 3DS page to wrap and perform device data collection, and when prompted display a challenge from the issuer"},"components/examples/400-invalid-chars":{"id":"components/examples/400-invalid-chars","value":{"message":"The json body provided does not match the expected schema","errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"stringFailedRegexCheck","jsonPath":"$.merchant.entity","message":"Entity must be alphanumeric with optional spaces"},{"errorName":"stringFailedRegexCheck","jsonPath":"$.transactionReference","message":"Transaction reference characters must be alphanumeric or one of the following: _!@#$%()*=-.:;?[]{}~`/+"}],"_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains invalid characters in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]}]},"components/examples/400-content-type":{"id":"components/examples/400-content-type","value":{"message":"Provided request contains a header with an invalid value","errorName":"headerHasInvalidValue","headerName":"Content-Type","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"The request contains an invalid Content-Type header"},"components/examples/400-invalid-method":{"id":"components/examples/400-invalid-method","value":{"errorName":"methodNotAllowed","allowedMethods":["POST"],"message":"Method GET not allowed for this request","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"The request is using an invalid HTTP method"},"components/examples/3dsAuthenticated":{"id":"components/examples/3dsAuthenticated","value":{"outcome":"3dsAuthenticated","status":"Y","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"05","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Successful frictionless authentication"},"components/examples/3dsAttempted":{"id":"components/examples/3dsAttempted","value":{"outcome":"3dsAttempted","status":"A","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"06","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Attempted Authentication, scheme step in"},"components/examples/3dsRejected":{"id":"components/examples/3dsRejected","value":{"outcome":"3dsRejected","status":"R","enrolled":"Y","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Issuer rejected the authentication"},"components/examples/3dsNotAuthenticated":{"id":"components/examples/3dsNotAuthenticated","value":{"outcome":"3dsNotAuthenticated","status":"N","enrolled":"Y","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Issuer failed the authentication without providing the option for a challenge"},"components/examples/3dsUnavailable":{"id":"components/examples/3dsUnavailable","value":{"outcome":"3dsUnavailable","status":"U","enrolled":"Y","version":"2.2.0","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Error/Timeout whilst attempting authentication"},"components/examples/3dsChallengeFailed":{"id":"components/examples/3dsChallengeFailed","value":{"outcome":"3dsChallengeFailed","status":"N","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Challenge failed"},"components/examples/3dsOutage":{"id":"components/examples/3dsOutage","value":{"outcome":"3dsOutage","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"A downstream service within the 3DS ecosystem is unavailable; you can attempt authorization"},"components/examples/3dsBypassed":{"id":"components/examples/3dsBypassed","value":{"outcome":"3dsBypassed","decision":"rules","enrolled":"B","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Bypass the authentication flow using rules"},"components/examples/3dsExempted":{"id":"components/examples/3dsExempted","value":{"outcome":"3dsExempted","status":"I","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"Exemption in 3DS successful"},"components/examples/3dsAlreadyAuthenticated":{"id":"components/examples/3dsAlreadyAuthenticated","value":{"outcome":"3dsAlreadyAuthenticated","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"description":"The provided token is already SCA compliant."},"components/examples/3dsRedirect":{"id":"components/examples/3dsRedirect","value":{"outcome":"3dsRedirect","authenticationId":"3dsLfC-Tuhv7J2nEw2m9ca_e0","redirect":"https://try.{hosted-path-tbc}.worldpay-bsh.securedataplatform.co.uk/{authenticationId}/redirect","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/{authenticationId}"}}},"description":"Use a hosted 3DS page to wrap and perform device data collection, and when prompted display a challenge from the issuer"},"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/plain","cardNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"key":"card/plain","summary":"card/plain","description":"Card authentication request with minimum recommended values","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain"},"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default","overrideName":"string","acquirerId":"01234567"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/plain","cardNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","browserLanguage":"en-GB","ipAddress":"192.168.1.1","browserJavaEnabled":true,"browserColorDepth":15,"browserScreenHeight":1200,"browserScreenWidth":1920,"timeZone":"-300","browserJavascriptEnabled":true,"channel":"browser"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"},"challenge":{"preference":"noPreference"},"previousSuspiciousActivity":true,"userType":"guestUser","accountHistory":{"createdAt":"2019-11-18","modifiedAt":"2020-05-12","passwordModifiedAt":"2021-03-15","paymentAccountEnrolledAt":"2021-06-20"},"reorder":true,"preOrderDate":"2021-12-25","transactionHistory":{"attemptsLastDay":0,"attemptsLastYear":0,"completedLastSixMonths":0,"addCardsLastDay":0,"shippingAddressFirstUsedAt":"2021-06-20"},"giftCardsPurchase":{"totalValue":{"amount":99999999999,"currency":"GBP"},"quantity":0},"shipping":{"nameMatchesAccountName":false,"method":"billingAddress","timeFrame":"electronic","email":"sherlock.holmes@example.com","phone":"01911234321","firstName":"James","lastName":"Moriarty","address":{"address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","postalCode":"DH1 3LE","city":"Durham","countryCode":"GB"}}},"key":"card/plain (all key:values)","summary":"card/plain (all key:values)","description":"Full card authentication request with all key values","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1plain (all key:values)"},"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/token","href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"key":"card/token","summary":"card/token","description":"Worldpay Token authentication request with minimum recommended values","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1token"},"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"card/networkToken","tokenNumber":"4444333322221111","cardHolderName":"Sherlock Holmes","expiryDate":{"month":1,"year":2028},"billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"key":"card/networkToken","summary":"card/networkToken","description":"Network token authentication request with minimum recommended values","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/card~1networkToken"},"paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"googlepay/encrypted","walletToken":"{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}","billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"key":"googlepay/encrypted","summary":"googlepay/encrypted","description":"Google pay encrypted payment","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted"},"paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)":{"value":{"orderReference":"order-1234","transactionReference":"request-5678","merchant":{"entity":"default"},"instruction":{"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"googlepay/encrypted","walletToken":"{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}","billingAddress":{"address1":"221B Baker Street","city":"London","postalCode":"NW1 6XE","countryCode":"GB"}}},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","channel":"ucpBrowser"},"customer":{"firstName":"Sherlock","lastName":"Holmes","phone":"02031234321","email":"sherlock.holmes@example.com"}},"key":"googlepay/encrypted (UCP)","summary":"googlepay/encrypted (UCP)","description":"Google pay encrypted payment","id":"paths/~1authentications/post/requestBody/content/application~1json/examples/googlepay~1encrypted (UCP)"},"paths/~1authentications/post/responses/200/content/application~1json/examples/redirect":{"value":{"outcome":"3dsRedirect","authenticationId":"3dsLfC-Tuhv7J2nEw2m9ca_e0","redirect":"https://hpp-test.worldpay-bsh.securedataplatform.co.uk/all/hosted-threeds/3dsLfC-Tuhv7J2nEw2m9ca_e0","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/{authenticationId}"}}},"key":"redirect","summary":"redirect","description":"Use a hosted 3DS page to wrap and perform device data collection, and when prompted display a challenge from the issuer","id":"paths/~1authentications/post/responses/200/content/application~1json/examples/redirect"},"paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters":{"value":{"message":"The json body provided does not match the expected schema","errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"stringFailedRegexCheck","jsonPath":"$.merchant.entity","message":"Entity must be alphanumeric with optional spaces"},{"errorName":"stringFailedRegexCheck","jsonPath":"$.transactionReference","message":"Transaction reference characters must be alphanumeric or one of the following: _!@#$%()*=-.:;?[]{}~`/+"}],"_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request contains invalid characters","summary":"The request contains invalid characters","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains invalid characters in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]}],"id":"paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains invalid characters"},"paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header":{"value":{"message":"Provided request contains a header with an invalid value","errorName":"headerHasInvalidValue","headerName":"Content-Type","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request contains an invalid `Content-Type` header","summary":"The request contains an invalid `Content-Type` header","description":"The request contains an invalid Content-Type header","id":"paths/~1authentications/post/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header"},"paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method":{"value":{"errorName":"methodNotAllowed","allowedMethods":["POST"],"message":"Method GET not allowed for this request","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request is using an invalid HTTP method","summary":"The request is using an invalid HTTP method","description":"The request is using an invalid HTTP method","id":"paths/~1authentications/post/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"},"paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream":{"value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"An invalid response is received from upstream","summary":"An invalid response is received from upstream","description":"An invalid response is received from upstream","id":"paths/~1authentications/post/responses/502/content/application~1json/examples/An invalid response is received from upstream"},"paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable":{"value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1authentications/post/responses/503/content/application~1json/examples/The requested service is unavailable"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated":{"value":{"outcome":"3dsAuthenticated","status":"Y","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"05","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsAuthenticated","summary":"3dsAuthenticated","description":"Successful frictionless authentication","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAuthenticated"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted":{"value":{"outcome":"3dsAttempted","status":"A","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"06","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsAttempted","summary":"3dsAttempted","description":"Attempted Authentication, scheme step in","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAttempted"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected":{"value":{"outcome":"3dsRejected","status":"R","enrolled":"Y","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsRejected","summary":"3dsRejected","description":"Issuer rejected the authentication","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRejected"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated":{"value":{"outcome":"3dsNotAuthenticated","status":"N","enrolled":"Y","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsNotAuthenticated","summary":"3dsNotAuthenticated","description":"Issuer failed the authentication without providing the option for a challenge","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsNotAuthenticated"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable":{"value":{"outcome":"3dsUnavailable","status":"U","enrolled":"Y","version":"2.2.0","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsUnavailable","summary":"3dsUnavailable","description":"Error/Timeout whilst attempting authentication","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsUnavailable"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed":{"value":{"outcome":"3dsChallengeFailed","status":"N","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsChallengeFailed","summary":"3dsChallengeFailed","description":"Challenge failed","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsChallengeFailed"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage":{"value":{"outcome":"3dsOutage","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsOutage","summary":"3dsOutage","description":"A downstream service within the 3DS ecosystem is unavailable; you can attempt authorization","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsOutage"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed":{"value":{"outcome":"3dsBypassed","decision":"rules","enrolled":"B","version":"2.2.0","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsBypassed","summary":"3dsBypassed","description":"Bypass the authentication flow using rules","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsBypassed"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted":{"value":{"outcome":"3dsExempted","status":"I","enrolled":"Y","version":"2.2.0","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"07","dsTransactionId":"c5b808e7-1de1-4069-a17b-f70d3b3b1645","acsTransactionId":"fe007a6e-315f-4cdf-98ca-28a9e40e3581","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsExempted","summary":"3dsExempted","description":"Exemption in 3DS successful","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsExempted"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated":{"value":{"outcome":"3dsAlreadyAuthenticated","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"3dsAlreadyAuthenticated","summary":"3dsAlreadyAuthenticated","description":"The provided token is already SCA compliant.","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsAlreadyAuthenticated"},"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect":{"value":{"outcome":"3dsRedirect","authenticationId":"3dsLfC-Tuhv7J2nEw2m9ca_e0","redirect":"https://try.{hosted-path-tbc}.worldpay-bsh.securedataplatform.co.uk/{authenticationId}/redirect","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/{authenticationId}"}}},"key":"3dsRedirect","summary":"3dsRedirect","description":"Use a hosted 3DS page to wrap and perform device data collection, and when prompted display a challenge from the issuer","id":"paths/~1authentications~1{authenticationId}/get/responses/200/content/application~1json/examples/3dsRedirect"},"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters":{"value":{"message":"The json body provided does not match the expected schema","errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"stringFailedRegexCheck","jsonPath":"$.merchant.entity","message":"Entity must be alphanumeric with optional spaces"},{"errorName":"stringFailedRegexCheck","jsonPath":"$.transactionReference","message":"Transaction reference characters must be alphanumeric or one of the following: _!@#$%()*=-.:;?[]{}~`/+"}],"_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request contains invalid characters","summary":"The request contains invalid characters","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains invalid characters in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]}],"id":"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains invalid characters"},"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header":{"value":{"message":"Provided request contains a header with an invalid value","errorName":"headerHasInvalidValue","headerName":"Content-Type","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request contains an invalid `Content-Type` header","summary":"The request contains an invalid `Content-Type` header","description":"The request contains an invalid Content-Type header","id":"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request contains an invalid `Content-Type` header"},"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method":{"value":{"errorName":"methodNotAllowed","allowedMethods":["POST"],"message":"Method GET not allowed for this request","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The request is using an invalid HTTP method","summary":"The request is using an invalid HTTP method","description":"The request is using an invalid HTTP method","id":"paths/~1authentications~1{authenticationId}/get/responses/400/content/application~1json/examples/The request is using an invalid HTTP method"},"paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream":{"value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"An invalid response is received from upstream","summary":"An invalid response is received from upstream","description":"An invalid response is received from upstream","id":"paths/~1authentications~1{authenticationId}/get/responses/502/content/application~1json/examples/An invalid response is received from upstream"},"paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable":{"value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds/authentications/LfC-Tuhv7J2nEw2m9ca_e"}}},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1authentications~1{authenticationId}/get/responses/503/content/application~1json/examples/The requested service is unavailable"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk/3ds","description":"Test (Try)"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk/3ds","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/3ds/@20261201/openapi.json?download"},{"url":"/access/_bundle/products/3ds/@20261201/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"3DS","description":"\n{% admonition type=\"danger\" name=\"Preview only\" %}\nThis is a preview of the next major version and is subject to change.\n\nEstimated availability: Late 2026\n{% /admonition %}\n\nVerify your customer's identity to minimize fraud. Use our Strong Customer Authentication (SCA) to benefit from liability shift.\n\n__Authentication__\n\nSet your headers\n\n```\nAuthorization: {your_credentials} \nContent-Type: application/json  \nWP-Api-Version: 2026-12-01\n```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password.\n\n__DNS whitelisting__\n\nWhitelist the following URLs: \n* `https://try.access.worldpay-bsh.securedataplatform.co.uk/`\n* `https://access.worldpay-bsh.securedataplatform.co.uk/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."}},"baseSlug":"/products/3ds/20261201/openapi","routesMapping":{}}