{"items":[{"type":"link","label":"Session service API","link":"/apis/session","routeSlug":"/apis/session","content":{"contentType":"overview","meta":{"name":"Session service API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"session.json","url":"/_bundle/apis/session.json?download"},{"kind":"download","label":"session.yaml","url":"/_bundle/apis/session.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://www.pxp.io/termsconditions"}]},{"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":"Session service API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the Session service."}],"sectionId":"/apis/session"}],"sectionId":"/apis/session"}]}]}},{"label":"Create a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/session/other/create-session","routeSlug":"/apis/session/other/create-session","metadata":{"seo":{"title":"Create a session","description":"The Session service API enables the creation of transaction sessions, supporting various transaction methods such as card payments and alternative payment methods (APMs). It facilitates seamless integration for payment processing by generating a session that securely collects payment details and initiates transactions. This service ensures secure and efficient payment flows, improving the user experience across multiple payment channels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-session","name":"Create a session","isWebhook":false,"pointer":"/paths/~1sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Session service API enables the creation of transaction sessions, supporting various transaction methods such as card payments and alternative payment methods (APMs). It facilitates seamless integration for payment processing by generating a session that securely collects payment details and initiates transactions. This service ensures secure and efficient payment flows, improving the user experience across multiple payment channels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PXP-UST1","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-UST1 authentication with HMAC-SHA256 signature. Format: PXP-UST1 {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSessionRequest","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/examples/card","paths/~1sessions/post/requestBody/content/application~1json/examples/paypal","paths/~1sessions/post/requestBody/content/application~1json/examples/applePay","paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay","paths/~1sessions/post/requestBody/content/application~1json/examples/paze","paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay","paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile","paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"schemaId":"components/schemas/CreateSessionRequest","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/examples/card","paths/~1sessions/post/requestBody/content/application~1json/examples/paypal","paths/~1sessions/post/requestBody/content/application~1json/examples/applePay","paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay","paths/~1sessions/post/requestBody/content/application~1json/examples/paze","paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay","paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile","paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"],"pointer":"/paths/~1sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sessions","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":[{"schemes":[{"id":"PXP-UST1","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSessionRequest","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/examples/card","paths/~1sessions/post/requestBody/content/application~1json/examples/paypal","paths/~1sessions/post/requestBody/content/application~1json/examples/applePay","paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay","paths/~1sessions/post/requestBody/content/application~1json/examples/paze","paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay","paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile","paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/sessions","href":"other/create-session","openApiOperationId":"create-session","summary":"Create a session"},"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/CreateSessionRequest","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/examples/card","paths/~1sessions/post/requestBody/content/application~1json/examples/paypal","paths/~1sessions/post/requestBody/content/application~1json/examples/applePay","paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay","paths/~1sessions/post/requestBody/content/application~1json/examples/paze","paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay","paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile","paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSessionRequest","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/examples/card","paths/~1sessions/post/requestBody/content/application~1json/examples/paypal","paths/~1sessions/post/requestBody/content/application~1json/examples/applePay","paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay","paths/~1sessions/post/requestBody/content/application~1json/examples/paze","paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay","paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile","paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Session created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSessionResponse","exampleIds":["paths/~1sessions/post/responses/200/content/application~1json/examples/card","paths/~1sessions/post/responses/200/content/application~1json/examples/paypal","paths/~1sessions/post/responses/200/content/application~1json/examples/applePay","paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay","paths/~1sessions/post/responses/200/content/application~1json/examples/paze","paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay"]}},"schemaId":"components/schemas/CreateSessionResponse","exampleIds":["paths/~1sessions/post/responses/200/content/application~1json/examples/card","paths/~1sessions/post/responses/200/content/application~1json/examples/paypal","paths/~1sessions/post/responses/200/content/application~1json/examples/applePay","paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay","paths/~1sessions/post/responses/200/content/application~1json/examples/paze","paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay"]},{"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":"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/~1sessions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateSessionResponse","exampleIds":["paths/~1sessions/post/responses/200/content/application~1json/examples/card","paths/~1sessions/post/responses/200/content/application~1json/examples/paypal","paths/~1sessions/post/responses/200/content/application~1json/examples/applePay","paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay","paths/~1sessions/post/responses/200/content/application~1json/examples/paze","paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateSessionResponse","exampleIds":["paths/~1sessions/post/responses/200/content/application~1json/examples/card","paths/~1sessions/post/responses/200/content/application~1json/examples/paypal","paths/~1sessions/post/responses/200/content/application~1json/examples/applePay","paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay","paths/~1sessions/post/responses/200/content/application~1json/examples/paze","paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay"]}}},{"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":"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":"/other/create-session"}],"panels":[]}]},"httpPath":"/sessions"},{"label":"Modify a session","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/session/other/modify-session","routeSlug":"/apis/session/other/modify-session","metadata":{"seo":{"title":"Modify a session","description":"This endpoint allows updating session details after creation, including intent modification, amount updates, authentication decision, transaction decision, and 3DS external data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modify-session","name":"Modify a session","isWebhook":false,"pointer":"/paths/~1session-details~1{sessionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows updating session details after creation, including intent modification, amount updates, authentication decision, transaction decision, and 3DS external data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PXP-UST1","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-UST1 authentication with HMAC-SHA256 signature. Format: PXP-UST1 {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sessionId","in":"path","schemaId":"schema_133","description":"The unique identifier of the session to modify.","required":true}],"pointer":"/paths/~1session-details~1{sessionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ModifySessionRequest","exampleIds":["paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"schemaId":"components/schemas/ModifySessionRequest","exampleIds":["paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"],"pointer":"/paths/~1session-details~1{sessionId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/session-details/{sessionId}","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":"sessionId","in":"path","required":true,"schemaId":"schema_133"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PXP-UST1","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ModifySessionRequest","exampleIds":["paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"responseCodes":["204","400","401","403","404","500"],"pointer":"/session-details/{sessionId}","href":"other/modify-session","openApiOperationId":"modify-session","summary":"Modify a session"},"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/ModifySessionRequest","exampleIds":["paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ModifySessionRequest","exampleIds":["paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay","paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Session modified successfully"},{"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":"Session not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound","paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound","paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed"]},{"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/~1session-details~1{sessionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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","exampleIds":["paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound","paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound","paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/modify-session"}],"panels":[]}]},"httpPath":"/session-details/{sessionId}"}],"store":{"schemaStore":{"components/schemas/CreateSessionRequest":{"id":"components/schemas/CreateSessionRequest","kind":"json-schema","title":"CreateSessionRequest","data":{"type":"object","required":["merchant","site","amounts","merchantTransactionId","transactionMethod"],"properties":{"merchant":{"type":"string","description":"Your unique merchant identifier, as assigned by PXP.","example":"MERCHANT-1","maxLength":20},"site":{"type":"string","description":"Your unique site identifier, as assigned by PXP.","example":"SITE-1","maxLength":20},"merchantTransactionId":{"type":"string","description":"A unique identifier for this transaction.","example":"TRANSACTION-1","maxLength":50},"sessionTimeout":{"type":"integer","description":"The duration of the session, in minutes.","example":120,"minimum":1},"amounts":{"type":"object","description":"Details about the transaction amount.","required":["currencyCode","transactionValue"],"properties":{"currencyCode":{"type":"string","description":"The currency code associated with the transaction, in ISO 4217 format.","example":"EUR","minLength":3,"maxLength":3},"transactionValue":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction amount. 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 (e.g., 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":" of the exponent does not require it (e.g., JPY 1.0)."},"children":[]}]}]}],"example":30.32,"minimum":0}}},"transactionMethod":{"type":"object","required":["intent"],"description":"Details about the transaction method.","properties":{"intent":{"type":"object","description":"Details about the intent for different payment methods.","properties":{"card":{"type":"string","description":"The intent for card, Apple Pay, Google Pay, and Paze transactions.","enum":["Authorisation","Purchase","Verification","EstimatedAuthorisation","Payout"],"example":"EstimatedAuthorisation"},"paypal":{"type":"string","description":"The intent for PayPal transactions.","enum":["Authorisation","Purchase","Payout"],"example":"Authorisation"},"aeropay":{"type":"string","description":"The intent for Aeropay transactions.","enum":["Authorisation","Purchase","EstimatedAuthorisation","Payout"],"example":"EstimatedAuthorisation"}}}}},"allowTransaction":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the transaction is allowed to proceed. If not provided, defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no decision made yet)."},"children":[]}]}]}],"example":true},"addressVerification":{"description":"Details about the cardholder's address. These help in the validation and fraud prevention process by matching the provided address with the cardholder's address on file.","type":"object","properties":{"countryCode":{"description":"The country associated with the cardholder's address, in ISO 3166-1 alpha-2 format.","example":"GB","type":"string","maxLength":2},"houseNumberOrName":{"description":"The house number or name associated with the cardholder's address.","example":"10 Downing Street","type":"string","maxLength":100},"postalCode":{"description":"The postal code of the cardholder's address.","example":"SW1A 2AA","type":"string","maxLength":10}},"required":["countryCode","houseNumberOrName","postalCode"]},"identityVerification":{"description":"Details about the cardholder's identity. These help in ensuring that the information provided matches the cardholder's details on file.","type":"object","properties":{"nameVerification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the cardholder's name matches the name associated with the registered address on file. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.intent.card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; other card intents reject this combination."},"children":[]}]}]}],"example":true,"type":"boolean"}}},"threeDSecureData":{"type":"object","description":"Details about the 3D Secure authentication data from an external authentication process.","properties":{"threeDSecureVersion":{"type":"string","description":"The 3DS protocol version.","example":"2.2","maxLength":10,"nullable":true},"electronicCommerceIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Electronic Commerce Indicator (ECI) from an external authentication process, indicating the level of security applied to 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:"},"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":": 3D Secure not available (non-3DS 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":": 3D Secure available but not used (authentication was attempted but was not possible)."},"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":": 3D Secure authentication successful (fully authenticated)."},"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":": 3D Secure authentication attempted (for example, issuer or cardholder not enrolled)."},"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":": 3D Secure authentication failed but the transaction is still allowed."},"children":[]}]}]}]}],"enum":["01","02","05","06","07"],"example":"05","maxLength":2,"nullable":true},"cardHolderAuthenticationVerificationValue":{"type":"string","description":"The Cardholder Authentication Verification Value (CAVV) from 3DS authentication.","example":"CAVV1234567890","maxLength":50,"nullable":true},"directoryServerTransactionId":{"type":"string","description":"The Directory Server transaction identifier.","example":"550e8400-e29b-41d4-a716-446655440000","maxLength":50,"nullable":true},"threeDSecureTransactionStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The EMV 3D Secure transaction status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from an external authentication process."},"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":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification successful."},"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":": Not authenticated / account not verified; transaction denied."},"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":": Authentication / account verification could not be performed (for example, a technical problem)."},"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":": Attempts processing performed; not authenticated or verified, but proof of attempted authentication or verification is provided."},"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":": Challenge required; additional authentication is required using the CReq/CRes messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge required; decoupled authentication confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification rejected; the issuer is rejecting authentication or verification and requests that authorisation not be attempted."},"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":": Informational only; the 3DS Requestor challenge preference is acknowledged."},"children":[]}]}]}]}],"enum":["Y","N","U","A","C","D","R","I"],"example":"Y","maxLength":1,"nullable":true}}},"customerProfileId":{"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":"Optional Unity Customer Profile identifier for Checkout Drop-in sessions. Links the session to a returning shopper profile and can filter which Drop-in payment methods are offered. Omit for guest or anonymous checkout. Include when the shopper is known and you want the session scoped to their Customer Profile. Profile lookup and payment-method enrichment apply when the session is created for Checkout Drop-in ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckoutDropIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This field is request-only and isn't returned in the response."},"children":[]}]}]}],"example":"your-customer-profile-id","maxLength":255}}}},"components/schemas/CreateSessionResponse":{"id":"components/schemas/CreateSessionResponse","kind":"json-schema","title":"CreateSessionResponse","data":{"type":"object","required":["sessionId","hmacKey","encryptionKey","sessionExpiry"],"properties":{"sessionId":{"type":"string","format":"uuid","description":"The unique identifier for the created session.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"hmacKey":{"type":"string","description":"The HMAC key generated for securing session communications.","example":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"},"encryptionKey":{"type":"string","description":"A key used for encrypting sensitive session data during communication.","example":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z"},"sessionExpiry":{"type":"string","format":"date-time","description":"The timestamp indicating when the session will expire, in ISO 8601 format.","example":"2025-05-19T13:39:20.3843454Z"},"allowedFundingTypes":{"type":"object","description":"Details about the funding types allowed for this session.","properties":{"cardSchemes":{"description":"The card schemes allowed for this session.","type":"array","items":{"type":"string","enum":["Diners","Mastercard","American Express","Visa"]},"example":["Diners","Mastercard","American Express","Visa"]},"cards":{"description":"The cards allowed for this session.","type":"array","items":{"type":"string"},"example":[]},"wallets":{"$ref":"#/components/schemas/CreateSessionWallets"},"payByBanks":{"$ref":"#/components/schemas/CreateSessionPayByBanks"}}},"restrictions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the card restrictions configured at the merchant or site level. These restrictions define which card types are blocked based on owner type and funding source. Transactions using restricted cards will be declined with error code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRD184"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (card restricted)."},"children":[]}]}]}],"properties":{"card":{"type":"object","description":"Details about the card-specific restrictions for this session.","properties":{"ownerTypes":{"type":"array","description":"The list of blocked card owner types. When configured, cards with these owner types will be declined.","items":{"type":"string","enum":["Corporate","Consumer"]},"example":["Corporate"]},"fundingSources":{"type":"array","description":"The list of blocked funding sources. When configured, cards with these funding sources will be declined. All funding sources apply to all owner types when configured.","items":{"type":"string","enum":["Prepaid","Credit","Debit"]},"example":["Prepaid"]}}}}}}}},"components/schemas/CreateSessionWallets":{"id":"components/schemas/CreateSessionWallets","kind":"json-schema","title":"CreateSessionWallets","data":{"type":"object","description":"Details about the wallets allowed for this session.","properties":{"paypal":{"$ref":"#/components/schemas/CreateSessionPaypalSettings"},"applePay":{"$ref":"#/components/schemas/CreateSessionApplePaySettings"},"googlePay":{"$ref":"#/components/schemas/CreateSessionGooglePaySettings"},"paze":{"$ref":"#/components/schemas/CreateSessionPazeSettings"}}}},"components/schemas/CreateSessionPaypalSettings":{"id":"components/schemas/CreateSessionPaypalSettings","kind":"json-schema","title":"CreateSessionPaypalSettings","data":{"type":"object","description":"The PayPal configuration settings.","properties":{"allowedFundingOptions":{"type":"array","items":{"type":"string"},"description":"The list of allowed funding options for PayPal."},"merchantId":{"type":"string","nullable":true,"description":"The PayPal merchant identifier."}}}},"components/schemas/CreateSessionApplePaySettings":{"id":"components/schemas/CreateSessionApplePaySettings","kind":"json-schema","title":"CreateSessionApplePaySettings","data":{"type":"object","description":"The Apple Pay configuration settings.","properties":{"merchantId":{"type":"string","description":"The Apple Pay merchant identifier."}},"required":["merchantId"]}},"components/schemas/CreateSessionGooglePaySettings":{"id":"components/schemas/CreateSessionGooglePaySettings","kind":"json-schema","title":"CreateSessionGooglePaySettings","data":{"type":"object","description":"The Google Pay configuration settings.","required":["merchantId","gatewayMerchantId","merchantName"],"properties":{"merchantId":{"type":"string","description":"The Google Pay merchant identifier.","example":"Unity"},"gatewayMerchantId":{"type":"string","description":"A unique merchant identifier assigned by PXP.","example":"Prime"},"merchantName":{"type":"string","description":"A unique merchant name assigned by PXP.","example":"Prime Team"}}}},"components/schemas/CreateSessionPazeSettings":{"id":"components/schemas/CreateSessionPazeSettings","kind":"json-schema","title":"CreateSessionPazeSettings","data":{"type":"object","description":"The Paze configuration settings. This is only returned when Paze is enabled for the site.","required":["clientId","profileId","merchantCategoryCode"],"properties":{"clientId":{"type":"string","description":"The Paze client identifier provided by the Paze service.","example":"example-client-id"},"profileId":{"type":"string","description":"The Paze profile identifier provided by the Paze service.","example":"example-profile-id"},"merchantCategoryCode":{"type":"string","description":"The merchant category code.","example":"5999"}}}},"components/schemas/CreateSessionPayByBanks":{"id":"components/schemas/CreateSessionPayByBanks","kind":"json-schema","title":"CreateSessionPayByBanks","data":{"type":"object","description":"Details about the pay by bank options allowed for this session.","properties":{"aeropay":{"$ref":"#/components/schemas/CreateSessionAeropaySettings"}}}},"components/schemas/CreateSessionAeropaySettings":{"id":"components/schemas/CreateSessionAeropaySettings","kind":"json-schema","title":"CreateSessionAeropaySettings","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the Aeropay configuration settings. This object is only returned when Aeropay is enabled at the merchant group or merchant level, and activated at the site level in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkout Components service"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s payment method settings."},"children":[]}]}]}],"properties":{"externalMerchantId":{"type":"string","description":"The external merchant identifier used for Aeropay transactions.","example":"1711"},"configurationId":{"type":"string","description":"The configuration identifier used for branding and styling the Aeropay widget.","example":"19411"}}}},"components/schemas/ModifySessionRequest":{"id":"components/schemas/ModifySessionRequest","kind":"json-schema","title":"ModifySessionRequest","data":{"type":"object","description":"Request body for modifying an existing session. All properties are optional.","properties":{"transactionMethod":{"type":"object","description":"Details about the transaction method.","properties":{"intent":{"type":"object","description":"Details about the intent for different payment methods.","properties":{"card":{"type":"string","description":"The intent for card, Apple Pay, Google Pay, and Paze transactions.","enum":["Authorisation","Purchase","Verification","EstimatedAuthorisation","Payout"],"example":"EstimatedAuthorisation"},"paypal":{"type":"string","description":"The intent for PayPal transactions.","enum":["Authorisation","Purchase","Payout"],"example":"Authorisation"},"aeropay":{"type":"string","description":"The intent for Aeropay transactions.","enum":["Authorisation","Purchase","EstimatedAuthorisation","Payout"],"example":"EstimatedAuthorisation"}}}}},"amounts":{"type":"object","description":"Details about the transaction amount.","properties":{"currencyCode":{"type":"string","description":"The currency code associated with the transaction, in ISO 4217 format.","example":"EUR","minLength":3,"maxLength":3},"transactionValue":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction amount. 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 (e.g., 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":" of the exponent does not require it (e.g., JPY 1.0)."},"children":[]}]}]}],"example":20,"minimum":0}}},"addressVerification":{"description":"Details about the cardholder's address. These help in the validation and fraud prevention process by matching the provided address with the cardholder's address on file.","type":"object","properties":{"countryCode":{"description":"The country associated with the cardholder's address, in ISO 3166-1 alpha-2 format.","example":"GB","type":"string","maxLength":2},"houseNumberOrName":{"description":"The house number or name associated with the cardholder's address.","example":"10 Downing Street","type":"string","maxLength":100},"postalCode":{"description":"The postal code of the cardholder's address.","example":"SW1A 2AA","type":"string","maxLength":10}}},"identityVerification":{"description":"Details about the cardholder's identity. These help in ensuring that the information provided matches the cardholder's details on file.","type":"object","properties":{"nameVerification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the cardholder's name matches the name associated with the registered address on file. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.intent.card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; other card intents reject this combination."},"children":[]}]}]}],"example":true,"type":"boolean"}}},"authentication":{"type":"boolean","description":"Whether or not to proceed with authentication.","example":true},"allowTransaction":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the transaction is allowed to proceed. If not provided, defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no decision made yet)."},"children":[]}]}]}],"example":true},"threeDSecureData":{"type":"object","description":"Details about the 3D Secure authentication data from an external authentication process.","properties":{"threeDSecureVersion":{"type":"string","description":"The 3DS protocol version.","example":"2.2","maxLength":10,"nullable":true},"electronicCommerceIndicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Electronic Commerce Indicator (ECI) from an external authentication process, indicating the level of security applied to 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:"},"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":": 3D Secure not available (non-3DS 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":": 3D Secure available but not used (authentication was attempted but was not possible)."},"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":": 3D Secure authentication successful (fully authenticated)."},"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":": 3D Secure authentication attempted (for example, issuer or cardholder not enrolled)."},"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":": 3D Secure authentication failed but the transaction is still allowed."},"children":[]}]}]}]}],"enum":["01","02","05","06","07"],"example":"05","maxLength":2,"nullable":true},"cardHolderAuthenticationVerificationValue":{"type":"string","description":"The Cardholder Authentication Verification Value (CAVV) from 3DS authentication.","example":"CAVV1234567890","maxLength":50,"nullable":true},"directoryServerTransactionId":{"type":"string","description":"The Directory Server transaction identifier.","example":"550e8400-e29b-41d4-a716-446655440000","maxLength":50,"nullable":true},"threeDSecureTransactionStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The EMV 3D Secure transaction status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from an external authentication process."},"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":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification successful."},"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":": Not authenticated / account not verified; transaction denied."},"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":": Authentication / account verification could not be performed (for example, a technical problem)."},"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":": Attempts processing performed; not authenticated or verified, but proof of attempted authentication or verification is provided."},"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":": Challenge required; additional authentication is required using the CReq/CRes messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge required; decoupled authentication confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification rejected; the issuer is rejecting authentication or verification and requests that authorisation not be attempted."},"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":": Informational only; the 3DS Requestor challenge preference is acknowledged."},"children":[]}]}]}]}],"enum":["Y","N","U","A","C","D","R","I"],"example":"Y","maxLength":1,"nullable":true}}}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":"Standard error response format.","properties":{"errorCode":{"type":"string","description":"The error code identifying the type of error.","nullable":true},"errorReason":{"type":"string","description":"The human-readable error message.","nullable":true},"correlationId":{"type":"string","description":"The unique identifier for tracking this request.","nullable":true},"details":{"type":"array","description":"Additional error details.","items":{"type":"string"},"nullable":true}}}},"schema_133":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_133"}},"exampleStore":{"paths/~1sessions/post/requestBody/content/application~1json/examples/card":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"amounts":{"currencyCode":"EUR","transactionValue":30.32}},"key":"card","summary":"Card","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/card"},"paths/~1sessions/post/requestBody/content/application~1json/examples/paypal":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"paypal":"Authorisation"}},"amounts":{"currencyCode":"EUR","transactionValue":30.32}},"key":"paypal","summary":"PayPal","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/paypal"},"paths/~1sessions/post/requestBody/content/application~1json/examples/applePay":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"amounts":{"currencyCode":"EUR","transactionValue":30.32}},"key":"applePay","summary":"Apple Pay","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/applePay"},"paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"amounts":{"currencyCode":"EUR","transactionValue":30.32}},"key":"googlePay","summary":"Google Pay","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/googlePay"},"paths/~1sessions/post/requestBody/content/application~1json/examples/paze":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"amounts":{"currencyCode":"USD","transactionValue":30.32}},"key":"paze","summary":"Paze","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/paze"},"paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"aeropay":"EstimatedAuthorisation"}},"amounts":{"currencyCode":"USD","transactionValue":30.32}},"key":"aeropay","summary":"Aeropay (Pay by bank)","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/aeropay"},"paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"Authorisation","paypal":"Authorisation"}},"amounts":{"currencyCode":"USD","transactionValue":30.32},"allowTransaction":true,"customerProfileId":"your-customer-profile-id"},"key":"customerProfile","summary":"Session with Customer Profile","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/customerProfile"},"paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TRANSACTION-1","sessionTimeout":120,"transactionMethod":{"intent":{"card":"Verification"}},"amounts":{"currencyCode":"EUR","transactionValue":30.32},"addressVerification":{"countryCode":"GB","houseNumberOrName":"10 Downing Street","postalCode":"SW1A 2AA"},"identityVerification":{"nameVerification":true}},"key":"cardWithAVSAndIdentityVerification","summary":"Card with AVS and IDV data","id":"paths/~1sessions/post/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"},"paths/~1sessions/post/responses/200/content/application~1json/examples/card":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"cardSchemes":["Diners","Mastercard","American Express","Visa"],"cards":[]},"restrictions":{"card":{"ownerTypes":["Corporate"],"fundingSources":["Prepaid"]}}},"key":"card","summary":"Card","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/card"},"paths/~1sessions/post/responses/200/content/application~1json/examples/paypal":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"wallets":{"paypal":{"allowedFundingOptions":["paypal"],"merchantId":"PayPalMerchant123"}}}},"key":"paypal","summary":"PayPal","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/paypal"},"paths/~1sessions/post/responses/200/content/application~1json/examples/applePay":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"cardSchemes":["Diners","Mastercard","American Express","Visa"],"cards":[],"wallets":{"applePay":{"merchantId":"merchant.com.example"}}}},"key":"applePay","summary":"Apple Pay","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/applePay"},"paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"cardSchemes":["Diners","Mastercard","American Express","Visa"],"cards":[],"wallets":{"googlePay":{"merchantId":"Unity","gatewayMerchantId":"Prime","merchantName":"Prime Team"}}}},"key":"googlePay","summary":"Google Pay","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/googlePay"},"paths/~1sessions/post/responses/200/content/application~1json/examples/paze":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"cardSchemes":["Diners","Mastercard","American Express","Visa"],"cards":[],"wallets":{"paze":{"clientId":"example-client-id","profileId":"example-profile-id","merchantCategoryCode":"5999"}}}},"key":"paze","summary":"Paze","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/paze"},"paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay":{"value":{"sessionId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","hmacKey":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","encryptionKey":"k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z","sessionExpiry":"2025-05-19T13:39:20.3843454Z","allowedFundingTypes":{"payByBanks":{"aeropay":{"externalMerchantId":"1711","configurationId":"19411"}}}},"key":"aeropay","summary":"Aeropay (Pay by bank)","id":"paths/~1sessions/post/responses/200/content/application~1json/examples/aeropay"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card":{"value":{"amounts":{"currencyCode":"EUR","transactionValue":20},"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"authentication":true,"allowTransaction":true,"threeDSecureData":{"threeDSecureVersion":"2.2","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"CAVV1234567890","directoryServerTransactionId":"550e8400-e29b-41d4-a716-446655440000","threeDSecureTransactionStatus":"Y"}},"key":"card","summary":"Card","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/card"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal":{"value":{"amounts":{"currencyCode":"EUR","transactionValue":20},"transactionMethod":{"intent":{"paypal":"Authorisation"}},"allowTransaction":true},"key":"paypal","summary":"PayPal","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paypal"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay":{"value":{"amounts":{"currencyCode":"EUR","transactionValue":20},"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"authentication":true,"allowTransaction":true,"threeDSecureData":{"threeDSecureVersion":"2.2","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"CAVV1234567890","directoryServerTransactionId":"550e8400-e29b-41d4-a716-446655440000","threeDSecureTransactionStatus":"Y"}},"key":"applePay","summary":"Apple Pay","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/applePay"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay":{"value":{"amounts":{"currencyCode":"EUR","transactionValue":20},"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"authentication":true,"allowTransaction":true,"threeDSecureData":{"threeDSecureVersion":"2.2","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"CAVV1234567890","directoryServerTransactionId":"550e8400-e29b-41d4-a716-446655440000","threeDSecureTransactionStatus":"Y"}},"key":"googlePay","summary":"Google Pay","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/googlePay"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze":{"value":{"amounts":{"currencyCode":"USD","transactionValue":20},"transactionMethod":{"intent":{"card":"EstimatedAuthorisation"}},"authentication":true,"allowTransaction":true,"threeDSecureData":{"threeDSecureVersion":"2.2","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"CAVV1234567890","directoryServerTransactionId":"550e8400-e29b-41d4-a716-446655440000","threeDSecureTransactionStatus":"Y"}},"key":"paze","summary":"Paze","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/paze"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay":{"value":{"amounts":{"currencyCode":"USD","transactionValue":20},"transactionMethod":{"intent":{"aeropay":"EstimatedAuthorisation"}},"allowTransaction":true},"key":"aeropay","summary":"Aeropay (Pay by bank)","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/aeropay"},"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification":{"value":{"amounts":{"currencyCode":"EUR","transactionValue":20},"transactionMethod":{"intent":{"card":"Verification"}},"addressVerification":{"countryCode":"GB","houseNumberOrName":"10 Downing Street","postalCode":"SW1A 2AA"},"identityVerification":{"nameVerification":true},"authentication":true,"allowTransaction":true,"threeDSecureData":{"threeDSecureVersion":"2.2","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"CAVV1234567890","directoryServerTransactionId":"550e8400-e29b-41d4-a716-446655440000","threeDSecureTransactionStatus":"Y"}},"key":"cardWithAVSAndIdentityVerification","summary":"Card with AVS and IDV data","id":"paths/~1session-details~1{sessionId}/patch/requestBody/content/application~1json/examples/cardWithAVSAndIdentityVerification"},"paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound":{"value":{"errorCode":"SES4001","errorReason":"Session not found.","correlationId":"398a1c0e-329d-4f7b-bbeb-56c201387e40","details":[]},"key":"sessionNotFound","summary":"Session not found","id":"paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/sessionNotFound"},"paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed":{"value":{"errorCode":"SES4006","errorReason":"Session modification is not allowed, transaction has been authorised.","correlationId":"24969442-62ab-4415-bc8e-d016ab7db109","details":[]},"key":"modificationNotAllowed","summary":"Modification not allowed","id":"paths/~1session-details~1{sessionId}/patch/responses/404/content/application~1json/examples/modificationNotAllowed"}},"securitySchemeStore":{"PXP-UST1":{"id":"PXP-UST1","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-UST1 authentication with HMAC-SHA256 signature. Format: PXP-UST1 {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"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/session","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/session.json?download"},{"url":"/_bundle/apis/session.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Session service API","description":"This is an API reference for the Session service."}},"baseSlug":"/apis/session","routesMapping":{}}