{"items":[{"type":"link","label":"Cloud device transactions","link":"/apis/cloud-device-transaction","routeSlug":"/apis/cloud-device-transaction","content":{"contentType":"overview","meta":{"name":"Cloud device transactions"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"cloud-device-transaction.json","url":"/_bundle/apis/cloud-device-transaction.json?download"},{"kind":"download","label":"cloud-device-transaction.yaml","url":"/_bundle/apis/cloud-device-transaction.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":"Cloud device transactions (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API reference for cloud device transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For authentication, request shapes, constraints, and worked examples, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/point-of-sale/pos-plus/cloud"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cloud invocation guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"label":"Initiate a cloud device transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cloud-device-transaction/other/initiate-cloud-device-transaction","routeSlug":"/apis/cloud-device-transaction/other/initiate-cloud-device-transaction","metadata":{"seo":{"title":"Initiate a cloud device transaction","description":"Initiate a new cloud device transaction for the specified point-of-sale device. This endpoint supports various transaction intents including authorisation, purchase, refund, and verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-cloud-device-transaction","name":"Initiate a cloud device transaction","isWebhook":false,"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a cloud device transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate a new cloud device transaction for the specified point-of-sale device. This endpoint supports various transaction intents including authorisation, purchase, refund, and verification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PXP-POS","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-POS authentication with HMAC-SHA256 signature. Format: PXP-POS {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchantPointOfSaleId","in":"path","schemaId":"schema_0","description":"The unique merchant point-of-sale device identifier.","required":true}],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"]}},"schemaId":"schema_1","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody","description":"Initiate a cloud device transaction"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cloud-device/{merchantPointOfSaleId}/transactions","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":"merchantPointOfSaleId","in":"path","required":true,"example":"POS-001","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PXP-POS","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"]}},"responseCodes":["200","400","401","403","404","422","500","default"],"pointer":"/cloud-device/{merchantPointOfSaleId}/transactions","href":"other/initiate-cloud-device-transaction","openApiOperationId":"initiate-cloud-device-transaction","summary":"Initiate a cloud device transaction"},"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":"schema_1","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error"]}},"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example"]},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example"]}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/initiate-cloud-device-transaction"}],"panels":[]}]},"httpPath":"/cloud-device/{merchantPointOfSaleId}/transactions"},{"label":"Create a cloud device modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/cloud-device-transaction/other/modify-cloud-device-transaction","routeSlug":"/apis/cloud-device-transaction/other/modify-cloud-device-transaction","metadata":{"seo":{"title":"Create a cloud device modification","description":"Process a modification on a previously-initiated cloud device transaction. Supported operations include captures, refunds, incremental authorisations, and voids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modify-cloud-device-transaction","name":"Create a cloud device modification","isWebhook":false,"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a cloud device modification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Process a modification on a previously-initiated cloud device transaction. Supported operations include captures, refunds, incremental authorisations, and voids."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PXP-POS","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-POS authentication with HMAC-SHA256 signature. Format: PXP-POS {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchantPointOfSaleId","in":"path","schemaId":"schema_0","description":"The unique merchant point-of-sale device identifier.","required":true},{"name":"systemTransactionId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the original transaction to be modified."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"]}},"schemaId":"schema_3","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody","description":"Modification request for a previously initiated cloud device transaction."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cloud-device/{merchantPointOfSaleId}/transactions/{systemTransactionId}/modifications","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":"merchantPointOfSaleId","in":"path","required":true,"example":"POS-001","schemaId":"schema_0"},{"name":"systemTransactionId","in":"path","required":true,"example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemaId":"components/schemas/systemTransactionId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PXP-POS","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"]}},"responseCodes":["200","400","401","403","404","422","500","default"],"pointer":"/cloud-device/{merchantPointOfSaleId}/transactions/{systemTransactionId}/modifications","href":"other/modify-cloud-device-transaction","openApiOperationId":"modify-cloud-device-transaction","summary":"Create a cloud device modification"},"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":"schema_3","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)"]}},"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example"]},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transactionResponse","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example"]}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/modify-cloud-device-transaction"}],"panels":[]}]},"httpPath":"/cloud-device/{merchantPointOfSaleId}/transactions/{systemTransactionId}/modifications"}],"store":{"schemaStore":{"components/schemas/addressVerificationServiceResult":{"id":"components/schemas/addressVerificationServiceResult","kind":"json-schema","title":"addressVerificationServiceResult","data":{"description":"AVS verification result.","type":"string"}},"components/schemas/amounts":{"id":"components/schemas/amounts","kind":"json-schema","title":"amounts","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 transaction amount, including the currency and optional gratuity, cashback, shipping, or service charge values. Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gratuity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be sent together."},"children":[]}]}]}],"type":"object","required":["currencyCode","transaction"],"properties":{"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"transaction":{"$ref":"#/components/schemas/transaction"},"gratuity":{"$ref":"#/components/schemas/gratuity"},"cashback":{"$ref":"#/components/schemas/cashback"},"shipping":{"$ref":"#/components/schemas/shipping"},"serviceCharge":{"$ref":"#/components/schemas/serviceCharge"}}}},"components/schemas/amountsResponse":{"id":"components/schemas/amountsResponse","kind":"json-schema","title":"amountsResponse","data":{"description":"Details about the transaction amounts, including the transaction value, currency, and optional gratuity.","type":"object","properties":{"transaction":{"$ref":"#/components/schemas/transaction"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"gratuity":{"$ref":"#/components/schemas/gratuity"}}}},"components/schemas/approvalCode":{"id":"components/schemas/approvalCode","kind":"json-schema","title":"approvalCode","data":{"description":"The authorisation approval code returned by the issuer or authorising entity.","example":"460070","type":"string"}},"components/schemas/cardScheme":{"id":"components/schemas/cardScheme","kind":"json-schema","title":"cardScheme","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment card's scheme, indicating the network through which the card transactions are processed (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MasterCard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Visa","type":"string"}},"components/schemas/cardVerificationCodeResult":{"id":"components/schemas/cardVerificationCodeResult","kind":"json-schema","title":"cardVerificationCodeResult","data":{"description":"The outcome of the Card Verification Code (CVC) check, indicating whether the supplied CVC matched the issuer's records, didn't match, or wasn't checked.","type":"string"}},"components/schemas/cardProviderResponse":{"id":"components/schemas/cardProviderResponse","kind":"json-schema","title":"cardProviderResponse","data":{"description":"The response from the payment provider containing details about the transaction processing outcome.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/providerResponseName"},"code":{"$ref":"#/components/schemas/providerResponseCode"},"message":{"$ref":"#/components/schemas/providerResponseMessage"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"issuerResponseCode":{"$ref":"#/components/schemas/issuerResponseCode"},"merchantAdvice":{"$ref":"#/components/schemas/merchantAdvice"},"settlementDate":{"$ref":"#/components/schemas/settlementDate"},"cardVerificationCodeResult":{"$ref":"#/components/schemas/cardVerificationCodeResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/addressVerificationServiceResult"}}}},"components/schemas/cardResponse":{"id":"components/schemas/cardResponse","kind":"json-schema","title":"cardResponse","data":{"description":"Details about the payment method used for the transaction, including masked card data, scheme, gateway token, verification results, EMV data, and the provider response.","properties":{"maskedPrimaryAccountNumber":{"description":"The card's Primary Account Number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"************1234"},"expiryMonth":{"description":"The expiry month of the card as a two-digit number.","type":"string","example":"12"},"expiryYear":{"description":"The expiry year of the card as a four-digit number.","type":"string","example":"2025"},"cardScheme":{"$ref":"#/components/schemas/cardScheme"},"gatewayTokenId":{"$ref":"#/components/schemas/gatewayTokenId"},"cardVerificationCodeResult":{"$ref":"#/components/schemas/cardVerificationCodeResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/addressVerificationServiceResult"},"nameVerificationResult":{"description":"The outcome of the cardholder name verification check, indicating how the supplied name compared with the name on file with the issuer. May be omitted when the provider doesn't return a result.","type":"string"},"pointOfInteraction":{"description":"The entry type of the transaction.","type":"object","properties":{"entryType":{"$ref":"#/components/schemas/entryType"}}},"emvDataResponse":{"$ref":"#/components/schemas/emvDataResponse"},"providerResponse":{"$ref":"#/components/schemas/cardProviderResponse"}},"type":"object"}},"components/schemas/cashback":{"id":"components/schemas/cashback","kind":"json-schema","title":"cashback","data":{"description":"The cashback amount for the authorisation.","type":"number","example":10}},"components/schemas/correlationId":{"id":"components/schemas/correlationId","kind":"json-schema","title":"correlationId","data":{"description":"A unique PXP identifier for tracing this request in logs and support investigations.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"}},"components/schemas/currencyCode":{"id":"components/schemas/currencyCode","kind":"json-schema","title":"currencyCode","data":{"description":"The currency code in ISO 4217 format.","example":"EUR","type":"string","minLength":3,"maxLength":3}},"components/schemas/dccData":{"id":"components/schemas/dccData","kind":"json-schema","title":"dccData","data":{"description":"Details about the Dynamic Currency Conversion (DCC) for the transaction, including rate selection, amounts in local and cardholder currencies, exchange rate, and provider details.","type":"object","properties":{"rateSelectedIndicator":{"type":"string","enum":["NotSelected","Selected","ErrorRetrievingDccData","DccNotEligible","InvalidDccTerminalId","InvalidDccMerchantId","NoDccSupported","NoDccRateAvailable","ServerErrorRetrievingDccData","InvalidDccRequest","DccTimeout"],"description":"The DCC selection state indicating whether DCC was selected, wasn't selected, or was unavailable due to an error or eligibility issue.","example":"Selected"},"amounts":{"type":"object","description":"DCC amounts with local and cardholder sub-objects.","properties":{"local":{"type":"object","description":"Details about the transaction amount in the local (merchant) currency.","properties":{"transaction":{"type":"number","description":"The transaction amount in the local currency.","example":100},"currencyCode":{"type":"string","description":"The currency code in ISO 4217 format.","example":"USD","minLength":3,"maxLength":3}},"required":["transaction","currencyCode"]},"cardholder":{"type":"object","description":"Details about the transaction amount in the cardholder's currency.","properties":{"transaction":{"type":"number","description":"The transaction amount in the cardholder's currency.","example":85.5},"currencyCode":{"type":"string","description":"The currency code in ISO 4217 format.","example":"EUR","minLength":3,"maxLength":3}},"required":["transaction","currencyCode"]}},"required":["local","cardholder"]},"exchangeRate":{"type":"object","description":"Exchange rate details.","properties":{"rate":{"type":"number","description":"The exchange rate used for the DCC conversion.","example":0.855},"markUpPercentage":{"type":"number","description":"The markup percentage applied to the DCC transaction.","example":3.92,"nullable":true}}},"providerData":{"$ref":"#/components/schemas/dccProviderData"}}}},"components/schemas/dccProviderData":{"id":"components/schemas/dccProviderData","kind":"json-schema","title":"dccProviderData","data":{"type":"object","description":"Details about the DCC provider.","properties":{"provider":{"type":"string","description":"The name of the DCC provider.","example":"Elavon","maxLength":100},"referenceId":{"type":"string","description":"The reference ID provided by the DCC provider.","example":"REF123456789","maxLength":80,"nullable":true},"terminalId":{"$ref":"#/components/schemas/dccProviderTerminalId"},"markupTextIndicator":{"type":"integer","description":"The markup text indicator for the DCC provider.","example":1,"nullable":true}}}},"components/schemas/details":{"id":"components/schemas/details","kind":"json-schema","title":"details","data":{"description":"An array of additional details about the error, potentially including system-specific information, sub-errors, or contextual data to aid in troubleshooting.","type":"array","items":{},"example":["''$.site - The site field is required."]}},"components/schemas/entryType":{"id":"components/schemas/entryType","kind":"json-schema","title":"entryType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the transaction is initiated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for card-present retail, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for mail order or telephone order."},"children":[]}]}]}],"type":"string","enum":["Instore","Moto"],"example":"Instore"}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the structure for reporting errors encountered during the transaction process. This object includes a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"correlationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for tracking and diagnosing the issue, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifying the type of error, and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" providing a descriptive explanation of the error. Additionally, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array may contain further information or context about the error, offering insights necessary for troubleshooting and resolution. This structured approach ensures precise error reporting and aids in efficient error management and support processes."},"children":[]}]}]}],"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"required":["correlationId","errorCode","errorReason"],"type":"object"}},"components/schemas/errorCode":{"id":"components/schemas/errorCode","kind":"json-schema","title":"errorCode","data":{"description":"A standardised code that categorises the type of error encountered, enabling quick identification of common issues..","example":"INVALID_REQUEST","type":"string"}},"components/schemas/errorReason":{"id":"components/schemas/errorReason","kind":"json-schema","title":"errorReason","data":{"description":"A human-readable explanation of the error, providing clarity on the nature of the problem encountered.","example":"One or more validation errors occurred.","type":"string"}},"components/schemas/fundingType":{"id":"components/schemas/fundingType","kind":"json-schema","title":"fundingType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method that funds the transaction. For cloud device, this is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Card"],"example":"Card"}},"components/schemas/gatewayTokenId":{"id":"components/schemas/gatewayTokenId","kind":"json-schema","title":"gatewayTokenId","data":{"description":"A PXP token for a previously saved payment card. Use this instead of the full card details for stored-card or recurring transactions.","example":"1ed768bb-e88a-4636-91ae-67927ccbb03a","maxLength":36,"minLength":36,"type":"string"}},"components/schemas/gratuity":{"id":"components/schemas/gratuity","kind":"json-schema","title":"gratuity","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gratuity or tip amount added by the customer, separate from the main transaction amount. Can't be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCharge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":5.01,"type":"number"}},"components/schemas/intent":{"id":"components/schemas/intent","kind":"json-schema","title":"intent","data":{"description":"The purpose or action of the transaction.","type":"string","enum":["Authorisation","EstimatedAuthorisation","Purchase","Refund","StandaloneRefund","Verification"],"example":"Authorisation"}},"components/schemas/issuerResponseCode":{"id":"components/schemas/issuerResponseCode","kind":"json-schema","title":"issuerResponseCode","data":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"merchant","data":{"description":"A unique identifier assigned by PXP to represent a merchant entity, such as a store, hotel, or website, within the payment processing system.","example":"MERCHANT-1","type":"string","maxLength":20}},"components/schemas/merchantAdvice":{"id":"components/schemas/merchantAdvice","kind":"json-schema","title":"merchantAdvice","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides additional guidance or recommendations from the card network regarding the transaction. This information is particularly useful for understanding the reasons behind a transaction's refusal and can offer suggestions for next steps. For instance, it might indicate that updated account information is available or suggest specific actions to resolve the refusal. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantAdvice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to detail this advisory information, making it easier for merchants to take corrective action or understand the refusal context."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"An advisory code provided by the card network that categorises the type of advice or recommendation."},"message":{"type":"string","description":"A human-readable message that provides further details or clarification about the advice code, potentially suggesting next steps or reasons for the transaction refusal."}},"type":"object"}},"components/schemas/merchantTransactionDate":{"id":"components/schemas/merchantTransactionDate","kind":"json-schema","title":"merchantTransactionDate","data":{"description":"The date and time when you initiated the transaction, in ISO 8601 format.","type":"string","format":"date-time","example":"2025-01-27T08:51:02.826445+00:00"}},"components/schemas/merchantTransactionId":{"id":"components/schemas/merchantTransactionId","kind":"json-schema","title":"merchantTransactionId","data":{"description":"A unique transaction reference assigned by you. Must be unique per transaction.","example":"TXN-001","type":"string","maxLength":50}},"components/schemas/operation":{"id":"components/schemas/operation","kind":"json-schema","title":"operation","data":{"description":"The operation to apply.","enum":["Capture","FinalCapture","Incremental","Refund","Void"],"example":"Capture","type":"string"}},"components/schemas/paymentAccountReference":{"id":"components/schemas/paymentAccountReference","kind":"json-schema","title":"paymentAccountReference","data":{"description":"The Payment Account Reference (PAR) is a unique identifier assigned to a payment account, independent of the card number. It remains constant over the account's lifetime, even if the card number (PAN) changes. PAR enhances transaction security and privacy, serving as a secure reference point for cardholders, merchants, and issuers. It is used in digital transaction processing to reliably link transactions and accounts without exposing the actual card number.","example":"V001ABCDEFGHIJKLMNOPQRSTUVWXY","pattern":"^[A-Z0-9]{29}$","type":"string"}},"components/schemas/providerResponseName":{"id":"components/schemas/providerResponseName","kind":"json-schema","title":"providerResponseName","data":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"}},"components/schemas/providerResponseCode":{"id":"components/schemas/providerResponseCode","kind":"json-schema","title":"providerResponseCode","data":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"}},"components/schemas/providerResponseMessage":{"id":"components/schemas/providerResponseMessage","kind":"json-schema","title":"providerResponseMessage","data":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"}},"components/schemas/providerResponseMerchantId":{"id":"components/schemas/providerResponseMerchantId","kind":"json-schema","title":"providerResponseMerchantId","data":{"description":"The unique identifier assigned by the provider to represent the merchant involved in the transaction processing.","example":"77772182","type":"string"}},"components/schemas/providerResponseTerminalId":{"id":"components/schemas/providerResponseTerminalId","kind":"json-schema","title":"providerResponseTerminalId","data":{"description":"The unique identifier assigned by the provider to represent the terminal involved in the transaction processing.","example":"7777218212","type":"string"}},"components/schemas/dccProviderTerminalId":{"id":"components/schemas/dccProviderTerminalId","kind":"json-schema","title":"dccProviderTerminalId","data":{"type":"string","description":"The terminal identifier assigned by the DCC provider.","example":"TERM001","maxLength":30,"nullable":true}},"components/schemas/providerTransactionId":{"id":"components/schemas/providerTransactionId","kind":"json-schema","title":"providerTransactionId","data":{"type":"string","description":"A unique identifier assigned by the financial service provider for the transaction. It facilitates tracking, reconciliation, and support processes."}},"components/schemas/pointOfSaleId":{"id":"components/schemas/pointOfSaleId","kind":"json-schema","title":"pointOfSaleId","data":{"type":"string","description":"A PXP unique identifier for the specific point-of-sale device, often assigned by the merchant or payment processor.","example":"ACME-001","maxLength":20}},"components/schemas/storeAndForwardType":{"id":"components/schemas/storeAndForwardType","kind":"json-schema","title":"storeAndForwardType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of Store and Forward mechanism to use when your connection to the PXP gateway is disrupted. It securely stores transactions offline until communications are re-established with the gateway. The types are:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"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":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No store and forward mechanism is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ForcedStoreAndForward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Typically used in situations like cruise liners with poor satellite communications. Transactions are automatically forced into store and forward mode. Once communication is re-established, the transactions are sent to the gateway to perform online authorisation with the acquirer via the PXP gateway."},"children":[]}]}]}]}],"enum":["None","ForcedStoreAndForward"],"example":"None","type":"string"}},"components/schemas/language":{"id":"components/schemas/language","kind":"json-schema","title":"language","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display language, in ISO 639-1 format."},"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":"CA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Catalan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Danish"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": German"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": English"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Spanish"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": French"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hungarian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Icelandic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Italian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Dutch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Norwegian"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Polish"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Portuguese"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Swedish"},"children":[]}]}]}]}],"type":"string","maxLength":2,"enum":["CA","DA","DE","EN","ES","FR","HU","IS","IT","NL","NO","PL","PT","SV"],"example":"EN"}},"components/schemas/pointOfInteraction":{"id":"components/schemas/pointOfInteraction","kind":"json-schema","title":"pointOfInteraction","data":{"description":"Information about the POS device where the transaction takes place.","properties":{"pointOfSaleId":{"$ref":"#/components/schemas/pointOfSaleId"},"language":{"$ref":"#/components/schemas/language"},"storeAndForwardType":{"$ref":"#/components/schemas/storeAndForwardType"},"invokeKeyed":{"description":"Whether to initiate a keyed (manual entry) transaction on the device.","type":"boolean","example":true,"default":false}},"required":["pointOfSaleId"]}},"components/schemas/emvDataResponse":{"id":"components/schemas/emvDataResponse","kind":"json-schema","title":"emvDataResponse","data":{"description":"EMV chip response data returned for an in-store card transaction.","type":"object","properties":{"applicationId":{"description":"The Application Identifier (AID) of the selected EMV application on the card or terminal. The application determines which network processes the transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable label associated with the Application Identifier (AID). EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A two-character code indicating the result of the authorisation (e.g., approval, denial, or referral). EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of the last cardholder verification method performed (e.g., PIN or signature). EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9F34"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"1F0302"},"panSequenceNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sequence number that distinguishes cards that share the same PAN. EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5F34"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"01"},"preferredName":{"description":"The preferred application name designated by the card issuer.","type":"string","example":"Visa"},"issuerAuthenticationData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data sent to the ICC for online issuer authentication. EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"91"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"C9DF3CA29138D5E83030"},"issuerScriptTemplate1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proprietary issuer data for transmission to the ICC before the second GENERATE AC command. EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"71"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"710A1234567890ABCDEF"},"issuerScriptTemplate2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proprietary issuer data for transmission to the ICC after the second GENERATE AC command. EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"72"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"720B1234567890ABCDEF12"}}}},"components/schemas/recurring":{"id":"components/schemas/recurring","kind":"json-schema","title":"recurring","data":{"description":"Details about recurring or card-on-file payment processing.","type":"object","properties":{"processingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring processing model. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOnFileShopperConsent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the shopper is present and provides consent for card storage, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantInitiatedInitialRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the initial transaction in a merchant-initiated recurring series."},"children":[]}]}]}],"type":"string","enum":["cardOnFileShopperConsent","merchantInitiatedInitialRecurring"],"example":"cardOnFileShopperConsent"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"frequencyInDays":{"description":"The frequency of the recurring charge in days.","type":"integer","example":30}}}},"components/schemas/schemeTransactionId":{"id":"components/schemas/schemeTransactionId","kind":"json-schema","title":"schemeTransactionId","data":{"type":"string","description":"A unique identifier assigned by the card scheme (e.g., Visa, MasterCard) to each transaction. This identifier is crucial for tracking, reconciliation, and managing the lifecycle of the transaction, especially in contexts like chargebacks and fraud analysis. For card transactions, this could be the Visa Transaction Identifier or MasterCard Banknet Reference Number.","example":"1234567890123456789012"}},"components/schemas/schemeTransactionLinkId":{"id":"components/schemas/schemeTransactionLinkId","kind":"json-schema","title":"schemeTransactionLinkId","data":{"type":"string","description":"The scheme-assigned identifier (MasterCard Transaction Link Identifier) of the initial transaction in a series. Submit it on subsequent economically-related transactions (e.g., recurring, unscheduled card-on-file, resubmission) to link them to the original, so the scheme treats them as part of the same agreement rather than independent payments.","example":"LINK-001"}},"components/schemas/settlementDate":{"id":"components/schemas/settlementDate","kind":"json-schema","title":"settlementDate","data":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments in ISO 8601 format. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation.","example":"2024-01-25T00:00:00Z"}},"components/schemas/shipping":{"id":"components/schemas/shipping","kind":"json-schema","title":"shipping","data":{"description":"The shipping amount.","type":"number","example":5}},"components/schemas/site":{"id":"components/schemas/site","kind":"json-schema","title":"site","data":{"description":"The unique identifier for the site associated with the transaction, as assigned by PXP. This could represent a physical location, website, or any other distinct entity where the transaction occurs.","example":"SITE-1","maxLength":50,"type":"string"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"state","data":{"description":"The current state of the transaction.","enum":["Authorised","Captured","Cancelled","Error","Refused"],"example":"Authorised","type":"string"}},"components/schemas/stateData":{"id":"components/schemas/stateData","kind":"json-schema","title":"stateData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key value pair for various state data. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/point-of-sale/pos-plus/how-it-works#state-data-response-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more about how this works"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"code":{"$ref":"#/components/schemas/stateDataCode"},"message":{"$ref":"#/components/schemas/stateDataMessage"}},"example":{"code":"CRD000","message":"Approved"}}},"components/schemas/stateDataCode":{"id":"components/schemas/stateDataCode","kind":"json-schema","title":"stateDataCode","data":{"description":"The state details code.","type":"string","enum":["CRD000","CRD001","CRD002","CRD003","CRD004","CRD005","CRD006","CRD007","CRD100","CRD101","CRD102","CRD103","CRD104","CRD105","CRD106","CRD107","CRD108","CRD109","CRD110","CRD111","CRD112","CRD113","CRD114","CRD115","CRD116","CRD117","CRD118","CRD119","CRD120","CRD121","CRD122","CRD123","CRD124","CRD125","CRD126","CRD127","CRD128","CRD129","CRD180","CRD181","CRD182","CRD183","CRD184","CRD185"]}},"components/schemas/stateDataMessage":{"id":"components/schemas/stateDataMessage","kind":"json-schema","title":"stateDataMessage","data":{"description":"The state details message.","type":"string","enum":["Approved","Honour with identification","Approved for partial amount","Approved (VIP)","Approved, update track 3","Approved, account type specified by card issuer","Approved for partial amount, account type specified by card issuer","Approved, update ICC","Do not honour","Expired card","Suspected fraud","Card acceptor contact acquirer","Restricted card","Card acceptor call acquirer's security department","Allowable PIN tries exceeded","Refer to card issuer","Refer to card issuer's special conditions","Invalid merchant","Invalid amount","Invalid card number","PIN data required","Unacceptable fee","No account of type requested","Requested function not supported","Not sufficient funds","Incorrect PIN","No card record","Transaction not permitted to cardholder","Transaction not permitted to terminal","Exceeds withdrawal amount limit","Security violation","Exceeds withdrawal frequency limit","Violation of law","Card not effective","Invalid PIN block","PIN length error","PIN key sync error","Suspected counterfeit card","Retry in contact mode or SCA Ecom required","Pick up card","Bad format","Timeout / Malfunction","Card restricted","Refused by fraud or scoring system"]}},"components/schemas/systemTransactionId":{"id":"components/schemas/systemTransactionId","kind":"json-schema","title":"systemTransactionId","data":{"description":"A unique identifier generated by PXP for each transaction. It serves as a reference for tracking and querying transactions within the PXP system. This ID is crucial for performing modifications or querying transaction details.","example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"components/schemas/transactionResponse":{"id":"components/schemas/transactionResponse","kind":"json-schema","title":"transactionResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object provides comprehensive details regarding the status and data associated with the transaction. It includes information about the current state of the transaction, transaction-specific details, funding data related information, and the response received from the payment provider."},"children":[]}]}]}],"type":"object","properties":{"state":{"$ref":"#/components/schemas/state"},"stateData":{"$ref":"#/components/schemas/stateData"},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"providerTransactionId":{"$ref":"#/components/schemas/providerTransactionId"},"fundingData":{"$ref":"#/components/schemas/cardResponse"},"amounts":{"$ref":"#/components/schemas/amountsResponse"},"dccData":{"$ref":"#/components/schemas/dccData"}}}},"components/schemas/transaction":{"id":"components/schemas/transaction","kind":"json-schema","title":"transaction","data":{"description":"The transaction amount. Values after the decimal are zero-padded to the currency exponent (e.g., GBP 1.1 becomes 1.10). Requests are rejected if there are too many decimal places for the currency, or if a decimal is supplied for a zero-exponent currency (e.g., JPY 1.0).","example":30.32,"type":"number"}},"components/schemas/transactionMethod":{"id":"components/schemas/transactionMethod","kind":"json-schema","title":"transactionMethod","data":{"description":"The transaction method provides comprehensive details about the intent, capture method, and origin of a transaction.","properties":{"entryType":{"$ref":"#/components/schemas/entryType"},"fundingType":{"$ref":"#/components/schemas/fundingType"},"intent":{"$ref":"#/components/schemas/intent"}},"type":"object","required":["entryType","fundingType","intent"]}},"components/schemas/serviceCharge":{"id":"components/schemas/serviceCharge","kind":"json-schema","title":"serviceCharge","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the service charge applied to the transaction. Can't be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gratuity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"amount":{"type":"number","description":"The fixed service charge amount.","example":2.5},"percentage":{"type":"number","description":"The service charge as a percentage of the transaction amount.","example":1.5},"optional":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the service charge is optional. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the service charge may be declined by the cardholder."},"children":[]}]}]}],"example":true}},"required":["amount","percentage"]}},"components/schemas/statusCallbackUrl":{"id":"components/schemas/statusCallbackUrl","kind":"json-schema","title":"statusCallbackUrl","data":{"description":"The webhook URL for PXP to send status updates to. Overrides the URL configured in the Unity Portal.","type":"string","example":"http://192.168.1.1:5000/statuspacket"}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"POS-001"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"description":"Request body to initiate a cloud device transaction for the specified point-of-sale device.","properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"pointOfInteraction":{"$ref":"#/components/schemas/pointOfInteraction"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"amounts":{"$ref":"#/components/schemas/amounts"},"transactionMethod":{"$ref":"#/components/schemas/transactionMethod"},"recurring":{"$ref":"#/components/schemas/recurring"},"statusCallbackUrl":{"$ref":"#/components/schemas/statusCallbackUrl"}},"required":["merchant","site","merchantTransactionId","merchantTransactionDate","amounts","transactionMethod","pointOfInteraction"],"type":"object"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$ref":"#/components/schemas/systemTransactionId"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"description":"Request body to modify a previously initiated cloud device transaction.","required":["merchant","site","merchantTransactionId","merchantTransactionDate","operation","amounts"],"properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"operation":{"$ref":"#/components/schemas/operation"},"amounts":{"$ref":"#/components/schemas/amounts"}},"type":"object"},"id":"schema_3"}},"exampleStore":{"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation","summary":"Card authorisation","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-002","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR","gratuity":5.01},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation (with gratuity)","summary":"Card authorisation (with gratuity)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-003","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR","serviceCharge":{"amount":2.5,"percentage":1.5,"optional":false}},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation (with service charge)","summary":"Card authorisation (with service charge)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-004","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":50,"currencyCode":"EUR","cashback":10},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation (with cashback)","summary":"Card authorisation (with cashback)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with cashback)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-005","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":40,"currencyCode":"EUR","shipping":5},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation (with shipping)","summary":"Card authorisation (with shipping)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (with shipping)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-006","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"ForcedStoreAndForward"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation (forced store and forward)","summary":"Card authorisation (forced store and forward)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation (forced store and forward)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-EST-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card estimated authorisation","summary":"Card estimated authorisation","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-PUR-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card purchase","summary":"Card purchase","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"COF-PUR-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":45.5,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"recurring":{"processingModel":"cardOnFileShopperConsent"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card purchase with card-on-file consent","summary":"Card purchase with card-on-file consent","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"REC-EST-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":50,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"recurring":{"processingModel":"merchantInitiatedInitialRecurring","frequencyInDays":30},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card estimated authorisation with initial recurring","summary":"Card estimated authorisation with initial recurring","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"COF-MOTO-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":75,"currencyCode":"GBP"},"transactionMethod":{"intent":"Authorisation","entryType":"Moto","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":true},"recurring":{"processingModel":"cardOnFileShopperConsent"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card authorisation with card-on-file consent (MOTO)","summary":"Card authorisation with card-on-file consent (MOTO)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (MOTO)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-RFD-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Refund","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card refund","summary":"Card refund","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card refund"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-REF-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"StandaloneRefund","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card standalone refund","summary":"Card standalone refund","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card standalone refund"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"COF-VER-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":0,"currencyCode":"GBP"},"transactionMethod":{"intent":"Verification","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"recurring":{"processingModel":"cardOnFileShopperConsent"},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card verification with card-on-file consent","summary":"Card verification with card-on-file consent","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with card-on-file consent"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"REC-VER-001","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","amounts":{"transaction":0,"currencyCode":"GBP"},"transactionMethod":{"intent":"Verification","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"recurring":{"processingModel":"merchantInitiatedInitialRecurring","frequencyInDays":30},"statusCallbackUrl":"http://192.168.1.1:5000/statuspacket"},"key":"Card verification with initial recurring","summary":"Card verification with initial recurring","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/requestBody/content/application~1json/examples/Card verification with initial recurring"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Instore"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","paymentAccountReference":"V001ABCDEFGHIJKLMNOPQRSTUVWXY","schemeTransactionId":"SCHEME-TXN-001","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-001"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Card authorised","summary":"Card authorised","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"460070","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","merchantTransactionId":"TXN-EMV-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"541333******0078","expiryMonth":"12","expiryYear":"2025","cardScheme":"MasterCard","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Instore"},"emvDataResponse":{"applicationId":"A0000000041010","applicationLabel":"MASTERCARD","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"MASTERCARD","issuerAuthenticationData":"C9DF3CA29138D5E83030"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","paymentAccountReference":"V001ABCDEFGHIJKLMNOPQRSTUVWXY","schemeTransactionId":"SCHEME-TXN-001","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-001","settlementDate":"2025-01-28T00:00:00Z"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Card authorised (with EMV data)","summary":"Card authorised (with EMV data)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with EMV data)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"460070","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","merchantTransactionId":"TXN-002","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"PROV-98766","fundingData":{"maskedPrimaryAccountNumber":"541333******0078","expiryMonth":"12","expiryYear":"2025","cardScheme":"MasterCard","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Instore"},"emvDataResponse":{"applicationId":"A0000000041010","applicationLabel":"MASTERCARD","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"MASTERCARD"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","paymentAccountReference":"V001ABCDEFGHIJKLMNOPQRSTUVWXY","schemeTransactionId":"SCHEME-TXN-002","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-002","settlementDate":"2025-01-28T00:00:00Z"}},"amounts":{"transaction":30.32,"currencyCode":"EUR","gratuity":5.01}},"key":"Card authorised (with gratuity)","summary":"Card authorised (with gratuity)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","merchantTransactionId":"TXN-DCC-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"PROV-98765","amounts":{"transaction":100,"currencyCode":"EUR","gratuity":5},"fundingData":{"maskedPrimaryAccountNumber":"************1234","expiryMonth":"12","expiryYear":"2025","cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Instore"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"VISA DEBIT","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"VISA DEBIT"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","paymentAccountReference":"V001ABCDEFGHIJKLMNOPQRSTUVWXY","schemeTransactionId":"SCHEME-TXN-001","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-001"}},"dccData":{"rateSelectedIndicator":"Selected","exchangeRate":{"rate":1.2345,"markUpPercentage":3.5},"amounts":{"local":{"currencyCode":"EUR","transaction":100},"cardholder":{"currencyCode":"USD","transaction":123.45}},"providerData":{"provider":"Elavon"}}},"key":"Card authorised (with DCC)","summary":"Card authorised (with DCC)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused":{"value":{"state":"Refused","stateData":{"code":"CRD100","message":"Do not honour"},"merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","merchantTransactionId":"TXN-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"PROV-98770","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Instore"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"VISA CREDIT","authorisationResponseCode":"05"},"providerResponse":{"provider":"PXPFinancial","code":"05","message":"Do not honour","merchantId":"77772182","terminalId":"75836665","issuerResponseCode":"05","merchantAdvice":{"code":"01","message":"New account information available"}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Card refused","summary":"Card refused","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card refused"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionDate":"2025-01-27T08:51:02.826445+00:00","merchantTransactionId":"TXN-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","pointOfInteraction":{"entryType":"Instore"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Card error","summary":"Card error","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/200/content/application~1json/examples/Card error"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0003","errorReason":"Invalid Card Details Provided"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/400/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0004","errorReason":"Authentication Failed for Card Transaction"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/401/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0005","errorReason":"Transaction Not Permitted"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/403/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0006","errorReason":"Card Transaction Details Not Found"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/404/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0010","errorReason":"Invalid Transaction Data Format"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/422/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"GEN0008","errorReason":"Unexpected Internal Error"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions/post/responses/500/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001-CAPTURE","merchantTransactionDate":"2025-01-27T09:00:00.000Z","operation":"Capture","amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Capture","summary":"Capture","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001-FINAL-CAPTURE","merchantTransactionDate":"2025-01-27T09:00:00.000Z","operation":"FinalCapture","amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Final capture","summary":"Final capture","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001-INCREMENTAL","merchantTransactionDate":"2025-01-27T09:00:00.000Z","operation":"Incremental","amounts":{"currencyCode":"EUR","transaction":35}},"key":"Incremental","summary":"Incremental","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001-REFUND","merchantTransactionDate":"2025-01-27T09:00:00.000Z","operation":"Refund","amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Refund","summary":"Refund","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"TXN-001-VOID","merchantTransactionDate":"2025-01-27T09:00:00.000Z","operation":"Void","amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Void","summary":"Void","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured":{"value":{"state":"Captured","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001-CAPTURE","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T09:00:00.000Z","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Captured","summary":"Captured","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Captured"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture":{"value":{"state":"Captured","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001-FINAL-CAPTURE","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T09:00:00.000Z","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Final capture","summary":"Final capture","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Final capture"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001-INCREMENTAL","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T09:00:00.000Z","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665"}},"amounts":{"transaction":35,"currencyCode":"EUR"}},"key":"Incremental (Authorised)","summary":"Incremental (Authorised)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001-REFUND","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T09:00:00.000Z","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Refund (Authorised)","summary":"Refund (Authorised)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)":{"value":{"state":"Cancelled","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"A123456","merchantTransactionId":"TXN-001-VOID","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2025-01-27T09:00:00.000Z","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Void (Cancelled)","summary":"Void (Cancelled)","id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Cancelled)"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0003","errorReason":"Invalid Card Details Provided"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/400/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0004","errorReason":"Authentication Failed for Card Transaction"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/401/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0005","errorReason":"Transaction Not Permitted"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/403/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0006","errorReason":"Card Transaction Details Not Found"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/404/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0010","errorReason":"Invalid Transaction Data Format"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/422/content/application~1json/example"},"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example":{"value":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"GEN0008","errorReason":"Unexpected Internal Error"},"id":"paths/~1cloud-device~1{merchantPointOfSaleId}~1transactions~1{systemTransactionId}~1modifications/post/responses/500/content/application~1json/example"}},"securitySchemeStore":{"PXP-POS":{"id":"PXP-POS","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-POS authentication with HMAC-SHA256 signature. Format: PXP-POS {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"specVersion":"3.0.3","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"specType":"openapi"},"options":{"hideSchemaTitles":true,"mockServer":{"url":"/_mock/apis/cloud-device-transaction","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/cloud-device-transaction.json?download"},{"url":"/_bundle/apis/cloud-device-transaction.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Cloud device transactions","description":"API reference for cloud device transactions.\n\nFor authentication, request shapes, constraints, and worked examples, see the [Cloud invocation guides](/guides/point-of-sale/pos-plus/cloud)."}},"baseSlug":"/apis/cloud-device-transaction","routesMapping":{}}