{"items":[{"type":"link","label":"3D Secure authentication service API","link":"/apis/three-d-secure-authentication","routeSlug":"/apis/three-d-secure-authentication","content":{"contentType":"overview","meta":{"name":"3D Secure authentication service API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"three-d-secure-authentication.json","url":"/_bundle/apis/three-d-secure-authentication.json?download"},{"kind":"download","label":"three-d-secure-authentication.yaml","url":"/_bundle/apis/three-d-secure-authentication.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"3D Secure authentication service API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the 3D Secure authentication service."}],"sectionId":"/apis/three-d-secure-authentication"}],"sectionId":"/apis/three-d-secure-authentication"}]}]}},{"type":"group","label":"Standalone authentication","link":"/apis/three-d-secure-authentication/standalone-authentication","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication","items":[{"label":"Pre-initiate a standalone authentication request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/pre-initiate-standalone-auth-request","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/pre-initiate-standalone-auth-request","metadata":{"seo":{"title":"Pre-initiate a standalone authentication request","description":"Pre-initiates a stand-alone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The pre-initiation step gathers necessary information and ensures that all required data is available and valid before proceeding with the actual authentication request. This process helps to streamline the authentication process and enhance security."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pre-initiate-standalone-auth-request","name":"Pre-initiate a standalone authentication request","isWebhook":false,"pointer":"/paths/~1threedsecure~1standalone~1authentications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pre-initiate a standalone authentication request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pre-initiates a stand-alone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The pre-initiation step gathers necessary information and ensures that all required data is available and valid before proceeding with the actual authentication request. This process helps to streamline the authentication process and enhance security."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/standaloneAuthenticationPreinitiationRequest"}},"schemaId":"components/schemas/standaloneAuthenticationPreinitiationRequest","pointer":"/paths/~1threedsecure~1standalone~1authentications/post/requestBody","description":"Request payload for pre-initiating a standalone authentication."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/threedsecure/standalone/authentications","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/standaloneAuthenticationPreinitiationRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/standalone/authentications","href":"standalone-authentication/pre-initiate-standalone-auth-request","openApiOperationId":"pre-initiate-standalone-auth-request","summary":"Pre-initiate a standalone authentication request"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"schemaId":"components/schemas/standaloneAuthenticationPreinitiationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/standaloneAuthenticationPreinitiationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/standaloneAuthenticationPreinitiationResponse"}},"schemaId":"components/schemas/standaloneAuthenticationPreinitiationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1standalone~1authentications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/standaloneAuthenticationPreinitiationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/standaloneAuthenticationPreinitiationResponse"}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standalone-authentication/pre-initiate-standalone-auth-request"}],"panels":[]}]},"httpPath":"/threedsecure/standalone/authentications"},{"label":"Initiate a standalone authentication request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/initiate-standalone-auth-request","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/initiate-standalone-auth-request","metadata":{"seo":{"title":"Initiate a standalone authentication request","description":"Initiates a standalone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The process involves verifying the cardholder's identity through a browser-based interaction. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow. This ensures a secure and efficient authentication process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-standalone-auth-request","name":"Initiate a standalone authentication request","isWebhook":false,"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a standalone authentication request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a standalone 3D Secure authentication request for a transaction. This endpoint is for merchants who use PXP's service solely for authentication purposes. The process involves verifying the cardholder's identity through a browser-based interaction. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow. This ensures a secure and efficient authentication process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_137","required":true}],"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/standaloneBrowserAuthenticationRequest"}},"schemaId":"components/schemas/standaloneBrowserAuthenticationRequest","pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/threedsecure/standalone/authentications/{authenticationId}/browser-authentication","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_137"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/standaloneBrowserAuthenticationRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/standalone/authentications/{authenticationId}/browser-authentication","href":"standalone-authentication/initiate-standalone-auth-request","openApiOperationId":"initiate-standalone-auth-request","summary":"Initiate a standalone authentication request"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"schemaId":"components/schemas/standaloneBrowserAuthenticationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/standaloneBrowserAuthenticationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/standaloneBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]}},"schemaId":"components/schemas/standaloneBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/standaloneBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/standaloneBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standalone-authentication/initiate-standalone-auth-request"}],"panels":[]}]},"httpPath":"/threedsecure/standalone/authentications/{authenticationId}/browser-authentication"},{"label":"Get 3DS authentication by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/standalone-authentication/retrieve-auth-by-id","routeSlug":"/apis/three-d-secure-authentication/standalone-authentication/retrieve-auth-by-id","metadata":{"seo":{"title":"Get 3DS authentication by ID","description":"This endpoint retrieves the details of a specific 3DS standalone authentication using the authenticationId provided in the path. The service is designed for retrieving authentication records that were created as part of a 3DS verification process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-auth-by-id","name":"Get 3DS authentication by ID","isWebhook":false,"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 3DS authentication by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific 3DS standalone authentication using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the path. The service is designed for retrieving authentication records that were created as part of a 3DS verification process."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_137","required":true}],"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/threedsecure/standalone/authentications/{authenticationId}","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_137"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/standalone/authentications/{authenticationId}","href":"standalone-authentication/retrieve-auth-by-id","openApiOperationId":"retrieve-auth-by-id","summary":"Get 3DS authentication by ID"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAuthenticationResponse"}},"schemaId":"components/schemas/getAuthenticationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1standalone~1authentications~1{authenticationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getAuthenticationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAuthenticationResponse"}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standalone-authentication/retrieve-auth-by-id"}],"panels":[]}]},"httpPath":"/threedsecure/standalone/authentications/{authenticationId}"}],"content":{"contentType":"group","meta":{"name":"Standalone authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Standalone authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/threedsecure/standalone/authentications","summary":"Pre-initiate a standalone authentication request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/standalone-authentication/pre-initiate-standalone-auth-request","deprecated":false},{"title":"/threedsecure/standalone/authentications/{authenticationId}/browser-authentication","summary":"Initiate a standalone authentication request","prefix":{"name":"put","color":"put"},"badges":[],"link":"/standalone-authentication/initiate-standalone-auth-request","deprecated":false},{"title":"/threedsecure/standalone/authentications/{authenticationId}","summary":"Get 3DS authentication by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standalone-authentication/retrieve-auth-by-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Integrated authentication","link":"/apis/three-d-secure-authentication/integrated-authentication","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication","items":[{"label":"Pre-initiate an integrated authentication request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/pre-initiate-integrated-auth-request","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/pre-initiate-integrated-auth-request","metadata":{"seo":{"title":"Pre-initiate an integrated authentication request","description":"Pre-initiates an integrated 3D Secure authentication request for a transaction. In integrated mode, PXP processes the transaction in a separate initiate transaction request using the 3D Secure supplied data. This step ensures that all required data is gathered and validated before the full authentication process, facilitating a smoother and more secure transaction flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pre-initiate-integrated-auth-request","name":"Pre-initiate an integrated authentication request","isWebhook":false,"pointer":"/paths/~1threedsecure~1integrated~1authentications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pre-initiate an integrated authentication request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pre-initiates an integrated 3D Secure authentication request for a transaction. In integrated mode, PXP processes the transaction in a separate initiate transaction request using the 3D Secure supplied data. This step ensures that all required data is gathered and validated before the full authentication process, facilitating a smoother and more secure transaction flow."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationRequest"}},"schemaId":"components/schemas/integratedAuthenticationPreinitiationRequest","pointer":"/paths/~1threedsecure~1integrated~1authentications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/threedsecure/integrated/authentications","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/integrated/authentications","href":"integrated-authentication/pre-initiate-integrated-auth-request","openApiOperationId":"pre-initiate-integrated-auth-request","summary":"Pre-initiate an integrated authentication request"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"schemaId":"components/schemas/integratedAuthenticationPreinitiationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"}},"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1integrated~1authentications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrated-authentication/pre-initiate-integrated-auth-request"}],"panels":[]}]},"httpPath":"/threedsecure/integrated/authentications"},{"label":"Initiate an integrated authentication request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/initiate-integrated-auth-request","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/initiate-integrated-auth-request","metadata":{"seo":{"title":"Initiate an integrated authentication request","description":"Authenticates an integrated 3D Secure transaction request. In integrated mode, PXP processes the transaction in conjunction with the 3D Secure authentication data. This ensures that the transaction is authenticated securely, leveraging the full authentication data collected during the pre-initiation phase. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-integrated-auth-request","name":"Initiate an integrated authentication request","isWebhook":false,"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate an integrated authentication request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticates an integrated 3D Secure transaction request. In integrated mode, PXP processes the transaction in conjunction with the 3D Secure authentication data. This ensures that the transaction is authenticated securely, leveraging the full authentication data collected during the pre-initiation phase. The request payload must include comprehensive details about the transaction, card information, merchant information, and additional contextual data necessary for the 3D Secure authentication flow."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_137","required":true}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integratedBrowserAuthenticationRequest"}},"schemaId":"components/schemas/integratedBrowserAuthenticationRequest","pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/threedsecure/integrated/authentications/{authenticationId}/browser-authentication","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_137"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/integratedBrowserAuthenticationRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/integrated/authentications/{authenticationId}/browser-authentication","href":"integrated-authentication/initiate-integrated-auth-request","openApiOperationId":"initiate-integrated-auth-request","summary":"Initiate an integrated authentication request"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"schemaId":"components/schemas/integratedBrowserAuthenticationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integratedBrowserAuthenticationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]}},"schemaId":"components/schemas/integratedBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/integratedBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedBrowserAuthenticationResponse","exampleIds":["paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication","paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"]}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrated-authentication/initiate-integrated-auth-request"}],"panels":[]}]},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/browser-authentication"},{"label":"Get 3DS pre-initiate authentication details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/get-preinitiate-authentication-details","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/get-preinitiate-authentication-details","metadata":{"seo":{"title":"Get 3DS pre-initiate authentication details","description":"Retrieves the details of a specific 3DS pre-initiate authentication using the authenticationId provided in the path. Note: This endpoint is intended for use with the Components SDKs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-preinitiate-authentication-details","name":"Get 3DS pre-initiate authentication details","isWebhook":false,"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1assessment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 3DS pre-initiate authentication details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the details of a specific 3DS pre-initiate authentication using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the path. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is intended for use with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../guides/components"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Components SDKs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_137","required":true}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1assessment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/threedsecure/integrated/authentications/{authenticationId}/assessment","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_137"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/integrated/authentications/{authenticationId}/assessment","href":"integrated-authentication/get-preinitiate-authentication-details","openApiOperationId":"get-preinitiate-authentication-details","summary":"Get 3DS pre-initiate authentication details"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"}},"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1assessment/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integratedAuthenticationPreinitiationResponse"}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrated-authentication/get-preinitiate-authentication-details"}],"panels":[]}]},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/assessment"},{"label":"Get 3DS authentication details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/three-d-secure-authentication/integrated-authentication/get-authentication-details","routeSlug":"/apis/three-d-secure-authentication/integrated-authentication/get-authentication-details","metadata":{"seo":{"title":"Get 3DS authentication details","description":"Retrieves the complete details of a specific 3DS authentication using the authenticationId provided in the path.  Note: This endpoint is intended for use with the Components SDKs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-authentication-details","name":"Get 3DS authentication details","isWebhook":false,"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1outcome/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 3DS authentication details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the complete details of a specific 3DS authentication using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the path.  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is intended for use with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../guides/components"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Components SDKs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticationId","in":"path","schemaId":"schema_137","required":true}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1outcome/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/threedsecure/integrated/authentications/{authenticationId}/outcome","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[{"name":"authenticationId","in":"path","required":true,"schemaId":"schema_137"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/threedsecure/integrated/authentications/{authenticationId}/outcome","href":"integrated-authentication/get-authentication-details","openApiOperationId":"get-authentication-details","summary":"Get 3DS authentication details"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAuthenticationDetailsResponse"}},"schemaId":"components/schemas/getAuthenticationDetailsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}},"schemaId":"components/schemas/errorResponse"}],"pointer":"/paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1outcome/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getAuthenticationDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAuthenticationDetailsResponse"}}},{"code":"400","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"401","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"403","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"404","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}},{"code":"500","schemaId":"components/schemas/errorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/integrated-authentication/get-authentication-details"}],"panels":[]}]},"httpPath":"/threedsecure/integrated/authentications/{authenticationId}/outcome"}],"content":{"contentType":"group","meta":{"name":"Integrated authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Integrated authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/threedsecure/integrated/authentications","summary":"Pre-initiate an integrated authentication request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/integrated-authentication/pre-initiate-integrated-auth-request","deprecated":false},{"title":"/threedsecure/integrated/authentications/{authenticationId}/browser-authentication","summary":"Initiate an integrated authentication request","prefix":{"name":"put","color":"put"},"badges":[],"link":"/integrated-authentication/initiate-integrated-auth-request","deprecated":false},{"title":"/threedsecure/integrated/authentications/{authenticationId}/assessment","summary":"Get 3DS pre-initiate authentication details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrated-authentication/get-preinitiate-authentication-details","deprecated":false},{"title":"/threedsecure/integrated/authentications/{authenticationId}/outcome","summary":"Get 3DS authentication details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/integrated-authentication/get-authentication-details","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/authenticationAmounts":{"id":"components/schemas/authenticationAmounts","kind":"json-schema","title":"authenticationAmounts","data":{"required":["currencyCode","transactionValue"],"type":"object","description":"Details about the authenticated transaction's amount.","properties":{"transactionValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the authenticated transaction. The numbers after the decimal will be zero padded if they are less than the expected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exponent, for example, GBP 1.234, or if a decimal is supplied when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exponent doesn't require it (e.g., JPY 1.0)."},"children":[]}]}]}],"type":"number","format":"double"},"currencyCode":{"description":"The currency code associated with the transaction, in ISO 4217 format. This three-character code specifies the currency in which the transaction is processed, ensuring clarity and consistency across international transactions.","minLength":3,"maxLength":3,"type":"string","example":"EUR"}},"additionalProperties":false}},"components/schemas/browserAuthenticationAddressRequest":{"id":"components/schemas/browserAuthenticationAddressRequest","kind":"json-schema","title":"browserAuthenticationAddressRequest","data":{"description":"Details of the address used in browser-based authentication.","type":"object","properties":{"city":{"description":"The city of the address.","maxLength":50,"minLength":0,"type":"string","nullable":true,"example":"San Francisco"},"countryNumericCode":{"description":"The numeric code representing the country of the address, following ISO 3166-1 numeric standard.","maxLength":3,"minLength":3,"type":"string","nullable":true,"example":"840"},"line1":{"description":"The first line of the address, typically representing the street address or PO box number.","maxLength":50,"minLength":0,"type":"string","nullable":true,"example":"123 Market St"},"line2":{"description":"The second line of the address, if applicable, for additional address information.","maxLength":50,"minLength":0,"type":"string","nullable":true,"example":"Apt 456"},"line3":{"description":"The third line of the address, if applicable, for additional address information.","maxLength":50,"minLength":0,"type":"string","nullable":true,"example":"Building B"},"postalCode":{"description":"The postal or ZIP code of the address, which can vary in length based on the country.","maxLength":16,"minLength":0,"type":"string","nullable":true,"example":"94105"},"stateCode":{"description":"The state or province of the address.","maxLength":3,"minLength":0,"type":"string","nullable":true,"example":"CA"}},"additionalProperties":false}},"components/schemas/browserAuthenticationBrowserInformationRequest":{"id":"components/schemas/browserAuthenticationBrowserInformationRequest","kind":"json-schema","title":"browserAuthenticationBrowserInformationRequest","data":{"description":"Information about the browser used in the authentication process.","required":["acceptHeader","colorDepth","javaEnabled","javaScriptEnabled","language","screenHeight","screenWidth","timeZoneOffsetInMinutes","userAgent"],"type":"object","properties":{"acceptHeader":{"description":"The Accept HTTP header field from the browser.","maxLength":2048,"minLength":0,"type":"string","example":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8"},"colorDepth":{"description":"The colour depth of the browser's screen, measured in bits per pixel.","type":"integer","format":"int32","example":24},"ipAddress":{"description":"The IP address of the device running the browser, if available.","maxLength":45,"minLength":0,"type":"string","nullable":true,"example":"192.168.1.1"},"javaEnabled":{"description":"Whether the browser has Java enabled.","type":"boolean","example":true},"javaScriptEnabled":{"description":"Whether the browser has JavaScript enabled.","type":"boolean","example":true},"language":{"maxLength":8,"minLength":0,"type":"string","description":"The IETF BCP 47 language tag.","example":"en-US"},"screenHeight":{"description":"The height of the browser's screen in pixels.","type":"integer","format":"int32","example":1080},"screenWidth":{"description":"The width of the browser's screen in pixels.","type":"integer","format":"int32","example":1920},"timeZoneOffsetInMinutes":{"description":"The difference, in minutes, between UTC and the local time of the browser.","type":"integer","format":"int32","example":-420},"userAgent":{"description":"The User-Agent string of the browser.","maxLength":2048,"minLength":0,"type":"string","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"}},"additionalProperties":false}},"components/schemas/browserAuthenticationCardholderInformationRequest":{"id":"components/schemas/browserAuthenticationCardholderInformationRequest","kind":"json-schema","title":"browserAuthenticationCardholderInformationRequest","data":{"description":"Details about the shopper involved in the authentication.","type":"object","properties":{"email":{"description":"The email address of the shopper.","maxLength":254,"minLength":0,"type":"string","nullable":true,"example":"johndoe@example.com"},"homePhoneNumber":{"description":"The home phone number of the shopper.","pattern":"^\\d{1,3}-\\d{1,15}$","type":"string","nullable":true,"example":"+1234567890"},"mobilePhoneNumber":{"description":"The mobile phone number of the shopper.","pattern":"^\\d{1,3}-\\d{1,15}$","type":"string","nullable":true,"example":"+0987654321"},"workPhoneNumber":{"description":"The work phone number of the shopper.","pattern":"^\\d{1,3}-\\d{1,15}$","type":"string","nullable":true,"example":"+1123456789"}},"additionalProperties":false}},"components/schemas/errorResponse":{"id":"components/schemas/errorResponse","kind":"json-schema","title":"errorResponse","data":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorReason":{"type":"string","nullable":true},"correlationId":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/getAuthenticationResponse":{"id":"components/schemas/getAuthenticationResponse","kind":"json-schema","title":"getAuthenticationResponse","data":{"type":"object","properties":{"authenticationId":{"description":"A unique reference provided by PXP for the authentication request, represented as a GUID.","type":"string","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"state":{"$ref":"#/components/schemas/authenticationStateEnum"},"threeDSecureVersion":{"description":"The version of the 3D Secure protocol being used for the authentication.","type":"string","nullable":true,"example":"2.1.0"},"directoryServerTransactionId":{"description":"The Directory Server transaction ID.","type":"string","nullable":true},"cardholderAuthenticationVerificationValue":{"description":"A value generated during the authentication process to verify the cardholder's identity.","type":"string","nullable":true,"example":"CAVV1234567890"},"electronicCommerceIndicator":{"$ref":"#/components/schemas/electronicCommerceIndicatorProperty"}},"additionalProperties":false}},"components/schemas/integratedAuthenticationPreinitiationRequest":{"id":"components/schemas/integratedAuthenticationPreinitiationRequest","kind":"json-schema","title":"integratedAuthenticationPreinitiationRequest","data":{"description":"Request schema for pre-initiating an integrated authentication.","required":["card","fingerprintCallbackUrl","site"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/authenticationAmounts"},"fingerprintCallbackUrl":{"description":"The fingerprint callback URL.","minLength":1,"type":"string"},"providerId":{"description":"The unique identifier for the provider.","maxLength":36,"minLength":0,"type":"string","nullable":true,"example":"provider_123456"},"intent":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The intent of the authentication request. This field is conditionally required: it's required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"providerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't sent, otherwise it's optional. It makes sense to authenticate transactions with the following intents:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EstimatedAuthorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]}]}]}]}],"type":"string","nullable":true,"enum":["Authorisation","Purchase","Payout","EstimatedAuthorisation","Verification","Refund","Void","Capture","Incremental","StandaloneRefund"]},"requestorAuthenticationIndicator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator used to specify the type of authentication request, such as payment authentication or account verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial recurring transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial card-on-file transaction for subsequent MITs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial card-on-file transaction for subsequent CITs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Store card details without purchase (card verification)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Instalment transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Billing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Split shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delayed shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Split payment"},"children":[]}]}]}]}],"maxLength":2,"minLength":0,"type":"string","nullable":true,"example":"01"},"site":{"description":"The site identifier for the merchant.","maxLength":10,"minLength":0,"type":"string"},"card":{"$ref":"#/components/schemas/preinitiationCardData"}},"additionalProperties":false}},"components/schemas/integratedAuthenticationPreinitiationResponse":{"id":"components/schemas/integratedAuthenticationPreinitiationResponse","kind":"json-schema","title":"integratedAuthenticationPreinitiationResponse","data":{"description":"Response schema for pre-initiating an integrated authentication.","type":"object","properties":{"authenticationId":{"description":" A unique reference provided by PXP for the authentication request, represented as a GUID.","type":"string","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the authentication request. For pre-initiation, this can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClientData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or null (if the card isn't enrolled for 3DS)."},"children":[]}]}]}],"enum":["PendingClientData"]},"scaMandated":{"description":"Whether Strong Customer Authentication (SCA) is mandated for this transaction.","type":"boolean","example":true},"applicableExemptions":{"description":"Specifies any exemptions that apply to the transaction from SCA requirements.","type":"string","nullable":true,"enum":["LVP","TRA"]},"threeDSecureVersion":{"description":"The version of the 3D Secure protocol being used for the authentication.","type":"string","nullable":true,"example":"2.1.0"},"threeDSecureFingerprintUrl":{"description":"The URL to which the 3D Secure method data should be sent.","type":"string","nullable":true,"example":"https://example.com/3ds-method"},"threeDSecureFingerprintData":{"description":"Data required for the 3D Secure method, typically a base64 encoded string.","type":"string","nullable":true,"example":"eyJ0aHJlZURTU2VjdXJlTWV0aG9kRGF0YSI6IlhYWiJ9"},"threeDSecureSupported":{"description":"Whether 3D Secure authentication is supported for this transaction.","type":"boolean","example":true},"recommendedChallengeIndicator":{"description":"The recommended challenge indicator.","type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/getAuthenticationDetailsResponse":{"id":"components/schemas/getAuthenticationDetailsResponse","kind":"json-schema","title":"getAuthenticationDetailsResponse","data":{"description":"Simplified response schema for retrieving 3DS authentication details via GET.","type":"object","properties":{"uniqueId":{"type":"string","nullable":true,"description":"The unique identifier for the authentication response."},"state":{"$ref":"#/components/schemas/authenticationStateEnum"},"transactionStatus":{"$ref":"#/components/schemas/transactionStatusEnum"},"electronicCommerceIndicator":{"$ref":"#/components/schemas/electronicCommerceIndicatorProperty"},"exemptionGranted":{"description":"Whether an exemption from Strong Customer Authentication (SCA) was granted.","type":"boolean"},"exemptionGrantedByIssuer":{"$ref":"#/components/schemas/exemptionGrantedByIssuerProperty"}},"additionalProperties":false}},"components/schemas/integratedBrowserAuthenticationRequest":{"id":"components/schemas/integratedBrowserAuthenticationRequest","kind":"json-schema","title":"integratedBrowserAuthenticationRequest","data":{"description":"Request schema for browser-based integrated authentication.","required":["browserData","challengeCallbackUrl","challengeWindowSize","merchantCountryNumericCode","merchantLegalName","requestorChallengeIndicator","shopper"],"type":"object","properties":{"fingerprintNotification":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL for notifying the fingerprinting result. Base64 of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"threeDSMethodNotificationURL\":\"method url value\",\"threeDSServerTransID\":\"transaction id value\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchantCountryNumericCode":{"description":"The three-digit country code of the merchant, following ISO 3166-1 numeric standard.","maxLength":3,"minLength":3,"type":"string","example":"840"},"merchantLegalName":{"description":"The legal name of the merchant.","maxLength":40,"minLength":0,"type":"string","example":"ACME Ltd"},"challengeWindowSize":{"$ref":"#/components/schemas/challengeWindowSizeProperty"},"requestorChallengeIndicator":{"$ref":"#/components/schemas/integratedRequestorChallengeIndicatorProperty"},"challengeCallbackUrl":{"maxLength":256,"minLength":1,"type":"string","format":"uri","description":"The fully qualified URL of the system that receives the CRes message or error message. The CRes message is posted by the ACS through the cardholder's browser at the end of the challenge and receipt of the RRes message."},"recurring":{"$ref":"#/components/schemas/recurringData"},"billingAddress":{"$ref":"#/components/schemas/browserAuthenticationAddressRequest"},"shippingAddress":{"$ref":"#/components/schemas/browserAuthenticationAddressRequest"},"browserData":{"$ref":"#/components/schemas/browserAuthenticationBrowserInformationRequest"},"shopper":{"$ref":"#/components/schemas/browserAuthenticationCardholderInformationRequest"}},"additionalProperties":false}},"components/schemas/integratedBrowserAuthenticationResponse":{"id":"components/schemas/integratedBrowserAuthenticationResponse","kind":"json-schema","title":"integratedBrowserAuthenticationResponse","data":{"description":"Response schema for browser-based integrated authentication.","type":"object","properties":{"uniqueId":{"type":"string","nullable":true},"state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the authentication request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClientData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't returned during initiation."},"children":[]}]}]}],"enum":["AuthenticationSuccessful","AuthenticationFailed","AuthenticationRejected","AuthenticationError","PendingCustomerChallenge"]},"transactionStatus":{"$ref":"#/components/schemas/transactionStatusEnum"},"electronicCommerceIndicator":{"$ref":"#/components/schemas/electronicCommerceIndicatorProperty"},"exemptionGranted":{"description":"Whether an exemption from Strong Customer Authentication (SCA) was granted.","type":"boolean"},"exemptionGrantedByIssuer":{"$ref":"#/components/schemas/exemptionGrantedByIssuerProperty"},"acsUrl":{"description":"The URL of the Access Control Server (ACS) where the cardholder is redirected for challenge authentication.","type":"string","nullable":true,"example":"https://acs.example.com/challenge"},"challengeData":{"description":"Data required for the challenge authentication process, typically a base64 encoded string.","type":"string","nullable":true,"example":"eyJjaGFsbGVuZ2VEYXRhIjoiQUJDIn0="},"stateData":{"$ref":"#/components/schemas/stateDataResponse"},"cardholderInfo":{"type":"string","nullable":true,"description":"The text provided by the ACS/issuer to the cardholder during a transaction."}}}},"components/schemas/preinitiationCardData":{"id":"components/schemas/preinitiationCardData","kind":"json-schema","title":"preinitiationCardData","data":{"type":"object","description":"Details related to the card used for 3D Secure authentication. You can provide card details directly, use a stored gateway token, or use a scheme token.","oneOf":[{"title":"Card","description":"Use full card details for authentication. This option requires the primary account number, expiry date, cardholder name, and optionally, the card verification code (CVC).","required":["primaryAccountNumber","expiryMonth","expiryYear"],"properties":{"primaryAccountNumber":{"description":"The unique number assigned to a payment card, such as a credit or debit card.","example":"4111111111111111","maxLength":19,"minLength":13,"type":"string"},"cardHolderName":{"description":"The full name of the individual who owns the payment card, printed on the physical card.","maxLength":45,"minLength":2,"type":"string"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month [MM] of the card."},"children":[]}]}]}],"example":3,"minimum":1,"maximum":12,"type":"integer","format":"int32"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year [YYYY] of the card."},"children":[]}]}]}],"example":2025,"minimum":2000,"maximum":9999,"type":"integer","format":"int32"},"cardVerificationCode":{"description":"A 3 or 4 digit security code found on the card, used for verification in non-face-to-face transactions.","example":"123","type":"string","minLength":3,"maxLength":4}}},{"title":"Gateway token","description":"Use a previously saved payment card stored as a secure token by the PXP Unity gateway. This method eliminates the need to re-enter card details.","required":["gatewayTokenId"],"properties":{"gatewayTokenId":{"description":"A securely stored token representing a previously saved card.","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"}}},{"title":"Scheme token","description":"Use a scheme-generated token instead of the full card number. This option is useful for enhanced security and compliance with tokenisation standards.","required":["schemeTokenId"],"properties":{"schemeTokenId":{"type":"string","description":"A unique scheme token ID generated by PXP, used as a reference to extract the schemeTokenNumber.","example":"4837261112345678"}}},{"title":"Scheme token (external)","description":"Use an external scheme token issued by Visa or Mastercard. This method allows secure authentication without exposing full card details.","required":["schemeTokenNumber","expiryMonth","expiryYear"],"properties":{"schemeTokenNumber":{"type":"string","description":"An external scheme token issued by Visa or Mastercard.","example":"4837261112345678","maxLength":19,"minLength":13},"holderName":{"description":"The full name of the cardholder associated with the scheme token.","example":"Mr John Doe","maxLength":45,"minLength":2,"type":"string"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month [MM] of the scheme token."},"children":[]}]}]}],"example":3,"minimum":1,"maximum":12,"type":"integer","format":"int32"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year [YYYY] of the scheme token."},"children":[]}]}]}],"example":2025,"minimum":2000,"maximum":9999,"type":"integer","format":"int32"},"verificationCode":{"description":"A 3 or 4 digit security code for the scheme token.","example":"123","type":"string","minLength":3,"maxLength":4}}}]}},"components/schemas/recurringData":{"id":"components/schemas/recurringData","kind":"json-schema","title":"recurringData","data":{"description":"Details related to recurring transactions for 3D Secure authentication.","type":"object","properties":{"expirationDate":{"description":"The expiration date of the recurring transaction plan.","type":"string","example":"2024-12-31T23:59:59Z","format":"date-time","nullable":true},"frequencyInDays":{"description":"The frequency of the recurring transactions in days.","type":"integer","format":"int32","nullable":true,"example":30}},"additionalProperties":false}},"components/schemas/standaloneAuthenticationPreinitiationRequest":{"id":"components/schemas/standaloneAuthenticationPreinitiationRequest","kind":"json-schema","title":"standaloneAuthenticationPreinitiationRequest","data":{"description":"Request schema for pre-initiating a stand-alone authentication.","required":["acquirerProfileId","card","fingerprintCallbackUrl","merchantGroup"],"type":"object","properties":{"amount":{"$ref":"#/components/schemas/authenticationAmounts"},"fingerprintCallbackUrl":{"description":"The fingerprint callback URL.","minLength":1,"type":"string"},"acquirerProfileId":{"description":"The unique identifier for the acquirer's profile.","maxLength":20,"minLength":0,"type":"string"},"requestorAuthenticationIndicator":{"maxLength":2,"minLength":0,"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator used to specify the type of authentication request, such as payment authentication or account verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial Recurring Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial Card-on-file transaction for subsequent MITs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial Card-on-file transaction for subsequent CITs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Store card details without purchase (card verification)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Instalment transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Billing agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Split shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delayed shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Split payment"},"children":[]}]}]}]}],"example":"01"},"merchantGroup":{"description":"The merchant group.","maxLength":10,"minLength":0,"type":"string"},"card":{"$ref":"#/components/schemas/preinitiationCardData"}},"additionalProperties":false}},"components/schemas/standaloneAuthenticationPreinitiationResponse":{"id":"components/schemas/standaloneAuthenticationPreinitiationResponse","kind":"json-schema","title":"standaloneAuthenticationPreinitiationResponse","data":{"description":"Response schema for pre-initiating a stand-alone authentication.","type":"object","properties":{"authenticationId":{"description":"A unique reference provided by PXP for the authentication request, represented as a GUID.","type":"string","example":"550e8400-e29b-41d4-a716-446655440000","nullable":true},"state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the authentication request. For pre-initiation, this can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClientData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or null (if the card isn't enrolled for 3DS)."},"children":[]}]}]}],"enum":["PendingClientData"]},"scaMandated":{"description":"Whether Strong Customer Authentication (SCA) is mandated for this transaction.","type":"boolean","example":true},"threeDSecureVersion":{"description":"The version of the 3D Secure protocol being used for the authentication.","type":"string","nullable":true,"example":"2.1.0"},"threeDSecureFingerprintUrl":{"description":"The URL to which the 3D Secure method data should be sent.","type":"string","nullable":true,"example":"https://example.com/3ds-method"},"threeDSecureFingerprintData":{"description":"Data required for the 3D Secure method, typically a base64 encoded string.","type":"string","nullable":true,"example":"eyJ0aHJlZURTU2VjdXJlTWV0aG9kRGF0YSI6IlhYWiJ9"},"threeDSecureSupported":{"description":"Whether 3D Secure authentication is supported for this transaction.","type":"boolean","example":true},"recommendedChallengeIndicator":{"description":"The recommended challenge indicator.","type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/standaloneBrowserAuthenticationRequest":{"id":"components/schemas/standaloneBrowserAuthenticationRequest","kind":"json-schema","title":"standaloneBrowserAuthenticationRequest","data":{"description":"Request schema for browser-based stand-alone authentication for 3D Secure.","required":["acquirerMerchantId","browserData","challengeCallbackUrl","challengeWindowSize","merchantCountryNumericCode","merchantLegalName","requestorChallengeIndicator","shopper"],"type":"object","properties":{"fingerprintNotification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL for notifying the fingerprinting result. Base64 of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"threeDSMethodNotificationURL\":\"method url value\",\"threeDSServerTransID\":\"transaction id value\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":true},"merchantCategoryCode":{"description":"The four-digit Merchant Category Code (MCC) assigned to the merchant.","maxLength":4,"minLength":4,"type":"string","nullable":true,"example":"5411"},"merchantCountryNumericCode":{"description":"The three-digit country code of the merchant, following ISO 3166-1 numeric standard.","maxLength":3,"minLength":3,"type":"string","example":"840"},"merchantLegalName":{"description":"The legal name of the merchant.","maxLength":40,"minLength":0,"type":"string","example":"ACME Ltd"},"acquirerMerchantId":{"description":"The acquirer merchant ID.","maxLength":35,"minLength":0,"type":"string"},"challengeWindowSize":{"$ref":"#/components/schemas/challengeWindowSizeProperty"},"requestorChallengeIndicator":{"$ref":"#/components/schemas/requestorChallengeIndicatorProperty"},"challengeCallbackUrl":{"maxLength":256,"minLength":1,"type":"string","format":"uri","description":"The fully qualified URL of the system that receives the CRes message or error message. The CRes message is posted by the ACS through the Cardholder Browser at the end of the challenge and receipt of the RRes message."},"recurring":{"$ref":"#/components/schemas/recurringData"},"billingAddress":{"$ref":"#/components/schemas/browserAuthenticationAddressRequest"},"shippingAddress":{"$ref":"#/components/schemas/browserAuthenticationAddressRequest"},"browserData":{"$ref":"#/components/schemas/browserAuthenticationBrowserInformationRequest"},"shopper":{"$ref":"#/components/schemas/browserAuthenticationCardholderInformationRequest"}},"additionalProperties":false}},"components/schemas/standaloneBrowserAuthenticationResponse":{"id":"components/schemas/standaloneBrowserAuthenticationResponse","kind":"json-schema","title":"standaloneBrowserAuthenticationResponse","data":{"description":"Response schema for browser-based stand-alone authentication.","type":"object","properties":{"state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the authentication request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PendingClientData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't returned during initiation."},"children":[]}]}]}],"enum":["AuthenticationSuccessful","AuthenticationFailed","AuthenticationRejected","AuthenticationError","PendingCustomerChallenge"]},"directoryServerTransactionId":{"description":"The Directory Server transaction ID.","type":"string","nullable":true,"example":"98ec7e22-04f6-47e9-ab45-5c5d20441935"},"transactionStatus":{"$ref":"#/components/schemas/transactionStatusEnum"},"electronicCommerceIndicator":{"$ref":"#/components/schemas/electronicCommerceIndicatorProperty"},"cardholderAuthenticationVerificationValue":{"description":"A value generated during the authentication process to verify the cardholder's identity.","type":"string","nullable":true,"example":"CAVV1234567890"},"exemptionGranted":{"description":"Whether an exemption from Strong Customer Authentication (SCA) was granted.","type":"boolean","example":true},"exemptionGrantedByIssuer":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the exemption was granted by the issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TransactionRiskAnalysisExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TrustListExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": LowValueExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": SecureCorporatePaymentsExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"79"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoExemptionApplied"},"children":[]}]}]}]}],"example":{"TransactionRiskAnalysisExemption":{"value":5}}},"acsUrl":{"description":"The URL of the Access Control Server (ACS) where the cardholder is redirected for challenge authentication.","type":"string","nullable":true,"example":"https://acs.example.com/challenge"},"challengeData":{"description":"Data required for the challenge authentication process, typically a base64 encoded string.","type":"string","nullable":true,"example":"eyJjaGFsbGVuZ2VEYXRhIjoiQUJDIn0="},"stateData":{"$ref":"#/components/schemas/stateDataResponse"},"cardholderInfo":{"type":"string","nullable":true,"description":"The text provided by the ACS/issuer to the cardholder during a transaction."}},"additionalProperties":false}},"components/schemas/stateDataResponse":{"id":"components/schemas/stateDataResponse","kind":"json-schema","title":"stateDataResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the state. This is returned only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"code":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"17"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"18"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"21"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"22"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"23"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"26"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"27"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"28"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"29"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]}]}]}]}],"enum":["01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30"],"example":"01"},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card authentication failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown device"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsupported device"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exceeds authentication frequency limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid card number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No card record"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stolen card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspected fraud"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not permitted to Cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder not enrolled in service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction timed out at the ACS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Low confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medium confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Very high confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exceeds ACS maximum challenges"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-Payment transaction not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3RI transaction not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACS technical issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decoupled Authentication required by ACS but not requested by 3DS Requestor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS Requestor Decoupled Max Expiry Time exceeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decoupled Authentication was provided insufficient time to authenticate Cardholder. ACS will not make attempt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication attempted but not performed by the Cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred Authentication Method not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation of content security policy failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication attempted but not completed by the Cardholder. Fall back to Decoupled Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication completed successfully but additional authentication of the Cardholder required. Reinitiate as Decoupled Authentication"},"children":[]}]}]}]}],"example":"Card authentication failure","nullable":true}},"additionalProperties":false}},"components/schemas/authenticationStateEnum":{"id":"components/schemas/authenticationStateEnum","kind":"json-schema","title":"authenticationStateEnum","data":{"type":"string","nullable":true,"description":"The current state of the authentication request.","enum":["PendingClientData","AuthenticationSuccessful","AuthenticationFailed","AuthenticationRejected","AuthenticationError","PendingCustomerChallenge"]}},"components/schemas/transactionStatusEnum":{"id":"components/schemas/transactionStatusEnum","kind":"json-schema","title":"transactionStatusEnum","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AuthenticationVerificationSuccessful"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NotAuthenticated_NotVerified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AuthenticationCouldNotBePerformed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AttemptsProcessingPerformed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AuthenticationRejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": InformationalOnly"},"children":[]}]}]}]}],"enum":["Y","N","U","A","C","R","I"]}},"components/schemas/electronicCommerceIndicatorProperty":{"id":"components/schemas/electronicCommerceIndicatorProperty","kind":"json-schema","title":"electronicCommerceIndicatorProperty","data":{"type":"string","nullable":true,"description":"The indicator used to signify the level of security used in the authentication, often used in electronic commerce transactions.","example":"05"}},"components/schemas/exemptionGrantedByIssuerProperty":{"id":"components/schemas/exemptionGrantedByIssuerProperty","kind":"json-schema","title":"exemptionGrantedByIssuerProperty","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the exemption was granted by the issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TransactionRiskAnalysisExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TrustListExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": LowValueExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": SecureCorporatePaymentsExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"79"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoExemptionApplied"},"children":[]}]}]}]}]}},"components/schemas/challengeWindowSizeProperty":{"id":"components/schemas/challengeWindowSizeProperty","kind":"json-schema","title":"challengeWindowSizeProperty","data":{"type":"integer","format":"int32","minimum":1,"maximum":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The desired size of the challenge window displayed to the cardholder during authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 250x400"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 390x400"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 500x600"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 600x400"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": FullScreen"},"children":[]}]}]}]}]}},"components/schemas/requestorChallengeIndicatorProperty":{"id":"components/schemas/requestorChallengeIndicatorProperty","kind":"json-schema","title":"requestorChallengeIndicatorProperty","data":{"type":"string","maxLength":2,"minLength":0,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator of whether a challenge is requested for this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoPreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequested3dsRequestorPreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedMandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedTRAPerformed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedDataShareOnly"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedStrongConsumerAuthentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedTrustListExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedTrustListPrompt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedLowValueExemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedSecureCorporatePayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedDeviceBindingPrompt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedIssuerRequested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedMerchantInitiatedTransactions"},"children":[]}]}]}]}]}},"components/schemas/integratedRequestorChallengeIndicatorProperty":{"id":"components/schemas/integratedRequestorChallengeIndicatorProperty","kind":"json-schema","title":"integratedRequestorChallengeIndicatorProperty","data":{"type":"string","maxLength":2,"minLength":0,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator of whether a challenge is requested for this transaction (Integrated authentication)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoPreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequested3dsRequestorPreference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ChallengeRequestedMandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedTRAPerformed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": NoChallengeRequestedLowValueExemption"},"children":[]}]}]}]}],"enum":["01","02","03","04","05","10"]}},"schema_137":{"kind":"json-schema","data":{"type":"string","description":"The authentication ID."},"id":"schema_137"}},"exampleStore":{"paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication":{"value":{"state":"AuthenticationSuccessful","directoryServerTransactionId":"98ec7e22-04f6-47e9-ab45-5c5d20441935","transactionStatus":"Y","electronicCommerceIndicator":"05","cardholderAuthenticationVerificationValue":"CAVV1234567890","exemptionGranted":false,"exemptionGrantedByIssuer":"79","cardholderInfo":"Additional authentication information"},"key":"Successful authentication","summary":"Successful authentication","id":"paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication"},"paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication":{"value":{"state":"AuthenticationFailed","directoryServerTransactionId":"98ec7e22-04f6-47e9-ab45-5c5d20441935","transactionStatus":"N","electronicCommerceIndicator":"07","exemptionGranted":false,"stateData":{"code":"01","reason":"Card authentication failed"},"cardholderInfo":"Authentication could not be completed"},"key":"Unsuccessful authentication","summary":"Unsuccessful authentication","id":"paths/~1threedsecure~1standalone~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"},"paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication":{"value":{"uniqueId":"550e8400-e29b-41d4-a716-446655440000","state":"AuthenticationSuccessful","transactionStatus":"Y","electronicCommerceIndicator":"05","exemptionGranted":false,"exemptionGrantedByIssuer":"79","cardholderInfo":"Additional authentication information"},"key":"Successful authentication","summary":"Successful authentication","id":"paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Successful authentication"},"paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication":{"value":{"uniqueId":"550e8400-e29b-41d4-a716-446655440000","state":"AuthenticationFailed","transactionStatus":"N","electronicCommerceIndicator":"07","exemptionGranted":false,"stateData":{"code":"01","reason":"Card authentication failed"},"cardholderInfo":"Authentication could not be completed"},"key":"Unsuccessful authentication","summary":"Unsuccessful authentication","id":"paths/~1threedsecure~1integrated~1authentications~1{authenticationId}~1browser-authentication/put/responses/200/content/application~1json/examples/Unsuccessful authentication"}},"securitySchemeStore":{},"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/three-d-secure-authentication","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/three-d-secure-authentication.json?download"},{"url":"/_bundle/apis/three-d-secure-authentication.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"3D Secure authentication service API","description":"This is an API reference for the 3D Secure authentication service."}},"baseSlug":"/apis/three-d-secure-authentication","routesMapping":{}}