{"items":[{"type":"link","label":"3DS","link":"/products/3ds/v2/openapi","routeSlug":"/products/3ds/v2/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/@v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/3ds/@v2/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"3DS (2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Protect your business and meet regulatory requirements by verifying your customer's identity with our 3DS API."}],"sectionId":"/products/3ds/v2/openapi"}],"sectionId":"/products/3ds/v2/openapi"}]}]}},{"label":"Generate required data for 3DS Device Data Collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/v2/openapi/other/devicedatainitialize","routeSlug":"/products/3ds/v2/openapi/other/devicedatainitialize","metadata":{"seo":{"title":"Generate required data for 3DS Device Data Collection","description":"Allow card issuers to perform Device Data Collection to fingerprint your customer's device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deviceDataInitialize","name":"Generate required data for 3DS Device Data Collection","isWebhook":false,"pointer":"/paths/~1verifications~1customers~13ds~1deviceDataInitialize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate required data for 3DS Device Data Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allow card issuers to perform Device Data Collection to fingerprint your customer's device.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_251","required":true},{"name":"Accept","in":"header","schemaId":"schema_251","required":true}],"pointer":"/paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"],"pointer":"/paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/verifications/customers/3ds/deviceDataInitialize","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"},{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"]}},"responseCodes":["200","400","502","503"],"pointer":"/verifications/customers/3ds/deviceDataInitialize","href":"other/devicedatainitialize","openApiOperationId":"deviceDataInitialize","summary":"Generate required data for 3DS Device Data Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/3DS_deviceDataInitialize","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The data for the device data collection has been generated","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"]},{"code":"400","description":"The request has encountered validation errors","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"]},{"code":"502","description":"Invalid response received from upstream","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]},{"code":"503","description":"The requested service is unavailable","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/3DS_deviceDataInitialize_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"]}}},{"code":"400","schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`","paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"]}}},{"code":"502","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}}},{"code":"503","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/devicedatainitialize"}],"panels":[]}]},"httpPath":"/verifications/customers/3ds/deviceDataInitialize"},{"label":"Initiate the 3DS authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/v2/openapi/other/authenticate","routeSlug":"/products/3ds/v2/openapi/other/authenticate","metadata":{"seo":{"title":"Initiate the 3DS authentication","description":"Authenticate your customer by submitting order and risk data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Initiate the 3DS authentication","isWebhook":false,"pointer":"/paths/~1verifications~1customers~13ds~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate the 3DS 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":"Content-Type","in":"header","schemaId":"schema_251"},{"name":"Accept","in":"header","schemaId":"schema_251"}],"pointer":"/paths/~1verifications~1customers~13ds~1authenticate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_authenticate","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"]}},"schemaId":"components/schemas/3DS_authenticate","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"],"pointer":"/paths/~1verifications~1customers~13ds~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/verifications/customers/3ds/authenticate","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"},{"name":"Accept","in":"header","example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_authenticate","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"]}},"responseCodes":["200","400","502","503"],"pointer":"/verifications/customers/3ds/authenticate","href":"other/authenticate","openApiOperationId":"authenticate","summary":"Initiate the 3DS authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/3DS_authenticate","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_authenticate","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The authentication has been created","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"schema_252","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response"]}},"schemaId":"schema_252","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response"]},{"code":"400","description":"The request has encountered validation errors","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]},{"code":"502","description":"Invalid response received from upstream","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]},{"code":"503","description":"The requested service is unavailable","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1verifications~1customers~13ds~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_252","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"schema_252","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response","paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response"]}}},{"code":"400","schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]}}},{"code":"502","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}}},{"code":"503","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/authenticate"}],"panels":[]}]},"httpPath":"/verifications/customers/3ds/authenticate"},{"label":"Verify the 3DS challenge response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/v2/openapi/other/verify","routeSlug":"/products/3ds/v2/openapi/other/verify","metadata":{"seo":{"title":"Verify the 3DS challenge response","description":"Verify the results of a challenged authentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verify","name":"Verify the 3DS challenge response","isWebhook":false,"pointer":"/paths/~1verifications~1customers~13ds~1verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify the 3DS challenge response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verify the results of a challenged authentication.\n\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_251"},{"name":"Accept","in":"header","schemaId":"schema_251"}],"pointer":"/paths/~1verifications~1customers~13ds~1verification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_verify","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]}},"schemaId":"components/schemas/3DS_verify","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"],"pointer":"/paths/~1verifications~1customers~13ds~1verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/verifications/customers/3ds/verification","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"},{"name":"Accept","in":"header","example":"application/vnd.worldpay.verifications.customers-v2.hal+json","schemaId":"schema_251"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_verify","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]}},"responseCodes":["200","400","502","503"],"pointer":"/verifications/customers/3ds/verification","href":"other/verify","openApiOperationId":"verify","summary":"Verify the 3DS challenge response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/3DS_verify","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_verify","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The challenge was successful - obtain the authentication data for onward use","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_verify_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]}},"schemaId":"components/schemas/3DS_verify_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]},{"code":"400","description":"The request has encountered validation errors","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]},{"code":"502","description":"Invalid response received from upstream","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]},{"code":"503","description":"The requested service is unavailable","mediaType":"application/vnd.worldpay.verifications.customers-v2.hal+json","mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}},"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}],"pointer":"/paths/~1verifications~1customers~13ds~1verification/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/3DS_verify_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_verify_200_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"]}}},{"code":"400","schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_400_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header","paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"]}}},{"code":"502","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"]}}},{"code":"503","schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"],"mediaTypes":["application/vnd.worldpay.verifications.customers-v2.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.verifications.customers-v2.hal+json":{"schemaId":"components/schemas/3DS_deviceDataInitialize_502_response","exampleIds":["paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/verify"}],"panels":[]}]},"httpPath":"/verifications/customers/3ds/verification"}],"store":{"schemaStore":{"components/schemas/3DS_deviceDataInitialize":{"id":"components/schemas/3DS_deviceDataInitialize","kind":"json-schema","title":"3DS_deviceDataInitialize","data":{"required":["transactionReference","merchant"],"type":"object","properties":{"transactionReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"A unique reference for authentication. For example, e-commerce order code."},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant and API level configuration.","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9 ]*$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding."}}},"paymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/card_front"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_wallet_googlepay"}],"discriminator":{"mapping":{"card/front":"#/components/schemas/card_front","card/tokenized":"#/components/schemas/card_tokenized","card/wallet+googlepay":"#/components/schemas/card_wallet_googlepay"},"propertyName":"type"}}}}},"components/schemas/3DS_deviceDataInitialize_200_response":{"id":"components/schemas/3DS_deviceDataInitialize_200_response","kind":"json-schema","title":"3DS_deviceDataInitialize_200_response","data":{"required":["outcome","transactionReference"],"type":"object","properties":{"outcome":{"type":"string","enum":["initialized","alreadyAuthenticated"],"description":"Outcome of the device data initialization request"},"transactionReference":{"maxLength":64,"minLength":1,"type":"string","description":"A unique reference for authentication. For example, e-commerce order code."},"deviceDataCollection":{"required":["jwt","url"],"type":"object","description":"Object containing device data collection related information","properties":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action on the DDC form. Used to redirect to the issuers DDC page."},"children":[]}]}]}]},"bin":{"maxLength":6,"minLength":6,"type":"string","description":"First six digits of the card number (Bank Identification Number), used as part of DDC."}}}}}},"components/schemas/3DS_deviceDataInitialize_400_response":{"id":"components/schemas/3DS_deviceDataInitialize_400_response","kind":"json-schema","title":"3DS_deviceDataInitialize_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":{"required":["errorName","jsonPath","message"],"type":"object","description":"Object containing details of validation errors occurred","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_deviceDataInitialize_502_response":{"id":"components/schemas/3DS_deviceDataInitialize_502_response","kind":"json-schema","title":"3DS_deviceDataInitialize_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"}}}},"components/schemas/3DS_deviceDataInitialize_503_response":{"id":"components/schemas/3DS_deviceDataInitialize_503_response","kind":"json-schema","title":"3DS_deviceDataInitialize_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"}}}},"components/schemas/card_front":{"id":"components/schemas/card_front","kind":"json-schema","title":"card_front","data":{"required":["type","cardNumber","cardHolderName","cardExpiryDate"],"type":"object","properties":{"type":{"type":"string","format":"card/front","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being used."},"children":[]}]}]}]},"cardHolderName":{"maxLength":255,"minLength":1,"type":"string","description":"The name on the customer's card."},"cardExpiryDate":{"required":["month","year"],"type":"object","description":"Object containing card expiry information","properties":{"month":{"maximum":12,"minimum":1,"type":"integer","description":"Card expiry month"},"year":{"maximum":9999,"minimum":1,"type":"integer","description":"Card expiry year"}}},"cardNumber":{"maxLength":19,"minLength":10,"pattern":"^[0-9]*$","type":"string","description":"Clear card number (PAN)"},"billingAddress":{"required":["address1","city","postalCode","countryCode"],"type":"object","description":"An object containing the billing address information.","properties":{"city":{"maxLength":15,"minLength":1,"type":"string","description":"Billing address city"},"address1":{"maxLength":80,"minLength":1,"type":"string","description":"Billing address line 1"},"postalCode":{"maxLength":15,"minLength":1,"type":"string","description":"Billing address postal code"},"countryCode":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","description":"Billing address country code"},"state":{"maxLength":30,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address state. Should only be provided following the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO-3611-2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" two-character sub division (e.g.“CA” for California)."},"children":[]}]}]}]},"address2":{"maxLength":80,"type":"string","description":"Billing address line 2"},"address3":{"maxLength":80,"type":"string","description":"Billing address line 3"}}}}}},"components/schemas/card_tokenized":{"id":"components/schemas/card_tokenized","kind":"json-schema","title":"card_tokenized","data":{"required":["type","href"],"type":"object","properties":{"type":{"type":"string","format":"card/tokenized","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being used."},"children":[]}]}]}]},"href":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address that contains your link to an Access Token"},"children":[]}]}]}]}}}},"components/schemas/card_wallet_googlepay":{"id":"components/schemas/card_wallet_googlepay","kind":"json-schema","title":"card_wallet_googlepay","data":{"required":["type","walletToken"],"type":"object","properties":{"type":{"enum":["card/wallet+googlepay"],"type":"string"},"walletToken":{"type":"string","description":"The encrypted wallet token returned by Google","example":"{\"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":{"required":["postalCode","countryCode"],"type":"object","description":"Contains the billing address information.","properties":{"address1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First line of the address. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"address2":{"type":"string","description":"Second line of the address."},"address3":{"type":"string","description":"Third line of the address."},"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post code. Required, but an empty value can be provided for specific countries (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"state":{"type":"string","description":"State/province in max 3 characters."},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}}},"components/schemas/3DS_authenticate":{"id":"components/schemas/3DS_authenticate","kind":"json-schema","title":"3DS_authenticate","data":{"required":["transactionReference","merchant","instruction","deviceData","challenge"],"type":"object","properties":{"transactionReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"A unique reference for authentication. For example, e-commerce order code."},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant and API level configuration.","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9 ]*$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding."}}},"instruction":{"required":["value","paymentInstrument"],"type":"object","description":"The object that contains all the payment information related to the authentication request.","properties":{"value":{"required":["amount","currency"],"type":"object","description":"An object that contains information about the value of the authentication.","properties":{"amount":{"maximum":99999999999,"minimum":0,"type":"integer","description":"The authentication amount. This is a whole number with an exponent."},"currency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string","description":"The three digit currency code."}}},"paymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/card_front"},{"$ref":"#/components/schemas/card_tokenized"},{"$ref":"#/components/schemas/card_wallet_googlepay"}],"description":"An object that contains the card details or token location.","discriminator":{"mapping":{"card/front":"#/components/schemas/card_front","card/tokenized":"#/components/schemas/card_tokenized","card/wallet+googlepay":"#/components/schemas/card_wallet_googlepay"},"propertyName":"type"}}}},"deviceData":{"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 correctly displaying 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":[]}]}]}]},"collectionReference":{"maxLength":200,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For web this is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the post message response from the Device Data Collection form. For iOS/Android SDK this is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consumerSessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned as part of SDK and Device data initialization."},"children":[]}]}]}]}}},"challenge":{"required":["returnUrl"],"type":"object","description":"An object that contains challenge related information.","properties":{"returnUrl":{"minLength":1,"type":"string","format":"uri","description":"URL the issuer will redirect to once the customer completes the challenge page."},"preference":{"enum":["noPreference","noChallengeRequested","challengeRequested","challengeMandated"],"type":"string","description":"Preference regarding issuer displaying challenge to the customer."},"windowSize":{"enum":["390x400","250x400","600x400","fullPage"],"type":"string","description":"Specify the challenge window size (width x height) that the issuer should use."}}},"riskData":{"type":"object","description":"Object containing additional risk data.","properties":{"account":{"type":"object","description":"Object containing all customer account related risk data.","properties":{"previousSuspiciousActivity":{"type":"boolean","description":"Whether there is a record of previous suspicious activity."},"type":{"enum":["guestUser","registeredUser","federatedAccount","issuerCredentials","thirdPartyAuthentication","fidoAuthenticator"],"type":"string","description":"Type of account the current customer has."},"email":{"maxLength":128,"minLength":3,"pattern":"^.+@.+$","type":"string","description":"The customer's email address."},"history":{"type":"object","description":"Object containing customer's account history.","properties":{"createdAt":{"type":"string","format":"date","description":"When the account was created."},"modifiedAt":{"type":"string","format":"date","description":"When the account was last modified."},"passwordModifiedAt":{"type":"string","format":"date","description":"When the account password was last changed."},"paymentAccountEnrolledAt":{"type":"string","format":"date","description":"Date the payment account was added to the cardholder account."}}}}},"transaction":{"type":"object","description":"Object containing all customer transaction related risk data.","properties":{"reorder":{"type":"boolean","description":"If this is a repeat of a previous order."},"preOrderDate":{"type":"string","format":"date","description":"Expected date that a pre-ordered purchase will be available."},"firstName":{"maxLength":22,"minLength":1,"type":"string","description":"Customer's first name."},"lastName":{"maxLength":22,"minLength":1,"type":"string","description":"Customer's last name."},"phoneNumber":{"maxLength":20,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"Customer's phone number."},"history":{"type":"object","description":"Object containing details of the last transaction.","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."}}},"giftCardsPurchase":{"type":"object","description":"Object containing information on whether the order is being used to purchase a gift card.","properties":{"totalValue":{"required":["amount","currency"],"type":"object","description":"Object containing information on value of the gift cards being purchase.","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 amount being placed on the gift card. If provided, must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalValue.currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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. If provided must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalValue.amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"quantity":{"maximum":99,"minimum":0,"type":"integer","description":"The number of gift cards being purchased."}}}}},"shipping":{"type":"object","description":"Object containing all data related to how the order will be shipped.","properties":{"nameMatchesAccountName":{"type":"boolean","description":"If customer name on account is identical to the shipping name."},"method":{"enum":["billingAddress","verifiedAddress","otherAddress","store","digital","unshippedTickets","other"],"type":"string","description":"Field containing information on shipping method chosen by customer."},"timeFrame":{"enum":["electronic","twoDaysPlus","nextDay","sameDay"],"type":"string","description":"Timeframe chosen by customer for delivery."},"email":{"maxLength":128,"minLength":3,"pattern":"^.+@.+$","type":"string","description":"The email address used for an electronic delivery."},"address":{"type":"object","required":["address1","city","postalCode","countryCode"],"description":"An object containing the shipping address information.","properties":{"address1":{"type":"string","maxLength":80,"minLength":1,"description":"Shipping address line 1"},"address2":{"type":"string","maxLength":80,"minLength":1,"description":"Shipping address line 2"},"address3":{"type":"string","maxLength":80,"minLength":1,"description":"Shipping address line 3"},"postalCode":{"type":"string","maxLength":15,"minLength":1,"description":"Postcode of shipping address"},"city":{"maxLength":15,"minLength":1,"type":"string","description":"Shipping address city"},"countryCode":{"type":"string","maxLength":2,"minLength":2,"description":"Shipping address country code"},"state":{"type":"string","maxLength":30,"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":[]}]}]}]},"phoneNumber":{"type":"string","maxLength":20,"minLength":4,"pattern":"^[0-9]*$","description":"Shipping recipient's phone number."}}}}}}}}}},"components/schemas/3DS_authenticate_200_response":{"id":"components/schemas/3DS_authenticate_200_response","kind":"json-schema","title":"3DS_authenticate_200_response","data":{"required":["outcome"],"type":"object","properties":{"outcome":{"enum":["challenged","alreadyAuthenticated","notEnrolled","unavailable","authenticationFailed","authenticated","signatureFailed","bypassed"],"type":"string","description":"The outcome of the authentication request."},"transactionReference":{"maxLength":64,"minLength":1,"type":"string","description":"A unique reference for authentication that was passed in the request."},"authentication":{"type":"object","description":"Object that contains authentication related information.","properties":{"version":{"maxLength":10,"minLength":1,"type":"string","description":"The version of 3DS used to process the transaction."},"eci":{"maxLength":2,"minLength":1,"type":"string","description":"Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication."},"authenticationValue":{"maxLength":64,"minLength":1,"type":"string","description":"A cryptographic value that provides evidence of the outcome of a 3DS verification."},"transactionId":{"maxLength":64,"minLength":1,"type":"string","description":"A transaction identifier. If provided, you should use it as part of your payment authorization."}}},"challenge":{"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":"A digitally signed token that contains additional details, such as the URL to return to after the challenge screen."},"payload":{"maxLength":2048,"minLength":1,"type":"string","description":"JSON container with extra data required for the challenge."}}}}}},"components/schemas/3DS_authenticate_200_response_cartes_bancaires":{"id":"components/schemas/3DS_authenticate_200_response_cartes_bancaires","kind":"json-schema","title":"3DS_authenticate_200_response_cartes_bancaires","data":{"required":["outcome"],"type":"object","properties":{"outcome":{"enum":["challenged","notEnrolled","unavailable","authenticationFailed","authenticated","signatureFailed","bypassed"],"type":"string","description":"The outcome of the authentication request."},"transactionReference":{"maxLength":64,"minLength":1,"type":"string","description":"A unique reference for authentication that was passed in the request."},"authentication":{"type":"object","description":"Object that contains authentication related information.","properties":{"version":{"maxLength":10,"minLength":1,"type":"string","description":"The version of 3DS used to process the transaction."},"eci":{"maxLength":2,"minLength":1,"type":"string","description":"Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication."},"authenticationValue":{"maxLength":64,"minLength":1,"type":"string","description":"A cryptographic value that provides evidence of the outcome of a 3DS verification."},"transactionId":{"maxLength":64,"minLength":1,"type":"string","description":"A transaction identifier. If provided, you should use it as part of your payment authorization."},"cryptogramAlgorithm":{"maxLength":99999,"minLength":1,"type":"string","description":"Indicates the algorithm used to generate the cryptogram. Returned for Cartes Bancaires authentications only and must be applied in the following authorization request."},"challengePreference":{"maxLength":64,"minLength":1,"type":"string","description":"Indicates the preferred challenge behavior. Returned for Cartes Bancaires authentications only and must be applied in the following authorization request."},"authenticationFlow":{"maxLength":64,"minLength":1,"enum":["challenge","frictionless"],"type":"string","description":"Indicates which flow the customer has been directed to. Returned for Cartes Bancaires authentications only and must be applied in the following authorization request."},"statusReason":{"maxLength":2,"minLength":1,"type":"string","description":"Provides further information relating to the outcome of the authentication. Returned for failed authentications only. Returned for Cartes Bancaires authentications only."},"cancellationIndicator":{"maxLength":2,"minLength":0,"type":"string","description":"An indicator as to why the authentication was cancelled. Returned for Cartes Bancaires authentications only."},"networkScore":{"maxLength":2,"minLength":0,"type":"string","description":"The global score calculated by the Cartes Bancaires scoring platform. Returned for Cartes Bancaires authentications only."},"brand":{"maxLength":64,"minLength":0,"type":"string","description":"The card brand used in the authentication. Returned for Cartes Bancaires authentications only and must be applied in the following authorization."}}},"challenge":{"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":"A digitally signed token that contains additional details, such as the URL to return to after the challenge screen."},"payload":{"maxLength":2048,"minLength":1,"type":"string","description":"JSON container with extra data required for the challenge."}}}}}},"components/schemas/3DS_authenticate_400_response":{"id":"components/schemas/3DS_authenticate_400_response","kind":"json-schema","title":"3DS_authenticate_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":{"required":["errorName","jsonPath","message"],"type":"object","description":"Object containing details of validation errors occurred","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_authenticate_502_response":{"id":"components/schemas/3DS_authenticate_502_response","kind":"json-schema","title":"3DS_authenticate_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"}}}},"components/schemas/3DS_authenticate_503_response":{"id":"components/schemas/3DS_authenticate_503_response","kind":"json-schema","title":"3DS_authenticate_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"}}}},"components/schemas/3DS_verify":{"id":"components/schemas/3DS_verify","kind":"json-schema","title":"3DS_verify","data":{"required":["transactionReference","challenge","merchant"],"type":"object","properties":{"transactionReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$","type":"string","description":"A unique reference for authentication. For example, e-commerce order code."},"merchant":{"required":["entity"],"type":"object","description":"An object that contains information about the merchant and API level configuration.","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9 ]*$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding."}}},"challenge":{"required":["reference"],"type":"object","description":"Object containing challenge related information in case of a \"challenged\" flow","properties":{"reference":{"maxLength":20,"minLength":20,"pattern":"(^[A-Za-z0-9]*$)","type":"string","description":"The challenge reference obtained from the previous authentication request, in case the customer was redirected to a \"challenged\" flow."}}}}}},"components/schemas/3DS_verify_200_response":{"id":"components/schemas/3DS_verify_200_response","kind":"json-schema","title":"3DS_verify_200_response","data":{"type":"object","properties":{"outcome":{"enum":["authenticated","authenticationFailed","unavailable","signatureFailed","bypassed"],"type":"string","description":"Outcome of the previously posted authentication request."},"authentication":{"type":"object","description":"Object that contains authentication related information.","properties":{"version":{"maxLength":10,"minLength":1,"type":"string","description":"The version of 3DS used to process the transaction."},"eci":{"maxLength":2,"minLength":1,"type":"string","description":"Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS authentication."},"authenticationValue":{"maxLength":64,"minLength":1,"type":"string","description":"A cryptographic value that provides evidence of the outcome of a 3DS verification."},"transactionId":{"maxLength":64,"minLength":1,"type":"string","description":"A transaction identifier. If provided, you should use it as part of your payment authorization."}}},"transactionReference":{"maxLength":64,"minLength":1,"type":"string","description":"A unique reference for authentication that was passed in the request."}}}},"components/schemas/3DS_verify_400_response":{"id":"components/schemas/3DS_verify_400_response","kind":"json-schema","title":"3DS_verify_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":{"required":["errorName","jsonPath","message"],"type":"object","description":"Object containing details of validation errors occurred","properties":{"errorName":{"maxLength":2048,"minLength":1,"type":"string","description":"Unique name of the validation error"},"jsonPath":{"maxLength":2048,"minLength":1,"type":"string","description":"Location of the field in request body for which the error occurred"},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"Error description message"}}}}}},"schema_251":{"kind":"json-schema","data":{"type":"string","example":"application/vnd.worldpay.verifications.customers-v2.hal+json"},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/3DS_authenticate_200_response"},{"$ref":"#/components/schemas/3DS_authenticate_200_response_cartes_bancaires"}]},"id":"schema_252"}},"exampleStore":{"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument":{"value":{"transactionReference":"uniqueId","merchant":{"entity":"default"},"paymentInstrument":{"type":"card/tokenized","href":"https://tokens/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"}},"key":"Initialize the device data collection for a token payment instrument","summary":"Initialize the device data collection for a token payment instrument","description":"Initialize the device data collection for a token payment instrument","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument":{"value":{"transactionReference":"uniqueId","merchant":{"entity":"default"}},"key":"Initialize the device data collection without a payment instrument","summary":"Initialize the device data collection without a payment instrument","description":"Initialize the device data collection without a payment instrument","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"paymentInstrument":{"type":"card/wallet+googlepay","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\\\"}\"}"}},"key":"Initialize the device data collection for Google Pay","summary":"Initialize the device data collection for Google Pay","description":"Initialize the device data collection for Google Pay","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for Google Pay"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument":{"value":{"outcome":"initialized","transactionReference":"uniqueId","deviceDataCollection":{"jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJvcmcgdW5pdCBpZCIsImlzcyI6ImFwaSBpZCIsImV4cCI6MTI5NDUsImlhdCI6MTIzNDUsImp0aSI6ImU1ODY2MDYzLWVmYmMtNGY5My1iYmI3LTg1MDkzZjAxZGZjZCJ9.SUafrXef_d3915NeHygKGP5LmnQXz2Jdxjhtj5OJRsw","url":"https://secure.worldpay.com/url/to/ddc.html","bin":"444433"},"_links":{"curies":[{"href":"https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}],"3ds:authenticate":{"href":"authenticate"}}},"key":"Initialize the device data collection for a token payment instrument","summary":"Initialize the device data collection for a token payment instrument","description":"Initialize the device data collection for a token payment instrument","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection for a token payment instrument"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument":{"value":{"outcome":"initialized","transactionReference":"uniqueId","deviceDataCollection":{"jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJvcmcgdW5pdCBpZCIsImlzcyI6ImFwaSBpZCIsImV4cCI6MTI5NDUsImlhdCI6MTIzNDUsImp0aSI6ImU1ODY2MDYzLWVmYmMtNGY5My1iYmI3LTg1MDkzZjAxZGZjZCJ9.SUafrXef_d3915NeHygKGP5LmnQXz2Jdxjhtj5OJRsw","url":"https://secure.worldpay.com/url/to/ddc.html"},"_links":{"curies":[{"href":"https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}],"3ds:authenticate":{"href":"authenticate"}}},"key":"Initialize the device data collection without a payment instrument","summary":"Initialize the device data collection without a payment instrument","description":"Initialize the device data collection without a payment instrument","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/Initialize the device data collection without a payment instrument"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`":{"value":{"message":"The json body provided does not match the expected schema","errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"stringIsTooShort","jsonPath":"$.transactionReference","message":"Transaction reference must be between 1 and 64 characters inclusive"}],"_links":{"3ds:deviceDataInitialize":{"href":"$serverUrl/verifications/customers/3ds/deviceDataInitialization"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"key":"The request is missing a mandatory field `transactionReference`","summary":"The request is missing a mandatory field `transactionReference`","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request does not have a mandatory field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionReference"},"children":[]}]}]}],"id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `transactionReference`"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/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":{"3ds:deviceDataInitialize":{"href":"$serverUrl/verifications/customers/3ds/deviceDataInitialization"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"key":"The request contains an invalid `Content-Type` header","summary":"The request contains an invalid `Content-Type` header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains an invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}],"id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream":{"value":{"path":"/verifications/customers/3ds/deviceDataInitialization","status":502,"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:deviceDataInitialize":{"href":"$serverUrl/verifications/customers/3ds/deviceDataInitialization"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"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/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"},"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable":{"value":{"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:deviceDataInitialize":{"href":"$serverUrl/verifications/customers/3ds/deviceDataInitialization"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1verifications~1customers~13ds~1deviceDataInitialize/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"},"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response":{"value":{"transactionReference":"uniqueId","merchant":{"entity":"default"},"instruction":{"paymentInstrument":{"type":"card/front","cardHolderName":"Card Holder Name","cardNumber":"4444333322221111","cardExpiryDate":{"month":5,"year":2035},"billingAddress":{"address1":"Address 1","address2":"Address 2","address3":"Address 3","postalCode":"Postal Code","city":"City","state":"State","countryCode":"GB"}},"value":{"currency":"GBP","amount":42}},"challenge":{"returnUrl":"https://returnUrl.com"},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","collectionReference":"reference"},"riskData":{"account":{"previousSuspiciousActivity":true,"type":"guestUser","history":{"createdAt":"2002-11-23","modifiedAt":"2003-10-21","passwordModifiedAt":"2005-02-10","paymentAccountEnrolledAt":"2004-09-02"}},"transaction":{"reorder":true,"preOrderDate":"2010-08-04","history":{"attemptsLastDay":2,"attemptsLastYear":6,"completedLastSixMonths":7,"addCardsLastDay":5,"shippingAddressFirstUsedAt":"2009-02-22"},"giftCardsPurchase":{"totalValue":{"currency":"GBP","amount":10},"quantity":4}},"shipping":{"nameMatchesAccountName":false,"method":"digital","timeFrame":"electronic","email":"customer@website.com"}}},"key":"An example of a 3DS2 authentication request containing card details which results in an authenticated response","summary":"An example of a 3DS2 authentication request containing card details which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response":{"value":{"transactionReference":"uniqueId","merchant":{"entity":"default"},"instruction":{"paymentInstrument":{"type":"card/tokenized","href":"https://tokens/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"},"value":{"currency":"GBP","amount":42}},"challenge":{"returnUrl":"https://returnUrl.com"},"deviceData":{"acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)","collectionReference":"reference"},"riskData":{"account":{"previousSuspiciousActivity":true,"type":"guestUser","history":{"createdAt":"2002-11-23","modifiedAt":"2003-10-21","passwordModifiedAt":"2005-02-10","paymentAccountEnrolledAt":"2004-09-02"}},"transaction":{"reorder":true,"preOrderDate":"2010-08-04","history":{"attemptsLastDay":2,"attemptsLastYear":6,"completedLastSixMonths":7,"addCardsLastDay":5,"shippingAddressFirstUsedAt":"2009-02-22"},"giftCardsPurchase":{"totalValue":{"currency":"GBP","amount":10},"quantity":4}},"shipping":{"nameMatchesAccountName":false,"method":"digital","timeFrame":"electronic","email":"customer@website.com"}}},"key":"An example of a 3DS2 authentication request containing a token which results in an authenticated response","summary":"An example of a 3DS2 authentication request containing a token which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response":{"value":{"transactionReference":"unique-transactionReference","merchant":{"entity":"default"},"instruction":{"paymentInstrument":{"type":"card/wallet+googlepay","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\\\"}\"}"}},"value":{"currency":"GBP","amount":250},"deviceData":{"collectionReference":"0_3XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX6b5","acceptHeader":"text/html","userAgentHeader":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0)"},"challenge":{"returnUrl":"http://returnUrl.example.com"}},"key":"An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response","summary":"An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a Google Pay token which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response":{"value":{"outcome":"authenticated","transactionReference":"uniqueId","authentication":{"version":"2.1.0","authenticationValue":"authValue","eci":"02","transactionId":"transaction1234567890"}},"key":"An example of a 3DS2 authentication request containing card details which results in an authenticated response","summary":"An example of a 3DS2 authentication request containing card details which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing card details which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response":{"value":{"outcome":"authenticated","transactionReference":"uniqueId","authentication":{"version":"2.1.0","authenticationValue":"authValue","eci":"02","transactionId":"transaction1234567890"}},"key":"An example of a 3DS2 authentication request containing a token which results in an authenticated response","summary":"An example of a 3DS2 authentication request containing a token which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 authentication request containing a token which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response":{"value":{"authentication":{"authenticationValue":"authValue","eci":"02","transactionId":"transaction1234567890","version":"2.1.0","cryptogramAlgorithm":1,"challengePreference":"challengeMandated","authenticationFlow":"frictionless","networkScore":"01","brand":"cartesBancaires"},"outcome":"authenticated","transactionReference":"uniqueId"},"key":"An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response","summary":"An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response","id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS2 Cartes Bancaires request for authentication containing card details from which results in an authenticated response"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`":{"value":{"message":"The json body provided does not match the expected schema","errorName":"bodyDoesNotMatchSchema","validationErrors":[{"errorName":"fieldIsMissing","jsonPath":"$.merchant","message":"Merchant must be provided"}],"_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"key":"The request is missing a mandatory field `merchant`","summary":"The request is missing a mandatory field `merchant`","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request does not have a mandatory field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]}]}]}],"id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is missing a mandatory field `merchant`"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/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":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"key":"The request contains an invalid `Content-Type` header","summary":"The request contains an invalid `Content-Type` header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains an invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}],"id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method":{"value":{"errorName":"methodNotAllowed","allowedMethods":["POST"],"message":"Method GET not allowed for this request","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"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/~1verifications~1customers~13ds~1authenticate/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream":{"value":{"path":"/verifications/customers/3ds/authentication","status":502,"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"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/~1verifications~1customers~13ds~1authenticate/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"},"paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable":{"value":{"path":"/verifications/customers/3ds/authentication","status":503,"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1verifications~1customers~13ds~1authenticate/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"},"paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request":{"value":{"transactionReference":"sRMPWCQoQrEiVxehTnu0","merchant":{"entity":"default"},"challenge":{"reference":"uniqueChallengeRef12"}},"key":"An example of a 3DS Verification request","summary":"An example of a 3DS Verification request","description":"An example of a 3DS Verification request","id":"paths/~1verifications~1customers~13ds~1verification/post/requestBody/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"},"paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request":{"value":{"outcome":"authenticated","transactionReference":"sRMPWCQoQrEiVxehTnu0","authentication":{"version":"1.0.2","authenticationValue":"MAAAAAAAAAAAAAAAAAAAAAAAAAA=","eci":"05","transactionId":"k4Vf36ijnJX54kwHQNqUr8"},"_links":{"curies":[{"href":"https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}],"3ds:authenticate":{"href":"authenticate"},"3ds:verify":{"href":"authenticate/verify"}}},"key":"An example of a 3DS Verification request","summary":"An example of a 3DS Verification request","description":"An example of a 3DS Verification request","id":"paths/~1verifications~1customers~13ds~1verification/post/responses/200/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An example of a 3DS Verification request"},"paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters":{"value":{"path":"/verifications/customers/3ds/verification","status":400,"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":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"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/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains invalid characters"},"paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header":{"value":{"path":"/verifications/customers/3ds/verification","status":400,"message":"Provided request contains a header with an invalid value","errorName":"headerHasInvalidValue","headerName":"Content-Type","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","name":"3ds","templated":true}]}},"key":"The request contains an invalid `Content-Type` header","summary":"The request contains an invalid `Content-Type` header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request contains an invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}],"id":"paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request contains an invalid `Content-Type` header"},"paths/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method":{"value":{"message":"Method GET not allowed for this request","errorName":"methodNotAllowed","allowedMethods":["POST"],"_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"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/~1verifications~1customers~13ds~1verification/post/responses/400/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The request is using an invalid HTTP method"},"paths/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream":{"value":{"path":"/verifications/customers/3ds/authentication","status":502,"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"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/~1verifications~1customers~13ds~1verification/post/responses/502/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/An invalid response is received from upstream"},"paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable":{"value":{"path":"/verifications/customers/3ds/authentication","status":503,"message":"Service Unavailable","errorName":"serviceUnavailable","_links":{"3ds:authenticate":{"href":"$serverUrl/verifications/customers/3ds/authentication"},"3ds:verify":{"href":"$serverUrl/verifications/customers/3ds/verification"},"curies":[{"href":"$serverUrl/rels/verifications/customers/3ds/{rel}","templated":true,"name":"3ds"}]}},"key":"The requested service is unavailable","summary":"The requested service is unavailable","description":"The requested service is unavailable","id":"paths/~1verifications~1customers~13ds~1verification/post/responses/503/content/application~1vnd.worldpay.verifications.customers-v2.hal+json/examples/The requested service is unavailable"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/3ds/@v2/openapi.json?download"},{"url":"/access/_bundle/products/3ds/@v2/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"3DS","description":"Protect your business and meet regulatory requirements by verifying your customer's identity with our 3DS API."}},"baseSlug":"/products/3ds/v2/openapi","routesMapping":{}}