{"items":[{"type":"link","label":"POS transaction service API","link":"/apis/point-of-sale-transaction","routeSlug":"/apis/point-of-sale-transaction","content":{"contentType":"overview","meta":{"name":"POS transaction service API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"point-of-sale-transaction.json","url":"/_bundle/apis/point-of-sale-transaction.json?download"},{"kind":"download","label":"point-of-sale-transaction.yaml","url":"/_bundle/apis/point-of-sale-transaction.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"POS transaction service API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the Point of Sale transaction service."}],"sectionId":"/apis/point-of-sale-transaction"}],"sectionId":"/apis/point-of-sale-transaction"}]}]}},{"label":"Initiate a POS transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/initiate-pos-transaction","routeSlug":"/apis/point-of-sale-transaction/other/initiate-pos-transaction","metadata":{"seo":{"title":"Initiate a POS transaction","description":"The /pos-transactions endpoint enables you to initiate instore transactions. It supports various transaction methods including card and alternative payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-pos-transaction","name":"Initiate a POS transaction","isWebhook":false,"pointer":"/paths/~1pos-transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a POS transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/pos-transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint enables you to initiate instore transactions. It supports various transaction methods including card and alternative payments."},"children":[]}]}]}]},{"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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_111","exampleIds":["paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"]}},"schemaId":"schema_111","exampleIds":["paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"],"pointer":"/paths/~1pos-transactions/post/requestBody","description":"Initiate a transaction"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pos-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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PXP-POS","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_111","exampleIds":["paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"]}},"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/pos-transactions","href":"other/initiate-pos-transaction","openApiOperationId":"initiate-pos-transaction","summary":"Initiate a POS 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_111","exampleIds":["paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_111","exampleIds":["paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)","paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"]}},"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":"schema_112","exampleIds":["paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)"]}},"schemaId":"schema_112","exampleIds":["paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120"}},"schemaId":"schema_120"}],"pointer":"/paths/~1pos-transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_112","exampleIds":["paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112","exampleIds":["paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)","paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)"]}}},{"code":"400","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"401","schemaId":"schema_114","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}}},{"code":"403","schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115"}}},{"code":"404","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"413","schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}}},{"code":"422","schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}}},{"code":"500","schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}}},{"code":"default","schemaId":"schema_120","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/initiate-pos-transaction"}],"panels":[]}]},"httpPath":"/pos-transactions"},{"label":"Initiate a POS transaction (legacy)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/initiate-pos-transaction-legacy","routeSlug":"/apis/point-of-sale-transaction/other/initiate-pos-transaction-legacy","metadata":{"seo":{"title":"Initiate a POS transaction (legacy)","description":"The /pos-transactions endpoint enables the initiation of instore transactions, supporting various transaction methods, including card and alternative payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-pos-transaction-legacy","name":"Initiate a POS transaction (legacy)","isWebhook":false,"pointer":"/paths/~1pos-transactions~1legacy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a POS transaction (legacy)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The /pos-transactions endpoint enables the initiation of instore transactions, supporting various transaction methods, including card and alternative payments."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"]}},"schemaId":"schema_121","exampleIds":["paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"],"pointer":"/paths/~1pos-transactions~1legacy/post/requestBody","description":"Initiate a transaction"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pos-transactions/legacy","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"]}},"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/pos-transactions/legacy","href":"other/initiate-pos-transaction-legacy","openApiOperationId":"initiate-pos-transaction-legacy","summary":"Initiate a POS transaction (legacy)"},"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_121","exampleIds":["paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification","paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"]}},"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":"schema_122","exampleIds":["paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)"]}},"schemaId":"schema_122","exampleIds":["paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1pos-transactions~1legacy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_122","exampleIds":["paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122","exampleIds":["paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)","paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)"]}}},{"code":"400","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"401","schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}}},{"code":"403","schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}}},{"code":"404","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"413","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"422","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"500","schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}}},{"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-pos-transaction-legacy"}],"panels":[]}]},"httpPath":"/pos-transactions/legacy"},{"label":"Create a POS modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/point-of-sale-transaction/other/modify-pos-transaction","routeSlug":"/apis/point-of-sale-transaction/other/modify-pos-transaction","metadata":{"seo":{"title":"Create a POS modification","description":"This endpoint facilitates the processing of modifications on previously initiated transactions that have not yet been fully processed or captured. Supported modification actions include refunds, captures, incremental authorisations, and voids. Upon successful execution, it returns a unique reference for the modification request, allowing for easy tracking and reconciliation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modify-pos-transaction","name":"Create a POS modification","isWebhook":false,"pointer":"/paths/~1pos-transactions~1{systemTransactionId}~1modifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a POS modification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint facilitates the processing of modifications on previously initiated transactions that have not yet been fully processed or captured. Supported modification actions include refunds, captures, incremental authorisations, and voids. Upon successful execution, it returns a unique reference for the modification request, allowing for easy tracking and reconciliation."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"systemTransactionId","in":"path","schemaId":"schema_130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with which you want to process an operation."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1pos-transactions~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_131","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"]}},"schemaId":"schema_131","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"],"pointer":"/paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody","description":"Modifications to a previous transaction."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pos-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":"systemTransactionId","in":"path","required":true,"example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemaId":"schema_130","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"]}},"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/pos-transactions/{systemTransactionId}/modifications","href":"other/modify-pos-transaction","openApiOperationId":"modify-pos-transaction","summary":"Create a POS 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_131","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental","paths/~1pos-transactions~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":"Modifications response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"]}},"schemaId":"schema_132","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132","exampleIds":["paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"]}}},{"code":"400","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"401","schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}}},{"code":"403","schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}}},{"code":"404","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"413","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"422","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"500","schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}}},{"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-pos-transaction"}],"panels":[]}]},"httpPath":"/pos-transactions/{systemTransactionId}/modifications"}],"store":{"schemaStore":{"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 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":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the amount of the transaction. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent, for example, GBP 1.234, or if a decimal is supplied when the currencyCode of exponent does not require it, for example, JPY 1.0."},"children":[]}]}]}],"example":30.32,"type":"number"},"gratuity":{"$ref":"#/components/schemas/gratuity"},"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":{"description":"The amount of the transaction.","example":52,"type":"number"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"gratuity":{"$ref":"#/components/schemas/gratuity"}}}},"components/schemas/approvalCode":{"id":"components/schemas/approvalCode","kind":"json-schema","title":"approvalCode","data":{"description":"A unique identifier code provided by the authorizing entity, indicating approval or reference for the transaction. This code typically consists of alphanumeric characters, starting with an uppercase letter, and serves as a key reference for authorisation verification.","example":"A123456","type":"string","pattern":"^[A-Z]"}},"components/schemas/cardScheme":{"id":"components/schemas/cardScheme","kind":"json-schema","title":"cardScheme","data":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"}},"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.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"}}}},"components/schemas/cardResponse":{"id":"components/schemas/cardResponse","kind":"json-schema","title":"cardResponse","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":"cardResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object encapsulates essential information about a card involved in a transaction, including its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling merchants to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is of type 'Card' or 'SchemeToken'."},"children":[]}]}]}],"properties":{"maskedPrimaryAccountNumber":{"description":"The card's primary account number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"463242******1234"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry month [MM] of the card."},"children":[]}]}]}],"type":"string","example":"12"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry year [YYYY] of the card."},"children":[]}]}]}],"type":"string","example":"2026"},"cardScheme":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"},"gatewayTokenId":{"description":"The gateway token Id represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"},"emvDataResponse":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}},"providerResponse":{"description":"The response from the payment provider containing details about the transaction processing outcome.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"issuerResponseCode":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"}}}},"type":"object"}},"components/schemas/correlationId":{"id":"components/schemas/correlationId","kind":"json-schema","title":"correlationId","data":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","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, not selected, or unavailable due to an error or eligibility issue.","example":"Selected"},"amount":{"type":"object","description":"Details about the transaction amount in the local currency and the cardholder's currency.","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":"number","description":"The exchange rate used for the DCC conversion.","example":0.855},"markupRate":{"type":"number","description":"The markup rate applied to the DCC transaction.","example":3.92,"nullable":true},"disclaimer":{"$ref":"#/components/schemas/disclaimer"},"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},"merchantId":{"$ref":"#/components/schemas/dccProviderMerchantId"},"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":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"}},"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":"The environment and method by which the transaction is initiated, reflecting the nature of the transaction's origin. This classification is crucial for applying the appropriate security measures and compliance standards. The entry types include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ecom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for online transactions, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for mail order/telephone order transactions, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for physical retail environments, each representing different transaction contexts and risk profiles."},"children":[]}]}]}],"type":"string","enum":["Instore","Moto"],"example":"Instore"}},"components/schemas/disclaimer":{"id":"components/schemas/disclaimer","kind":"json-schema","title":"disclaimer","data":{"type":"string","description":"The disclaimer text for the DCC transaction.","example":"Exchange rate includes markup","nullable":true}},"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":{"description":"A unique identifier generated to correlate the error with a specific transaction attempt, facilitating easier tracking and resolution of issues.","type":"string"},"details":{"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":{}},"errorCode":{"description":"A standardized code that categorizes the type of error encountered, enabling quick identification of common issues.","type":"string"},"errorReason":{"description":"A human-readable explanation of the error, providing clarity on the nature of the problem encountered.","type":"string"}},"required":["correlationId","errorCode","errorReason"],"type":"object"}},"components/schemas/errorCode":{"id":"components/schemas/errorCode","kind":"json-schema","title":"errorCode","data":{"description":"The error code returned for the operation.","example":"INVALID_REQUEST","type":"string"}},"components/schemas/errorReason":{"id":"components/schemas/errorReason","kind":"json-schema","title":"errorReason","data":{"description":"The error reason returned for the operation.","example":"One or more validation errors occurred.","type":"string"}},"components/schemas/fundingType":{"id":"components/schemas/fundingType","kind":"json-schema","title":"fundingType","data":{"description":"The method of payment used to fund the transaction. This field categorises the transaction by the payment medium, enabling tailored processing rules and security measures for each type. Understanding the funding type is crucial for processing the transaction correctly and ensuring compatibility with your  capabilities.","type":"string","enum":["Card"],"example":"Card"}},"components/schemas/gatewayTokenId":{"id":"components/schemas/gatewayTokenId","kind":"json-schema","title":"gatewayTokenId","data":{"description":"The gateway token Id represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","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 to the transaction total. This amount is separate from the main transaction and is specifically allocated as a gratuity for the service provider. Specifying this field allows for accurate reporting and distribution of tips to service staff, enhancing transparency and fairness in transactions where tipping is customary. This field 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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purpose or action of the transaction, indicating the intended money flow direction. This field is crucial for categorising the transaction type and guiding the processing logic accordingly. Options include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for reserving funds on the customer's payment method and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for immediate fund capture following authorisation. Each intent dictates a specific transaction flow and affects how the transaction is handled by the system."},"children":[]}]}]}],"type":"string","enum":["Authorisation","EstimatedAuthorisation","Purchase","Refund","StandaloneRefund","Verification"],"example":"Authorisation"}},"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. This identifier is crucial for routing transactions to the correct merchant account, ensuring accurate processing, settlement, and reporting. Merchants receive this value upon registration or integration with PXP, and it must be included in transaction requests to identify the merchant for whom the transaction is being processed.","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 categorizes 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/merchantDeeplink":{"id":"components/schemas/merchantDeeplink","kind":"json-schema","title":"merchantDeeplink","data":{"type":"string","format":"uri","description":"A custom URI scheme that allows the merchant's mobile app to handle payment callbacks. When provided, the payment terminal or SDK will use this deeplink to redirect users back to the merchant's app after the transaction is completed. This is commonly used in mobile payment flows to create a seamless user experience.","example":"myapp://payment/callback"}},"components/schemas/merchantTransactionDate":{"id":"components/schemas/merchantTransactionDate","kind":"json-schema","title":"merchantTransactionDate","data":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"}},"components/schemas/merchantTransactionId":{"id":"components/schemas/merchantTransactionId","kind":"json-schema","title":"merchantTransactionId","data":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50}},"components/schemas/modificationRequest":{"id":"components/schemas/modificationRequest","kind":"json-schema","title":"modificationRequest","data":{"description":"The modification request contains details required to perform a modification on a transaction, such as a refund, increment, void, or capture.","required":["merchant","amounts","merchantTransactionId","operation","site","merchantTransactionDate"],"properties":{"amounts":{"description":"Details of the amount including transaction and gratuity values and its associated currency.","type":"object","required":["transaction"],"properties":{"transaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the amount of the transaction. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent, for example, GBP 1.234, or if a decimal is supplied when the currencyCode of exponent does not require it, for example, JPY 1.0."},"children":[]}]}]}],"example":30.32,"type":"number"},"gratuity":{"$ref":"#/components/schemas/gratuity"}}},"merchant":{"description":"A unique identifier assigned by PXP to represent a merchant entity, such as a store, hotel, or website, within the payment processing system. This identifier is crucial for routing transactions to the correct merchant account, ensuring accurate processing, settlement, and reporting. Merchants receive this value upon registration or integration with PXP, and it must be included in transaction requests to identify the merchant for whom the transaction is being processed.","example":"MERCHANT-1","type":"string","maxLength":20},"merchantTransactionId":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50},"merchantTransactionDate":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"},"operation":{"description":"Describes the operation to be applied to the previous transaction. This field specifies actions such as refund, void, capture, or incremental adjustments to a transaction.","enum":["Capture","FinalCapture","Incremental","Refund","Void"],"example":"Capture","type":"string"},"site":{"description":"The unique site identifier associated with the transaction. This could represent a physical location, website, or any other distinct entity where the transaction occurs. The value for this field is generated by PXP.","example":"SITE-1","maxLength":20,"type":"string"},"statusCallbackUrl":{"$ref":"#/components/schemas/statusCallbackUrl"}},"type":"object"}},"components/schemas/modificationResponse":{"id":"components/schemas/modificationResponse","kind":"json-schema","title":"modificationResponse","data":{"description":"The modifications response provides details about the state of a transaction modification request, including the state itself, any additional state details, and relevant transaction, funding data, and provider information.","properties":{"state":{"description":"The current state of the transaction.","enum":["Authorised","Captured","Cancelled","Error","Refused"],"example":"Authorised","type":"string"},"stateData":{"type":"object","description":"Key value pair for various state data","properties":{"code":{"description":"This is the state Details Code","type":"string"},"message":{"description":"This is the state Details Message","type":"string"}},"example":{"code":"12345","message":"Merchant not found"}},"approvalCode":{"description":"A unique identifier code provided by the authorizing entity, indicating approval or reference for the transaction. This code typically consists of alphanumeric characters, starting with an uppercase letter, and serves as a key reference for authorisation verification.","example":"A123456","type":"string","pattern":"^[A-Z]"},"merchantTransactionId":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50},"systemTransactionId":{"description":"The system transaction Id is 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","minimum":36,"maximum":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"merchantTransactionDate":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"},"fundingData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data specifying the payment method used for the transaction. It includes essential information about a card involved in a transaction, such as its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling you to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schemeToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"maskedPrimaryAccountNumber":{"description":"The card's primary account number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"463242******1234"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry month [MM] of the card."},"children":[]}]}]}],"type":"string","example":"12"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry year [YYYY] of the card."},"children":[]}]}]}],"type":"string","example":"2026"},"cardScheme":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"},"gatewayTokenId":{"description":"The gateway token Id represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"},"emvDataResponse":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}}}},"providerResponse":{"type":"object","description":"The response from the payment provider containing details about the transaction processing outcome.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"issuerResponseCode":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"}}}},"required":["state"]}},"components/schemas/operation":{"id":"components/schemas/operation","kind":"json-schema","title":"operation","data":{"description":"Describes the operation to be applied to the previous transaction. This field specifies actions such as refund, void, capture, or incremental adjustments to a transaction.","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":"PAR12345678901234567890","pattern":"^[A-Z0-9]{22}$","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/dccProviderMerchantId":{"id":"components/schemas/dccProviderMerchantId","kind":"json-schema","title":"dccProviderMerchantId","data":{"type":"string","description":"The merchant ID assigned by the DCC provider.","example":"MERCH001","nullable":true}},"components/schemas/dccProviderTerminalId":{"id":"components/schemas/dccProviderTerminalId","kind":"json-schema","title":"dccProviderTerminalId","data":{"type":"string","description":"The terminal ID 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":"Store and Forward is a mechanism used for handling transactions when the merchant's 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":"The pointOfInteraction object captures detailed information about the device and environment where a card present transaction takes place. It includes various attributes that help identify and describe the capabilities and configurations of the point of sale (POS) device.","properties":{"pointOfSaleId":{"$ref":"#/components/schemas/pointOfSaleId"},"language":{"$ref":"#/components/schemas/language"},"storeAndForwardType":{"$ref":"#/components/schemas/storeAndForwardType"},"invokeKeyed":{"description":"Whether the merchant wants to initiate a keyed transaction on the device. Keyed transactions involve manually entering the card details on the point of sale (POS) device.","type":"boolean","example":true,"default":false}},"required":["pointOfSaleId","language","storeAndForwardType"]}},"components/schemas/emvDataResponse":{"id":"components/schemas/emvDataResponse","kind":"json-schema","title":"emvDataResponse","data":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}}},"components/schemas/recurring":{"id":"components/schemas/recurring","kind":"json-schema","title":"recurring","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about recurring payment processing for card-on-file transactions. This parameter applies to initial transactions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EstimatedAuthorisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry types. When provided, the customer's card will be saved on file with their consent, and the gateway token and scheme transaction ID will be returned in the response."},"children":[]}]}]}],"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 process model for the recurring transaction. 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"}}}},"components/schemas/retrievalReferenceNumber":{"id":"components/schemas/retrievalReferenceNumber","kind":"json-schema","title":"retrievalReferenceNumber","data":{"type":"string","description":"A unique reference, typically generated by the acquirer, to identify a specific transaction across the payment flow.","example":"613808317649"}},"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. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"}},"components/schemas/site":{"id":"components/schemas/site","kind":"json-schema","title":"site","data":{"description":"The unique site identifier associated with the transaction. This could represent a physical location, website, or any other distinct entity where the transaction occurs. The value for this field is generated by PXP.","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":"https://developer.pxp.io/guides/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":"The system transaction Id is 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","minimum":36,"maximum":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/transaction":{"id":"components/schemas/transaction","kind":"json-schema","title":"transaction","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the amount of the transaction. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent, for example, GBP 1.234, or if a decimal is supplied when the currencyCode of exponent does not require it, for example, JPY 1.0."},"children":[]}]}]}],"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":"Details about the service charge applied to the transaction. This field 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 service charge amount.","example":10},"percentage":{"type":"number","description":"The service charge percentage.","example":10}},"required":["amount","percentage"]}},"components/schemas/statusCallbackUrl":{"id":"components/schemas/statusCallbackUrl","kind":"json-schema","title":"statusCallbackUrl","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook URL that PXP should send status updates to, if the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return status packets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is enabled for the device. This overrides the webhook URL configured in the Unity Portal."},"children":[]}]}]}],"type":"string","example":"http://192.168.204.43:5000/statuspacket"}},"components/schemas/transactionResponse":{"id":"components/schemas/transactionResponse","kind":"json-schema","title":"transactionResponse","data":{"description":"The transactionResponse 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.","properties":{"state":{"description":"The current state of the transaction.","enum":["Authorised","Captured","Cancelled","Error","Refused"],"example":"Authorised","type":"string"},"stateData":{"type":"object","description":"Key value pair for various state data","properties":{"code":{"description":"This is the state Details Code","type":"string"},"message":{"description":"This is the state Details Message","type":"string"}},"example":{"code":"12345","message":"Merchant not found"}},"approvalCode":{"description":"A unique identifier code provided by the authorizing entity, indicating approval or reference for the transaction. This code typically consists of alphanumeric characters, starting with an uppercase letter, and serves as a key reference for authorisation verification.","example":"A123456","type":"string","pattern":"^[A-Z]"},"merchantTransactionDate":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"},"merchantTransactionId":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50},"systemTransactionId":{"description":"The system transaction Id is 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","minimum":36,"maximum":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"providerTransactionId":{"type":"string","description":"A unique identifier assigned by the financial service provider for the transaction. It facilitates tracking, reconciliation, and support processes."},"fundingData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data specifying the payment method used for the transaction. This object encapsulates essential information about a card involved in a transaction, including its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling merchants to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is of type 'Card' or 'SchemeToken'."},"children":[]}]}]}],"properties":{"maskedPrimaryAccountNumber":{"description":"The card's primary account number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"463242******1234"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry month [MM] of the card."},"children":[]}]}]}],"type":"string","example":"12"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry year [YYYY] of the card."},"children":[]}]}]}],"type":"string","example":"2026"},"cardScheme":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"},"gatewayTokenId":{"description":"The gateway token Id represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"},"emvDataResponse":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}},"providerResponse":{"type":"object","description":"The response from the payment provider containing details about the transaction processing outcome.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"},"issuerResponseCode":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"}}}}},"amounts":{"description":"Details about the transaction amounts, including the gratuity amount.","type":"object","properties":{"gratuity":{"$ref":"#/components/schemas/gratuity"}}},"dccData":{"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, not selected, or unavailable due to an error or eligibility issue.","example":"Selected"},"amount":{"type":"object","description":"Details about the transaction amount in the local currency and the cardholder's currency.","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":"number","description":"The exchange rate used for the DCC conversion.","example":0.855},"markupRate":{"type":"number","description":"The markup rate applied to the DCC transaction.","example":3.92,"nullable":true},"disclaimer":{"type":"string","description":"The disclaimer text for the DCC transaction.","example":"You are offered to pay in EUR. This includes a 3.5% commission above the base rate.","nullable":true},"providerData":{"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},"merchantId":{"$ref":"#/components/schemas/dccProviderMerchantId"},"terminalId":{"$ref":"#/components/schemas/dccProviderTerminalId"},"markupTextIndicator":{"type":"integer","description":"The markup text indicator for the DCC provider.","example":1,"nullable":true}}}}}},"type":"object"}},"schema_111":{"kind":"json-schema","data":{"description":"The transactionRequest object encapsulates all essential details required for initiating and processing a transaction. It includes funding data, address verification, transaction amounts, merchant information, shopper details, recurring payment information, site identifier, 3D Secure details, and transaction method.","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"},"merchantDeeplink":{"$ref":"#/components/schemas/merchantDeeplink"}},"required":["merchant","site","merchantTransactionId","merchantTransactionDate","amounts","transactionMethod","pointOfInteraction"],"type":"object"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"description":"The transactionResponse 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.","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"}},"type":"object"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"description":"Indicates a client-side error where the request could not be processed due to malformed syntax, invalid data, or missing information. This response is used across different transaction methods such as cards, APMs, bank transfers, and wallets, signaling the need for the requester to modify their input. It encompasses errors ranging from incorrect field formats to missing required parameters.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0003","errorReason":"Invalid Card Details Provided"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"description":"This response denotes an unauthorized request due to failed authentication or missing credentials, applicable across various payment methods. It suggests the system cannot verify the requester's identity or validate the transaction's legitimacy, necessitating authentication details or proper credentials.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0004","errorReason":"Authentication Failed for Card Transaction"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"description":"Signifies a request is understood but refused by the server, often due to insufficient permissions or access rules. This generic error is relevant for all transaction types, indicating the action requested by the user is forbidden despite successful authentication.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0005","errorReason":"Transaction Not Permitted"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"description":"Occurs when the server can find no match for the requested resource, applicable to any transaction type. This response indicates the specified resource, whether it be transaction details, user information, or other data, does not exist or cannot be found.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0006","errorReason":"Card Transaction Details Not Found"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"description":"Indicates that the server refuses to process the request because the request payload is larger than the server is willing or able to process. This error is applicable across all transaction types, signaling that the data submitted exceeds the maximum allowed size. Clients should reduce the size of their request before retrying. This response helps maintain efficient processing and prevents overloading the server with excessive data.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"TOK0004","errorReason":"Token Request Payload Too Large"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"description":"Signifies that the server understands the content type of the request and the syntax is correct, but it cannot process the contained instructions. This response is particularly relevant when validating request fields across various transaction methods, including cards, APMs, bank transfers, and wallets, where specific field values do not meet the expected formats or logical validations. It prompts a review and correction of the submitted data to align with the required standards or constraints.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0010","errorReason":"Invalid Transaction Data Format"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"description":"Represents a generic error response indicating an internal server error. This response is used when the server encounters an unexpected condition that prevents it from fulfilling the request, which could range from temporary server malfunctions to more complex issues within the server's processing of specific transactions. It signals that the problem lies with the server's internal operations rather than the request itself. This type of error requires server-side investigation and potentially corrective action to resolve the underlying issue.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"GEN0008","errorReason":"Unexpected Internal Error"},"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"type":"object"},"id":"schema_119"},"schema_120":{"kind":"json-schema","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":{"description":"A unique identifier generated to correlate the error with a specific transaction attempt, facilitating easier tracking and resolution of issues.","type":"string"},"details":{"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":{}},"errorCode":{"description":"A standardised code that categorizes the type of error encountered, enabling quick identification of common issues.","type":"string"},"errorReason":{"description":"A human-readable explanation of the error, providing clarity on the nature of the problem encountered.","type":"string"}},"required":["correlationId","errorCode","errorReason"],"type":"object"},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"description":"The transactionRequest object encapsulates all essential details required for initiating and processing a transaction. It includes funding data, address verification, transaction amounts, merchant information, shopper details, recurring payment information, site identifier, 3D Secure details, and transaction method.","properties":{"credentials":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials used for authentication. This is only to be used when processing transactions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PXP ANYpay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" platform."},"children":[]}]}]}],"properties":{"username":{"description":"The username used for authentication."},"password":{"description":"The password used for authentication."}}},"merchant":{"description":"A unique identifier assigned by PXP to represent a merchant entity, such as a store, hotel, or website, within the payment processing system. This identifier is crucial for routing transactions to the correct merchant account, ensuring accurate processing, settlement, and reporting. Merchants receive this value upon registration or integration with PXP, and it must be included in transaction requests to identify the merchant for whom the transaction is being processed.","example":"MERCHANT-1","type":"string","maxLength":20},"site":{"description":"The unique site identifier associated with the transaction. This could represent a physical location, website, or any other distinct entity where the transaction occurs. The value for this field is generated by PXP.","example":"SITE-1","maxLength":20,"type":"string"},"pointOfInteraction":{"description":"The pointOfInteraction object captures detailed information about the device and environment where a card present transaction takes place. It includes various attributes that help identify and describe the capabilities and configurations of the point of sale (POS) device.","properties":{"pointOfSaleId":{"type":"string","description":"\"A PXP unique identifier for the specific point of sale device, often assigned by the merchant or payment processor.\"\n","example":"ACME-001","maxLength":20},"language":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"ISO 639-1 language code representing the display language.\""},"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"},"storeAndForwardType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store and Forward is a mechanism used for handling transactions when the merchant's 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"},"invokeKeyed":{"description":"Indicates whether the merchant wants to initiate a keyed transaction on the device. Keyed transactions involve manually entering the card details on the point of sale (POS) device.","type":"boolean","example":true,"default":false}}},"merchantTransactionId":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50},"merchantTransactionDate":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"},"amounts":{"description":"Details of the amount including transaction, gratuity, and service charge values and its associated currency. Note that gratuity and serviceCharge cannot be sent together.","type":"object","required":["currencyCode","transaction"],"properties":{"currencyCode":{"description":"Denotes the currency code associated with the transaction, conforming to the ISO 4217 standard. This three-character code specifies the currency in which the transaction is processed, ensuring clarity and consistency across international transactions.","example":"EUR","type":"string","minLength":3,"maxLength":3},"transaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the amount of the transaction. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent, for example, GBP 1.234, or if a decimal is supplied when the currencyCode of exponent does not require it, for example, JPY 1.0."},"children":[]}]}]}],"example":30.32,"type":"number"},"gratuity":{"$ref":"#/components/schemas/gratuity"},"serviceCharge":{"$ref":"#/components/schemas/serviceCharge"}}},"transactionMethod":{"description":"The transaction method provides comprehensive details about the intent, capture method, and origin of a transaction.","properties":{"entryType":{"description":"Specifies the environment and method by which the transaction is initiated, reflecting the nature of the transaction's origin. This classification is crucial for applying the appropriate security measures and compliance standards. The entry types include 'Ecom' for online transactions, 'Moto' for mail order/telephone order transactions, and 'Instore' for physical retail environments, each representing different transaction contexts and risk profiles.","type":"string","enum":["Instore","Moto"],"example":"Instore"},"fundingType":{"description":"Specifies the method of payment used to fund the transaction. This field categorises the transaction by the payment medium, enabling tailored processing rules and security measures for each type. Understanding the funding type is crucial for processing the transaction correctly and ensuring compatibility with your  capabilities.","type":"string","enum":["Card"],"example":"Card"},"intent":{"description":"The purpose or action of the transaction, indicating the intended money flow direction. This field is crucial for categorizing the transaction type and guiding the processing logic accordingly. Options include 'Authorisation' for reserving funds on the customer's payment method and 'Purchase' for immediate fund capture following authorisation. Each intent dictates a specific transaction flow and affects how the transaction is handled by the system.","type":"string","enum":["Authorisation","EstimatedAuthorisation","Purchase","Refund","Verification"],"example":"Authorisation"}},"type":"object","required":["entryType","fundingType","intent"]}},"required":["merchant","site","merchantTransactionId","merchantTransactionDate","amounts","transactionMethod"],"type":"object"},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"description":"The transactionResponse 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.","properties":{"state":{"description":"The current state of the transaction.","enum":["Authorised","Captured","Cancelled","Error","Refused"],"example":"Authorised","type":"string"},"stateData":{"$ref":"#/components/schemas/stateData"},"approvalCode":{"description":"A unique identifier code provided by the authorizing entity, indicating approval or reference for the transaction. This code typically consists of alphanumeric characters, starting with an uppercase letter, and serves as a key reference for authorisation verification.","example":"A123456","type":"string","pattern":"^[A-Z]"},"merchantTransactionDate":{"description":"Specifies the date and time when the transaction was initiated by the merchant. This timestamp is crucial for tracking the transaction throughout its lifecycle and for chronological order analysis. The date and time format follows the ISO 8601 standard, ensuring consistency and ease of interpretation in global contexts. It facilitates the accurate and precise logging of transaction initiation times, aiding in transaction management and reconciliation processes between the merchant and PXP.","type":"string","format":"date-time","example":"2021-10-27 08:51:02.826445+00:00"},"merchantTransactionId":{"description":"Represents a unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle.","example":"This_is_my_merchant_transaction_id","type":"string","maxLength":50},"systemTransactionId":{"description":"The system transaction Id is 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","minimum":36,"maximum":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"providerTransactionId":{"type":"string","description":"A unique identifier assigned by the financial service provider for the transaction. It facilitates tracking, reconciliation, and support processes."},"fundingData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data specifying the payment method used for the transaction. It includes essential information about a card involved in a transaction, such as its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling you to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schemeToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"maskedPrimaryAccountNumber":{"description":"The card's primary account number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"463242******1234"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry month [MM] of the card."},"children":[]}]}]}],"type":"string","example":"12"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the expiry year [YYYY] of the card."},"children":[]}]}]}],"type":"string","example":"2026"},"cardScheme":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"},"gatewayTokenId":{"description":"The gateway token Id represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"},"pointOfInteraction":{"description":"Details about the point of interaction where the transaction took place.","type":"object","properties":{"entryType":{"description":"The method by which the card information was entered during the transaction.","type":"string","example":"Contactless","enum":["ChipAndPin","ChipAndSignature","Contactless","ContactlessScaRetry","Swiped","KeyEntry","FallbackToSwipe"]}}},"emvDataResponse":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}},"providerResponse":{"description":"The response from the payment provider containing details about the transaction processing outcome.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"},"issuerResponseCode":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"}}}}}},"type":"object"},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"description":"Indicates a client-side error where the request could not be processed due to malformed syntax, invalid data, or missing information. This response is used across different transaction methods such as cards, APMs, bank transfers, and wallets, signaling the need for the requester to modify their input. It encompasses errors ranging from incorrect field formats to missing required parameters.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0003","errorReason":"Invalid Card Details Provided"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"description":"This response denotes an unauthorized request due to failed authentication or missing credentials, applicable across various payment methods. It suggests the system cannot verify the requester's identity or validate the transaction's legitimacy, necessitating authentication details or proper credentials.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0004","errorReason":"Authentication Failed for Card Transaction"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"description":"Signifies a request is understood but refused by the server, often due to insufficient permissions or access rules. This generic error is relevant for all transaction types, indicating the action requested by the user is forbidden despite successful authentication.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0005","errorReason":"Transaction Not Permitted"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"description":"Occurs when the server can find no match for the requested resource, applicable to any transaction type. This response indicates the specified resource, whether it be transaction details, user information, or other data, does not exist or cannot be found.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0006","errorReason":"Card Transaction Details Not Found"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"description":"Indicates that the server refuses to process the request because the request payload is larger than the server is willing or able to process. This error is applicable across all transaction types, signaling that the data submitted exceeds the maximum allowed size. Clients should reduce the size of their request before retrying. This response helps maintain efficient processing and prevents overloading the server with excessive data.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"TOK0004","errorReason":"Token Request Payload Too Large"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"description":"Signifies that the server understands the content type of the request and the syntax is correct, but it cannot process the contained instructions. This response is particularly relevant when validating request fields across various transaction methods, including cards, APMs, bank transfers, and wallets, where specific field values do not meet the expected formats or logical validations. It prompts a review and correction of the submitted data to align with the required standards or constraints.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"CAR0010","errorReason":"Invalid Transaction Data Format"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"description":"Represents a generic error response indicating an internal server error. This response is used when the server encounters an unexpected condition that prevents it from fulfilling the request, which could range from temporary server malfunctions to more complex issues within the server's processing of specific transactions. It signals that the problem lies with the server's internal operations rather than the request itself. This type of error requires server-side investigation and potentially corrective action to resolve the underlying issue.","example":{"correlationId":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","details":[],"errorCode":"GEN0008","errorReason":"Unexpected Internal Error"},"properties":{"correlationId":{"description":"A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string"},"details":{"description":"TBC","example":["''$.site - The site field is required."],"items":{},"type":"array"},"errorCode":{"description":"This is the error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string"},"errorReason":{"description":"This is the error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string"}},"type":"object"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","minimum":36,"maximum":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"description":"The modification request contains details required to perform a modification on a transaction, such as a refund, increment, void, or capture.","required":["merchant","site","merchantTransactionId","merchantTransactionDate","systemTransactionId","operation","offerDcc","amounts"],"properties":{"amounts":{"description":"Details of the amount including transaction and gratuity values and its associated currency.","type":"object","required":["transaction","currencyCode"],"properties":{"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"transaction":{"$ref":"#/components/schemas/transaction"},"gratuity":{"$ref":"#/components/schemas/gratuity"},"serviceCharge":{"$ref":"#/components/schemas/serviceCharge"}}},"merchant":{"$ref":"#/components/schemas/merchant"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"operation":{"description":"The operation to be applied to the previous transaction. This field specifies actions such as refund, void, capture, or incremental adjustments to a transaction.","enum":["Capture","FinalCapture","Incremental","Refund","Void"],"example":"Capture","type":"string"},"site":{"$ref":"#/components/schemas/site"},"offerDcc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to offer Dynamic Currency Conversion to the customer during the transaction. Note: This is primarily used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations but is no longer actively supported."},"children":[]}]}]}],"type":"boolean","example":false},"systemTransactionId":{"type":"string","description":"The system transaction identifier from the original transaction that is being modified.","example":"SYS-ABC123-ORIG"},"statusCallbackUrl":{"$ref":"#/components/schemas/statusCallbackUrl"},"merchantDeeplink":{"type":"string","format":"uri","description":"A custom URI scheme that allows the merchant's mobile app to handle payment callbacks. When provided, the payment terminal or SDK will use this deeplink to redirect users back to the merchant's app after the transaction is completed.","example":"myapp://payment/callback"}},"type":"object"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"description":"The modifications response provides details about the state of a transaction modification request, including the state itself, any additional state details, and relevant transaction, funding data, and provider information.","properties":{"state":{"description":"The current state of the transaction.","enum":["Authorised","Captured","Cancelled","Error","Refused"],"example":"Authorised","type":"string"},"stateData":{"$ref":"#/components/schemas/stateData"},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"fundingData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data specifying the payment method used for the transaction. It includes essential information about a card involved in a transaction, such as its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling you to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schemeToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"maskedPrimaryAccountNumber":{"description":"The card's primary account number (PAN) masked for security, typically showing only the last four digits.","type":"string","example":"463242******1234"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month of the card ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","example":"12"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year of the card ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","example":"2026"},"cardScheme":{"description":"The payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"},"gatewayTokenId":{"description":"The gateway token ID represents a securely stored token that corresponds to a previously saved payment card. This token is generated and maintained by PXP to facilitate recurring transactions or transactions using stored card details, ensuring enhanced security and convenience. When a transaction is performed with a saved card, this token Id should be provided instead of the full card details. This approach enhances security by reducing the exposure of sensitive card information and simplifies the transaction process for returning customers.\"","example":"2357e042-2bf0-4886-8d9d-718fa5909761","maxLength":36,"minLength":36,"type":"string"},"pointOfInteraction":{"description":"Details about the point of interaction where the transaction took place.","type":"object","properties":{"entryType":{"description":"The method by which the card information was entered during the transaction.","type":"string","example":"Contactless","enum":["ChipAndPin","ChipAndSignature","Contactless","ContactlessScaRetry","Swiped","KeyEntry","FallbackToSwipe"]}}},"emvDataResponse":{"description":"Response containing EMV (Europay, MasterCard, and Visa) data from a payment transaction.","type":"object","properties":{"applicationId":{"description":"A unique identifier for the application used during the EMV transaction.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"The label or name of the application selected for the transaction, typically representing the card brand.","type":"string","example":"VISA CREDIT"},"authorisationResponseCode":{"description":"The response code indicating the outcome of the authorisation request.","type":"string","example":"00"},"cardHolderVerificationMethodResults":{"description":"The results of the Cardholder Verification Method (CVM) used in the transaction, such as PIN verification or signature.","type":"string","enum":["Pin verified","Signature verified","No CVM required"]},"panSequenceNumber":{"description":"The sequence number that differentiates cards with the same Primary Account Number (PAN) issued to the same account holder.","type":"string","example":"01"},"preferredName":{"description":"The preferred name of the application as displayed on the terminal during the transaction.","type":"string","example":"Visa"}}},"providerResponse":{"description":"The response from the payment provider containing details about the transaction processing outcome.","properties":{"provider":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"terminalId":{"$ref":"#/components/schemas/providerResponseTerminalId"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"},"merchantAdvice":{"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 categorizes 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"},"settlementDate":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for MasterCard payments. This field is applicable and provided only for transactions processed using MasterCard. The settlement date is crucial for financial reconciliation and is formatted as an ISO 8601 timestamp.","example":"2024-01-25T00:00:00Z"},"issuerResponseCode":{"type":"string","description":"A two-character code that indicates the result of the transaction authorisation.","example":"00"}}}}},"dccData":{"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":{"dccSelectedIndicator":{"type":"string","enum":["NotSelected","Selected","ErrorRetrievingDccData","DccNotEligible","InvalidDccTerminalId","InvalidDccMerchantId","NoDccSupported","NoDccRateAvailable","ServerErrorRetrievingDccData","InvalidDccRequest","DccTimeout"],"description":"The DCC selection state indicating whether DCC was selected, not selected, or unavailable due to an error or eligibility issue.","example":"Selected"},"amounts":{"type":"object","description":"Details about the transaction amount in the local currency and the cardholder's currency.","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":"number","description":"The exchange rate used for the DCC conversion.","example":0.855},"markupRate":{"type":"number","description":"The markup rate applied to the DCC transaction.","example":3.92,"nullable":true},"disclaimer":{"$ref":"#/components/schemas/disclaimer"},"providerData":{"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},"merchantId":{"$ref":"#/components/schemas/dccProviderMerchantId"},"terminalId":{"$ref":"#/components/schemas/dccProviderTerminalId"},"markupTextIndicator":{"type":"integer","description":"The markup text indicator for the DCC provider.","example":1,"nullable":true}}}}}},"required":["state"]},"id":"schema_132"}},"exampleStore":{"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"POS_001","merchantTransactionDate":"2025-01-27 08: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.204.43:5000/statuspacket","merchantDeeplink":"myapp://payment/callback"},"key":"Card authorisation","summary":"Card authorisation","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"POS_001","merchantTransactionDate":"2025-01-27 08: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.204.43:5000/statuspacket"},"key":"Card authorisation (with gratuity)","summary":"Card authorisation (with gratuity)","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with gratuity)"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"POS_001","merchantTransactionDate":"2025-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR","serviceCharge":{"amount":10,"percentage":10}},"transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card authorisation (with service charge)","summary":"Card authorisation (with service charge)","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation (with service charge)"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card estimated authorisation","summary":"Card estimated authorisation","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card purchase","summary":"Card purchase","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"COF_Purchase_001","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":45.5,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"},"recurring":{"processingModel":"cardOnFileShopperConsent"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card purchase with card-on-file consent","summary":"Card purchase with card-on-file consent","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card purchase with card-on-file consent"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"Recurring_EstAuth_001","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":50,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"},"recurring":{"processingModel":"merchantInitiatedInitialRecurring"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card estimated authorisation with initial recurring (Instore)","summary":"Card estimated authorisation with initial recurring (Instore)","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card estimated authorisation with initial recurring (Instore)"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":true},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"COF_MOTO_Auth_001","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":75,"currencyCode":"GBP"},"transactionMethod":{"intent":"Authorisation","entryType":"Moto","fundingType":"Card"},"recurring":{"processingModel":"cardOnFileShopperConsent"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card authorisation with card-on-file consent (Moto)","summary":"Card authorisation with card-on-file consent (Moto)","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card authorisation with card-on-file consent (Moto)"},"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"StandaloneRefund","entryType":"Instore","fundingType":"Card"},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket"},"key":"Card refund","summary":"Card refund","id":"paths/~1pos-transactions/post/requestBody/content/application~1json/examples/Card refund"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"460070","merchantTransactionDate":"2025-11-14T16:07:40.974520+07:00","merchantTransactionId":"KD_141125_24","systemTransactionId":"375421d2-326d-4df9-8324-98772991f41a","providerTransactionId":"PROV-98765","fundingData":{"maskedPrimaryAccountNumber":"541333******0078","expiryMonth":"12","expiryYear":"2025","cardScheme":"MasterCard","gatewayTokenId":"91889084-9611-4774-a02a-63a8d25116fc","pointOfInteraction":{"entryType":"ChipAndPin"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"MASTERCARD","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"MASTERCARD"},"providerResponse":{"provider":"Unity","code":"00","message":"Approved","merchantId":"MERCHANT001","terminalId":"CASTLES001","paymentAccountReference":"PAR123456789","schemeTransactionId":"SCHEME-TXN-001","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-001","merchantAdvice":{"code":"","message":""},"settlementDate":"2025-11-14T00:00:00Z"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"dccData":{}},"key":"Card authorised","summary":"Card authorised","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"460070","merchantTransactionDate":"2025-11-14T16:07:40.974520+07:00","merchantTransactionId":"KD_141125_24","systemTransactionId":"375421d2-326d-4df9-8324-98772991f41a","providerTransactionId":"PROV-98766","fundingData":{"maskedPrimaryAccountNumber":"541333******0078","expiryMonth":"12","expiryYear":"2025","cardScheme":"MasterCard","gatewayTokenId":"91889084-9611-4774-a02a-63a8d25116fc","pointOfInteraction":{"entryType":"ChipAndPin"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"MASTERCARD","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"MASTERCARD"},"providerResponse":{"provider":"Unity","code":"00","message":"Approved","merchantId":"MERCHANT001","terminalId":"CASTLES001","paymentAccountReference":"PAR123456789","schemeTransactionId":"SCHEME-TXN-002","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-002","merchantAdvice":{"code":"","message":""},"settlementDate":"2025-11-14T00:00:00Z"}},"amounts":{"transaction":30.32,"currencyCode":"EUR","gratuity":5.01},"dccData":{}},"key":"Card authorised (with gratuity)","summary":"Card authorised (with gratuity)","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with gratuity)"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchantTransactionDate":"2025-12-02T14:30:00Z","merchantTransactionId":"SALE-POS-001","systemTransactionId":"TXN-ABC123-XYZ789","providerTransactionId":"PROV-98765","amounts":{"transaction":100,"currencyCode":"EUR","gratuity":5},"fundingData":{"maskedPrimaryAccountNumber":"************1234","expiryMonth":"12","expiryYear":"25","cardScheme":"VISA","gatewayTokenId":"TOKEN-123456","pointOfInteraction":{"entryType":"ChipAndPin"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"VISA DEBIT","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"VISA DEBIT"},"providerResponse":{"provider":"Unity","code":"00","message":"Approved","merchantId":"MERCHANT001","terminalId":"CASTLES001","paymentAccountReference":"PAR123456789","schemeTransactionId":"SCHEME-TXN-001","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-001","merchantAdvice":{"code":"","message":""},"settlementDate":"2025-12-02T00:00:00Z"}},"dccData":{"exchangeRate":1.2345,"markupRate":3.5,"rateSelectedIndicator":"Selected","amount":{"cardholder":{"currencyCode":"USD","transaction":123.45},"local":{"currencyCode":"GBP","transaction":100}},"disclaimer":"Exchange rate includes markup","providerData":{"provider":"DCC Provider"}}},"key":"Card authorised (with DCC)","summary":"Card authorised (with DCC)","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card authorised (with DCC)"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused":{"value":{"state":"Refused","stateData":{"code":"CRD100","message":"Do not honour"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerResponse":{"provider":"PXPFinancial","code":"05","message":"Do not honour","merchantId":"77772182","emvDataResponse":{"authorisationResponseCode":"8A","issuerAuthenticationData":"","issuerScriptTemplate1":"","issuerScriptTemplate2":""},"merchantAdvice":{"code":"01","message":"New account information available"}}},"amounts":{"gratuity":0}},"key":"Card refused","summary":"Card refused","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card refused"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"},"amounts":{"gratuity":0}},"key":"Card error (general)","summary":"Card error (general)","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (general)"},"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"},"amounts":{"gratuity":0}},"key":"Card error (communication timeout)","summary":"Card error (communication timeout)","id":"paths/~1pos-transactions/post/responses/200/content/application~1json/examples/Card error (communication timeout)"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Authorisation","summary":"Instore Card Authorisation","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)":{"value":{"credentials":{"username":"testusername","password":"testpassword"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Authorisation (Legacy)","summary":"Instore Card Authorisation (Legacy)","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Authorisation (Legacy)"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Estimated Authorisation","summary":"Instore Card Estimated Authorisation","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)":{"value":{"credentials":{"username":"testusername","password":"testpassword"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"EstimatedAuthorisation","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Estimated Authorisation (Legacy)","summary":"Instore Card Estimated Authorisation (Legacy)","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Estimated Authorisation (Legacy)"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Purchase","summary":"Instore Card Purchase","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)":{"value":{"credentials":{"username":"testusername","password":"testpassword"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Purchase","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Purchase (Legacy)","summary":"Instore Card Purchase (Legacy)","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Purchase (Legacy)"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Refund","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Refund","summary":"Instore Card Refund","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)":{"value":{"credentials":{"username":"testusername","password":"testpassword"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Refund","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Refund (Legacy)","summary":"Instore Card Refund (Legacy)","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Refund (Legacy)"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification":{"value":{"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"en","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Verification","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Verification","summary":"Instore Card Verification","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification"},"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)":{"value":{"credentials":{"username":"testusername","password":"testpassword"},"pointOfInteraction":{"pointOfSaleId":"POS-1","language":"EN","storeAndForwardType":"None","invokeKeyed":false},"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","amounts":{"transaction":30.32,"currencyCode":"EUR"},"transactionMethod":{"intent":"Verification","entryType":"Instore","fundingType":"Card"}},"key":"Instore Card Verification (Legacy)","summary":"Instore Card Verification (Legacy)","id":"paths/~1pos-transactions~1legacy/post/requestBody/content/application~1json/examples/Instore Card Verification (Legacy)"},"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised":{"value":{"state":"Authorised","approvalCode":"123456","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","emvDataResponse":{"authorisationResponseCode":"8A","issuerAuthenticationData":"","issuerScriptTemplate1":"","issuerScriptTemplate2":""},"paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649"}},"amounts":{"gratuity":0}},"key":"Instore Card Authorised","summary":"Instore Card Authorised","id":"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Authorised"},"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused":{"value":{"state":"Refused","stateData":{"code":"CRD100","message":"Do not honour"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerResponse":{"provider":"PXPFinancial","code":"05","message":"Do not honour","merchantId":"77772182","emvDataResponse":{"authorisationResponseCode":"8A","issuerAuthenticationData":"","issuerScriptTemplate1":"","issuerScriptTemplate2":""},"merchantAdvice":{"code":"01","message":"New account information available"}}},"amounts":{"gratuity":0}},"key":"Instore Card Refused","summary":"Instore Card Refused","id":"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Refused"},"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"},"amounts":{"gratuity":0}},"key":"Instore Card Error (General)","summary":"Instore Card Error (General)","id":"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (General)"},"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Instore Card Error (Communication Timeout)","summary":"Instore Card Error (Communication Timeout)","id":"paths/~1pos-transactions~1legacy/post/responses/200/content/application~1json/examples/Instore Card Error (Communication Timeout)"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","systemTransactionId":"SYS-ABC123-ORIG","operation":"Refund","offerDcc":false,"amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Refund","summary":"Refund","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Refund"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"MOD-20251203-001","merchantTransactionDate":"2025-12-03T11:00:00Z","systemTransactionId":"SYS-ABC123-ORIG","operation":"Capture","offerDcc":false,"amounts":{"currencyCode":"EUR","transaction":45,"gratuity":0,"serviceCharge":{"amount":2.5,"percentage":5}},"statusCallbackUrl":"http://192.168.204.43:5000/statuspacket","merchantDeeplink":"myapp://payment/callback"},"key":"Capture","summary":"Capture","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Capture"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id_1","merchantTransactionDate":"2024-01-27T08:51:02.826Z","systemTransactionId":"SYS-ABC123-ORIG","operation":"FinalCapture","offerDcc":false,"amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Final capture","summary":"Final capture","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Final capture"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id_1","merchantTransactionDate":"2024-01-27T08:51:02.826Z","systemTransactionId":"SYS-ABC123-ORIG","operation":"Incremental","offerDcc":false,"amounts":{"currencyCode":"EUR","transaction":1}},"key":"Incremental","summary":"Incremental","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Incremental"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id_1","merchantTransactionDate":"2024-01-27T08:51:02.826Z","systemTransactionId":"SYS-ABC123-ORIG","operation":"Void","offerDcc":false,"amounts":{"currencyCode":"EUR","transaction":30.32}},"key":"Void","summary":"Void","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Void"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)":{"value":{"state":"Captured","stateData":{"code":"CRD000","message":"Transaction captured successfully"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27T08:51:02.826Z","fundingData":{"maskedPrimaryAccountNumber":"************1234","cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Contactless"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"VISA DEBIT","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"","panSequenceNumber":"01","preferredName":"VISA DEBIT"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"TERM001","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"","merchantAdvice":{"code":"","message":""},"settlementDate":"2024-01-27T00:00:00Z"}}},"key":"Capture (Captured)","summary":"Capture (Captured)","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Incremental authorisation approved"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27T08:51:02.826Z","fundingData":{"maskedPrimaryAccountNumber":"************5678","cardScheme":"Visa","expiryMonth":"06","expiryYear":"2026","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"ChipAndPin"},"emvDataResponse":{"applicationId":"A0000000041010","applicationLabel":"VISA CREDIT","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"1F0302","panSequenceNumber":"01","preferredName":"VISA CREDIT"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"TERM002","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-INC-001","merchantAdvice":{"code":"","message":""},"settlementDate":"2024-01-27T00:00:00Z"}}},"key":"Incremental (Authorised)","summary":"Incremental (Authorised)","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Refund approved"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27T08:51:02.826Z","fundingData":{"maskedPrimaryAccountNumber":"************9012","cardScheme":"Visa","expiryMonth":"03","expiryYear":"2027","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"Contactless"},"emvDataResponse":{"applicationId":"A0000000031010","applicationLabel":"VISA DEBIT","authorisationResponseCode":"00","cardHolderVerificationMethodResults":"","panSequenceNumber":"01","preferredName":"VISA DEBIT"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"TERM003","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-REF-001","merchantAdvice":{"code":"","message":""},"settlementDate":"2024-01-27T00:00:00Z"}}},"key":"Refund (Authorised)","summary":"Refund (Authorised)","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)"},"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)":{"value":{"state":"Cancelled","stateData":{"code":"CRD000","message":"Transaction voided successfully"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27T08:51:02.826Z","fundingData":{"maskedPrimaryAccountNumber":"************3456","cardScheme":"Visa","expiryMonth":"09","expiryYear":"2028","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","pointOfInteraction":{"entryType":"ChipAndPin"},"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":"TERM004","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649","issuerResponseCode":"00","schemeTransactionLinkId":"LINK-VOID-001","merchantAdvice":{"code":"","message":""},"settlementDate":"2024-01-27T00:00:00Z"}}},"key":"Void (Authorised)","summary":"Void (Authorised)","id":"paths/~1pos-transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"}},"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"}},"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/point-of-sale-transaction","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/point-of-sale-transaction.json?download"},{"url":"/_bundle/apis/point-of-sale-transaction.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"POS transaction service API","description":"This is an API reference for the Point of Sale transaction service."}},"baseSlug":"/apis/point-of-sale-transaction","routesMapping":{}}