{"items":[{"type":"link","label":"Transactions service","link":"/apis/transaction","routeSlug":"/apis/transaction","content":{"contentType":"overview","meta":{"name":"Transactions service"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"transaction.json","url":"/_bundle/apis/transaction.json?download"},{"kind":"download","label":"transaction.yaml","url":"/_bundle/apis/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":"Transactions service (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the Transaction service API."}],"sectionId":"/apis/transaction"}],"sectionId":"/apis/transaction"}]}]}},{"label":"Initiate a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/initiate-a-transaction","routeSlug":"/apis/transaction/other/initiate-a-transaction","metadata":{"seo":{"title":"Initiate a transaction","description":"The /transactions endpoint enables the initiation of transactions, supporting various transaction methods, including card and alternative payments. It facilitates authoristions, tokenisation, recurring payments, and incorporates security enhancements, offering a versatile solution for payment processing across both online and instore."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate-a-transaction","name":"Initiate a transaction","isWebhook":false,"pointer":"/paths/~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a 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":"/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint enables the initiation of transactions, supporting various transaction methods, including card and alternative payments. It facilitates authoristions, tokenisation, recurring payments, and incorporates security enhancements, offering a versatile solution for payment processing across both online and instore."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"]}},"schemaId":"schema_142","exampleIds":["paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"],"pointer":"/paths/~1transactions/post/requestBody","description":"Initiate a transaction"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/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":[],"requestBody":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"]}},"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/transactions","href":"other/initiate-a-transaction","openApiOperationId":"initiate-a-transaction","summary":"Initiate a 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_142","exampleIds":["paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)","paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)","paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"]}},"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_143","exampleIds":["paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)","paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)"]}},"schemaId":"schema_143","exampleIds":["paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)","paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}},"schemaId":"components/schemas/inline_response_400"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}},"schemaId":"components/schemas/inline_response_401"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}},"schemaId":"components/schemas/inline_response_403"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}},"schemaId":"components/schemas/inline_response_404"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}},"schemaId":"components/schemas/inline_response_413"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}},"schemaId":"components/schemas/inline_response_422"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}},"schemaId":"components/schemas/inline_response_500"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}},"schemaId":"schema_144"}],"pointer":"/paths/~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_143","exampleIds":["paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)","paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143","exampleIds":["paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)","paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)","paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)"]}}},{"code":"400","schemaId":"components/schemas/inline_response_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}}},{"code":"401","schemaId":"components/schemas/inline_response_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}}},{"code":"403","schemaId":"components/schemas/inline_response_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}}},{"code":"404","schemaId":"components/schemas/inline_response_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}}},{"code":"413","schemaId":"components/schemas/inline_response_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}}},{"code":"422","schemaId":"components/schemas/inline_response_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}}},{"code":"500","schemaId":"components/schemas/inline_response_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}}},{"code":"default","schemaId":"schema_144","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/initiate-a-transaction"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Create a modification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/modify-a-transaction","routeSlug":"/apis/transaction/other/modify-a-transaction","metadata":{"seo":{"title":"Create a modification","description":"Process modifications on previously initiated transactions. Supported operations include captures, refunds, incremental authorisations, and voids. This endpoint returns a unique reference for the modification request, allowing for easy tracking and reconciliation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"modify-a-transaction","name":"Create a modification","isWebhook":false,"pointer":"/paths/~1transactions~1{systemTransactionId}~1modifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a modification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Process modifications on previously initiated transactions. Supported operations include captures, refunds, incremental authorisations, and voids. This endpoint 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_145","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.  Always use the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned for an authorisation or purchase if you want to perform an increment, capture, refund, or void. This ensures that the correct transaction is referenced for any subsequent operations."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transactions~1{systemTransactionId}~1modifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"]}},"schemaId":"schema_146","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"],"pointer":"/paths/~1transactions~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":"/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_145","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_146","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"]}},"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/transactions/{systemTransactionId}/modifications","href":"other/modify-a-transaction","openApiOperationId":"modify-a-transaction","summary":"Create a 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_146","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund","paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"]}},"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_147","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)"]}},"schemaId":"schema_147","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}},"schemaId":"components/schemas/inline_response_400"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}},"schemaId":"components/schemas/inline_response_403"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}},"schemaId":"components/schemas/inline_response_404"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}},"schemaId":"components/schemas/inline_response_413"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}},"schemaId":"schema_144"}],"pointer":"/paths/~1transactions~1{systemTransactionId}~1modifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147","exampleIds":["paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)","paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)"]}}},{"code":"400","schemaId":"components/schemas/inline_response_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}}},{"code":"401","schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}}},{"code":"403","schemaId":"components/schemas/inline_response_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}}},{"code":"404","schemaId":"components/schemas/inline_response_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}}},{"code":"413","schemaId":"components/schemas/inline_response_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}}},{"code":"422","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}},{"code":"500","schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_150"}}},{"code":"default","schemaId":"schema_144","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_144"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/modify-a-transaction"}],"panels":[]}]},"httpPath":"/transactions/{systemTransactionId}/modifications"},{"label":"Get transaction details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/get-transaction-details","routeSlug":"/apis/transaction/other/get-transaction-details","metadata":{"seo":{"title":"Get transaction details","description":"Looks up a transaction by identifier. Provide at least one of merchantTransactionId or systemTransactionId. The response is a JSON array containing zero or one transaction object. This endpoint isn't a list or search API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-transaction-details","name":"Get transaction details","isWebhook":false,"pointer":"/paths/~1transactions~1{merchant}~1{site}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks up a transaction by identifier. Provide at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response is a JSON array containing zero or one transaction object. This endpoint isn't a list or search API."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant","in":"path","schemaId":"schema_151","description":"The unique merchant identifier associated with the transaction, as assigned by PXP.","required":true},{"name":"site","in":"path","schemaId":"schema_152","description":"The unique site identifier associated with the transaction, as assigned by PXP.","required":true}],"pointer":"/paths/~1transactions~1{merchant}~1{site}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"merchantTransactionId","in":"query","schemaId":"schema_153","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier that you assigned to this transaction. Required for lookup unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"systemTransactionId","in":"query","schemaId":"schema_154","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier assigned to this transaction by PXP. Required for lookup unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"fundingType","in":"query","schemaId":"schema_155","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The funding type used for the transaction. Use this with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apmProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when looking up pay-by-bank transactions."},"children":[]}]}]}],"required":true},{"name":"apmProvider","in":"query","schemaId":"schema_156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alternative payment method (APM) provider for pay-by-bank transactions. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aeropay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when looking up pay-by-bank transactions."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions~1{merchant}~1{site}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{merchant}/{site}","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":"merchant","in":"path","required":true,"example":"MERCHANT-1","schemaId":"components/schemas/merchant"},{"name":"site","in":"path","required":true,"example":"SITE-1","schemaId":"components/schemas/site"}],"query":[{"name":"merchantTransactionId","in":"query","required":false,"example":"This_is_my_merchant_transaction_id","schemaId":"components/schemas/merchantTransactionId"},{"name":"systemTransactionId","in":"query","required":false,"example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemaId":"components/schemas/systemTransactionId"},{"name":"fundingType","in":"query","required":true,"example":"Card","schemaId":"components/schemas/fundingType"},{"name":"apmProvider","in":"query","required":false,"example":"Aeropay","schemaId":"components/schemas/apmProvider"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/transactions/{merchant}/{site}","href":"other/get-transaction-details","openApiOperationId":"get-transaction-details","summary":"Get transaction details"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction lookup result. Returns an array with zero or one item.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157","exampleIds":["paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)"]}},"schemaId":"schema_157","exampleIds":["paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}},"schemaId":"components/schemas/inline_response_400"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}},"schemaId":"components/schemas/inline_response_401"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}},"schemaId":"components/schemas/inline_response_403"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}},"schemaId":"components/schemas/inline_response_404"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}},"schemaId":"components/schemas/inline_response_413"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}},"schemaId":"components/schemas/inline_response_422"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}},"schemaId":"components/schemas/inline_response_500"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1transactions~1{merchant}~1{site}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_157","exampleIds":["paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157","exampleIds":["paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)","paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)"]}}},{"code":"400","schemaId":"components/schemas/inline_response_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}}},{"code":"401","schemaId":"components/schemas/inline_response_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}}},{"code":"403","schemaId":"components/schemas/inline_response_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}}},{"code":"404","schemaId":"components/schemas/inline_response_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}}},{"code":"413","schemaId":"components/schemas/inline_response_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}}},{"code":"422","schemaId":"components/schemas/inline_response_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}}},{"code":"500","schemaId":"components/schemas/inline_response_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-transaction-details"}],"panels":[]}]},"httpPath":"/transactions/{merchant}/{site}"},{"label":"Get order details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/transaction/other/get-order-details","routeSlug":"/apis/transaction/other/get-order-details","metadata":{"seo":{"title":"Get order details","description":"Get order details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order-details","name":"Get order details","isWebhook":false,"pointer":"/paths/~1transactions~1{merchant}~1{site}~1order-details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant","in":"path","schemaId":"schema_158","description":"Your unique merchant identifier, as assigned by PXP.","required":true},{"name":"site","in":"path","schemaId":"schema_159","description":"Your unique site identifier, as assigned by PXP.","required":true}],"pointer":"/paths/~1transactions~1{merchant}~1{site}~1order-details/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fundingType","in":"query","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The funding type used for this transaction. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"required":true},{"name":"systemTransactionId","in":"query","schemaId":"schema_161","description":"The unique identifier assigned to this transaction by PXP.","required":true}],"pointer":"/paths/~1transactions~1{merchant}~1{site}~1order-details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{merchant}/{site}/order-details","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":"merchant","in":"path","required":true,"example":"MERCHANT-1","schemaId":"schema_158"},{"name":"site","in":"path","required":true,"example":"SITE-1","schemaId":"schema_159"}],"query":[{"name":"fundingType","in":"query","required":true,"example":"paypal","schemaId":"schema_160"},{"name":"systemTransactionId","in":"query","required":true,"example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemaId":"schema_161"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","413","422","500","default"],"pointer":"/transactions/{merchant}/{site}/order-details","href":"other/get-order-details","openApiOperationId":"get-order-details","summary":"Get order details"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}},"schemaId":"components/schemas/inline_response_400"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}},"schemaId":"components/schemas/inline_response_401"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}},"schemaId":"components/schemas/inline_response_403"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}},"schemaId":"components/schemas/inline_response_404"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}},"schemaId":"components/schemas/inline_response_413"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}},"schemaId":"components/schemas/inline_response_422"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}},"schemaId":"components/schemas/inline_response_500"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1transactions~1{merchant}~1{site}~1order-details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}}},{"code":"400","schemaId":"components/schemas/inline_response_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_400"}}},{"code":"401","schemaId":"components/schemas/inline_response_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_401"}}},{"code":"403","schemaId":"components/schemas/inline_response_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_403"}}},{"code":"404","schemaId":"components/schemas/inline_response_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_404"}}},{"code":"413","schemaId":"components/schemas/inline_response_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_413"}}},{"code":"422","schemaId":"components/schemas/inline_response_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_422"}}},{"code":"500","schemaId":"components/schemas/inline_response_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/inline_response_500"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-order-details"}],"panels":[]}]},"httpPath":"/transactions/{merchant}/{site}/order-details"}],"store":{"schemaStore":{"components/schemas/addressVerification":{"id":"components/schemas/addressVerification","kind":"json-schema","title":"addressVerification","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address verification details, applicable for transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ecom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the entry type. It aids in the validation and fraud prevention process by matching the provided address with the cardholder's address on file."},"children":[]}]}]}],"type":"object","properties":{"countryCode":{"description":"ISO-3166-1 alpha-2 format two-character country code identifying the country associated with the cardholder's address.","example":"GB","type":"string","minLength":2,"maxLength":2},"houseNumberOrName":{"description":"The house number or name associated with the cardholder's address. This field supports up to 100 characters to accommodate various global addressing formats.","example":"10 Downing Street","type":"string","maxLength":100},"postalCode":{"description":"The postal code of the cardholder's address. This field accepts up to 5 digits for US addresses or up to 10 characters for addresses in other countries, accommodating global variations in postal code formats.","example":"SW1A 2AA","type":"string","maxLength":10}},"required":["countryCode","houseNumberOrName","postalCode"],"x-readme-ref-name":"addressVerification"}},"components/schemas/applePayBlob":{"id":"components/schemas/applePayBlob","kind":"json-schema","title":"Apple Pay","data":{"title":"Apple Pay","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay card details for e-commerce transactions. Submit the encrypted payment token from the Apple Pay sheet in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applePayToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". PXP decrypts this server-side during transaction processing, so you don't need to call the wallet decrypt endpoint or provide card number fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you decrypt the token on your backend first using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"apis/wallets/other/decrypt-wallet-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /wallets/ApplePay/decrypt-token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card not present"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" card type instead: provide the decrypted card details and set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApplePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay with decrypted token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request example."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.entryType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ecom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["applePayToken"],"type":"object","properties":{"applePayToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The encrypted payment token returned by Apple Pay on the client device. Submit this value as a JSON string serialisation of the Apple Pay payment token object (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). PXP decrypts this server-side during transaction processing."},"children":[]}]}]}],"example":"{\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{\"ephemeralPublicKey\":\"...\",\"publicKeyHash\":\"...\",\"transactionId\":\"...\"}}","type":"string"},"dynamicDescriptors":{"$ref":"#/components/schemas/dynamicDescriptors"}},"x-readme-ref-name":"applePayBlob"}},"components/schemas/approvalCode":{"id":"components/schemas/approvalCode","kind":"json-schema","title":"approvalCode","data":{"description":"A unique identifier code provided by the authorising entity, indicating approval or reference for the transaction. This code typically consists of numeric characters and serves as a key reference for authorisation verification.","example":"123456","type":"string","x-readme-ref-name":"approvalCode"}},"components/schemas/addressVerificationServiceResult":{"id":"components/schemas/addressVerificationServiceResult","kind":"json-schema","title":"addressVerificationServiceResult","data":{"description":"Indicates the result of the Address Verification System (AVS) check, providing detailed insights into the matching status of the postal code and address provided by the cardholder against the information on file with the card issuer. AVS is a security measure to detect and prevent fraud in card-not-present transactions. The result codes offer granular information on what was matched, partially matched, not matched, or not checked, allowing for a nuanced understanding of the verification outcome.","type":"string","enum":["NoInformationAvailable","PostCodeMatchedAddressMatched","PostCodeMatchedAddressNotMatched","PostCodeMatchedAddressNotChecked","PostCodeNotMatchedAddressMatched","PostCodeNotMatchedAddressNotMatched","PostCodeNotMatchedAddressNotChecked","PostCodeNotCheckedAddressMatched","PostCodeNotCheckedAddressNotMatched","PostCodeNotCheckedAddressNotChecked","PostCodeMatchedAndAddressPartialMatch","PostCodePartialMatchAddressMatched","PostCodePartialMatchAddressPartialMatch","PostCodeNotMatchedAddressPartialMatch","PostCodePartialMatchAddressNotMatched","PostCodePartialMatchAddressNotChecked","PostCodeNotCheckedAddressPartialMatch"],"example":"PostCodeMatchedAddressMatched","x-readme-ref-name":"addressVerificationServiceResult"}},"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 of the amount including transaction, gratuity, and service charge values and its associated currency. 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"],"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,"x-readme-ref-name":"currencyCode"},"transaction":{"$ref":"#/components/schemas/transaction"},"shipping":{"description":"The shipping amount.","type":"number","example":5},"gratuity":{"$ref":"#/components/schemas/gratuity"},"cashback":{"description":"The cashback amount for the authorisation.","type":"number","example":20},"cash":{"description":"The cash amount.","type":"number","example":50},"chip":{"description":"The chip amount.","type":"number","example":25},"cheque":{"description":"The cheque amount.","type":"number","example":100},"winningTicket":{"description":"The winning ticket amount.","type":"number","example":15},"serviceCharge":{"$ref":"#/components/schemas/serviceCharge"}},"x-readme-ref-name":"amounts"}},"components/schemas/modificationAmounts":{"id":"components/schemas/modificationAmounts","kind":"json-schema","title":"modificationAmounts","data":{"description":"Details of the amount including transaction and gratuity values and its associated currency.","type":"object","required":["transaction"],"properties":{"transaction":{"$ref":"#/components/schemas/modificationTransaction"},"gratuity":{"$ref":"#/components/schemas/gratuity"}},"x-readme-ref-name":"modificationAmounts"}},"components/schemas/authenticationId":{"id":"components/schemas/authenticationId","kind":"json-schema","title":"authenticationId","data":{"description":"A unique reference provided by PXP for the authentication request, represented as a GUID.","example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}},"components/schemas/cardHolderAuthenticationVerificationValue":{"id":"components/schemas/cardHolderAuthenticationVerificationValue","kind":"json-schema","title":"cardHolderAuthenticationVerificationValue","data":{"description":"The Cardholder Authentication Verification Value (CAVV) is generated by the card issuer as part of the 3-D Secure authentication process for Visa transactions. It indicates that the cardholder has been authenticated, and it should be appended to the authorisation request. This field can also be used for Apple Pay and Google Pay cryptograms.","example":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","type":"string","x-readme-ref-name":"cardHolderAuthenticationVerificationValue"}},"components/schemas/directoryServerTransactionId":{"id":"components/schemas/directoryServerTransactionId","kind":"json-schema","title":"directoryServerTransactionId","data":{"description":"The 3DS 2.0 transaction identifier returned by the card issuer, unique to each authentication attempt.","example":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b","type":"string"}},"components/schemas/electronicCommerceIndicator":{"id":"components/schemas/electronicCommerceIndicator","kind":"json-schema","title":"electronicCommerceIndicator","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Electronic Commerce Indicator (ECI) specifies the security level of an online transaction and the authentication outcome, crucial for determining liability in the event of a dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with SSL or equivalent but without cardholder authentication (considered less secure, higher risk)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with cardholder authentication (e.g., 3D Secure), indicating a higher level of security."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with 3D Secure authentication, cardholder authenticated successfully (high security)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction attempted 3D Secure authentication but could not be completed; cardholder not authenticated (medium security)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed without 3D Secure authentication, due to issuer or cardholder not participating in 3D Secure (considered less secure, higher risk)."},"children":[]}]}]}]}],"type":"string","example":"05"}},"components/schemas/threeDSecureVersion":{"id":"components/schemas/threeDSecureVersion","kind":"json-schema","title":"threeDSecureVersion","data":{"description":"The version of the 3-D Secure protocol used for the transaction's authentication, as returned by the PSP's Three D Secure Service. This indicates the specific set of 3-D Secure features and security measures applied.","example":"2.1.0","type":"string"}},"components/schemas/threeDSecureTransactionStatus":{"id":"components/schemas/threeDSecureTransactionStatus","kind":"json-schema","title":"threeDSecureTransactionStatus","data":{"description":"The status of the transaction after being authenticated using the 3-D Secure protocol, as provided by the Payment Service Provider (PSP). This indicates the result of the 3-D Secure authentication process.","example":"Y","type":"string"}},"components/schemas/card":{"id":"components/schemas/card","kind":"json-schema","title":"card","data":{"type":"object","oneOf":[{"title":"Apple Pay","$ref":"#/components/schemas/applePayBlob"},{"title":"Card not present","$ref":"#/components/schemas/cardNotPresent"},{"title":"Card present","$ref":"#/components/schemas/cardPresent"},{"title":"Scheme token number","$ref":"#/components/schemas/schemeTokenNumberObject"},{"title":"Scheme token ID","$ref":"#/components/schemas/schemeTokenIdObject"}],"x-readme-ref-name":"card"}},"components/schemas/cardNotPresent":{"id":"components/schemas/cardNotPresent","kind":"json-schema","title":"Card not present","data":{"title":"Card not present","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This card type encompasses the card details needed to process a remote (card-not-present) transaction, including the primary account number, expiry date, card verification code (CVC), holder name, and an optional gateway token ID for stored cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For digital wallets where you have already decrypted the token on your backend, use this card type and set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"apis/wallets/other/decrypt-wallet-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /wallets/ApplePay/decrypt-token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApplePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay decrypted token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" example."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"apis/wallets/other/decrypt-wallet-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /wallets/GooglePay/decrypt-token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GooglePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay decrypted token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" example. There is no encrypted Google Pay card type on the transaction request; decrypt the token first (unlike Apple Pay, which also supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applePayToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"properties":{"primaryAccountNumber":{"$ref":"#/components/schemas/primaryAccountNumber"},"expiryMonth":{"$ref":"#/components/schemas/expiryMonth"},"expiryYear":{"$ref":"#/components/schemas/expiryYear"},"cardVerificationCode":{"$ref":"#/components/schemas/cardVerificationCode"},"holderName":{"$ref":"#/components/schemas/cardHolderName"},"gatewayTokenId":{"description":"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","x-readme-ref-name":"gatewayTokenId"},"walletType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The digital wallet used for this card-not-present transaction. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApplePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GooglePay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /wallets/{walletType}/decrypt-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit for standard card-not-present transactions."},"children":[]}]}]}],"type":"string","enum":["ApplePay","GooglePay"]},"dynamicDescriptors":{"$ref":"#/components/schemas/dynamicDescriptors"}},"x-readme-ref-name":"cardNotPresent"}},"components/schemas/cardPresent":{"id":"components/schemas/cardPresent","kind":"json-schema","title":"Card present","data":{"title":"Card present","required":["pointOfInteraction","securityLevel"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object ensures processing of card present transactions by encapsulating all card-related information, whether the data is captured using point-to-point encryption (P2PE) or not. It supports various methods of card data capture including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual key entry: For transactions where card details are manually entered onto a device."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swiped: Magnetic stripe data is captured through a card reader."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chip and PIN: EMV chip data is captured using a chip reader, often requiring the cardholder to enter their PIN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contactless: Data is captured from NFC-enabled cards or devices by tapping them on a contactless reader."},"children":[]}]}]}]}],"properties":{"pointOfInteraction":{"$ref":"#/components/schemas/pointOfInteraction"},"securityLevel":{"oneOf":[{"title":"P2PE card data","description":"Contains card data for transactions where point-to-point encryption (P2PE) is used.  P2PE ensures that cardholder data is encrypted at the point of capture and remains secure throughout the transmission process.\n","required":["encryptedPayload"],"properties":{"encryptedPayload":{"description":"Contains card data for transactions where point-to-point encryption (P2PE) is used.  P2PE ensures that cardholder data is encrypted at the point of capture and remains secure throughout the transmission process. The encrypted payload can include card data captured through various methods such as key entry, swiped (magstripe), chip and pin (EMV), or contactless (NFC) transactions.\n","example":"348BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplo1rgQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="}},"type":"object","x-readme-ref-name":"p2peCardData"},{"title":"Non-P2PE card data","description":"Contains card data for transactions where point-to-point encryption (P2PE) is not used.  This includes manually entered card data and magnetic stripe data, which are not protected by encryption during transmission.\n","type":"object","properties":{"primaryAccountNumber":{"$ref":"#/components/schemas/primaryAccountNumber"},"expiryMonth":{"$ref":"#/components/schemas/expiryMonth"},"expiryYear":{"$ref":"#/components/schemas/expiryYear"},"cardVerificationCode":{"$ref":"#/components/schemas/cardVerificationCode"},"holderName":{"$ref":"#/components/schemas/cardHolderName"},"track2":{"description":"Track 2 data from the magnetic stripe of the card. Track 2 data typically includes the card number, expiry date, and additional service data. This data is used for transaction processing when a card is swiped.","example":"4111111111111111=22122011234567890","maxLength":37,"type":"string"},"iccTrack2Equivalent":{"description":"This field contains Track 2 equivalent data from the chip of the card. This data is similar to Track 2 data but is obtained from the card's chip rather than the magnetic stripe.","example":"4111111111111111D22122011234567890","maxLength":37,"type":"string"}},"x-readme-ref-name":"nonP2peCardData"}]},"emvData":{"description":"Contains detailed EMV (Europay, Mastercard, and Visa) data required for instore card transactions that are either chip and pin or contactless. Each field within this object represents a specific EMV tag that provides critical information about the transaction, card, and device.\n","required":["applicationIdentifier","applicationInterchangeProfile","applicationLabel","applicationPreferredName","applicationTransactionCounter","applicationUsageControl","applicationVersionNumber","authorisationRequestCryptogram","cryptogramInformationData","cryptogramTransactionType","cardHolderVerificationMethodResults","dedicatedFilename","issuerActionCodesDefault","issuerActionCodesDenial","issuerActionCodesOnline","issuerApplicationData","primaryAccountNumberSequenceNumber","pointOfSaleEntryMode1","pointOfSaleEntryMode2","terminalCapabilities","terminalCountryCode","terminalType","terminalVerificationResult","track2EquivalentData","transactionStatusInformation","unpredictableNumber"],"properties":{"applicationIdentifier":{"description":"EMV Tag 9F06: Identifies the application according to ISO/IEC 7816-5.","type":"string","format":"string(5-16)","example":"A0000000031010"},"applicationInterchangeProfile":{"description":"EMV Tag 82: Indicates the card's capabilities for supporting specific functions in the application.","type":"string","format":"string(2)","example":"5C00"},"applicationLabel":{"description":"EMV Tag 50: Mnemonic associated with the Application Identifier (AID) according to ISO/IEC 7816-5.","type":"string","format":"string(1-16)","example":"VISA"},"applicationPreferredName":{"description":"The preferred name of the application as designated by the card issuer.","type":"string","format":"string(1-16)","example":"VISA CREDIT"},"applicationTransactionCounter":{"description":"EMV Tag 9F36: A counter maintained by the application in the ICC, incremented by the card for each transaction.","type":"string","format":"string(2)","example":"0012"},"applicationUsageControl":{"description":"EMV Tag 9F07: Indicates the issuer's specified restrictions on geographic usage and services allowed for the application.","type":"string","format":"string(2)","example":"FFC0"},"applicationVersionNumber":{"description":"EMV Tag 9F08: Version number assigned by the payment system for the application.","type":"string","format":"string(2)","example":"008C"},"authorisationRequestCryptogram":{"description":"EMV Tag 9F26: Cryptogram generated by the card during the transaction.","type":"string","format":"string(8)","example":"9F5B6A4C9F3F7C4D"},"contactless":{"properties":{"discretionaryData":{"description":"Additional data specified by the issuer, included in the transaction for contactless payments.","type":"string","format":"string(0-32)","example":"D1F2C3B4A567890123456789ABCDEF12"},"formFactor":{"description":"EMV Tag 9F6E: Indicates the type of device used in the transaction.","type":"string","format":"string(1-2)","example":"07"}}},"cryptogramInformationData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F27: Indicates the type of cryptogram and the actions to be performed by the device."},"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":"00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AAC (Application Authentication Cryptogram) - Transaction declined by the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"40"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TC (Transaction Certificate) - Transaction approved by the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"80"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ARQC (Authorisation Request Cryptogram) - Request for online Authorisation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ARPC (Authorisation Response Cryptogram) - Response from issuer to ARQC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AAR (Application Authentication Request) - Additional Authorisation request for offline data authentication."},"children":[]}]}]}]}],"type":"string","format":"string(2)","enum":["00","40","80","C0","10"],"example":"00"},"cryptogramTransactionType":{"description":"EMV Tag 9C: Indicates the type of financial transaction, represented by the first two digits of ISO 8583:1987 Processing Code.\n","type":"string","format":"string(1)","example":"00"},"cardHolderVerificationMethodResults":{"description":"EMV Tag 9F34: Indicates the results of the last cardholder verification method performed.","type":"string","format":"string(3)","example":"420300"},"dedicatedFilename":{"description":"EMV Tag 84: Identifies the application or file in the card.","type":"string","format":"string(5-16)","example":"A000000003"},"issuerActionCodesDefault":{"description":"EMV Tag 9F0D: Specifies the issuers conditions for transaction rejection when the device is unable to go online.","type":"string","format":"string(5)","example":"FFFFFFFFFF"},"issuerActionCodesDenial":{"description":"EMV Tag 9F0E: Specifies the issuers conditions that cause the denial of a transaction without an attempt to go online.","type":"string","format":"string(5)","example":"0102030405"},"issuerActionCodesOnline":{"description":"EMV Tag 9F0F: Specifies the issuers conditions that cause a transaction to be transmitted online.","type":"string","format":"string(5)","example":"A0B0C0D0E0"},"issuerApplicationData":{"description":"EMV Tag 9F10: Contains proprietary application data for transmission to the issuer in an online transaction.","type":"string","format":"string(2-32)","example":"06010A03600000"},"pinBlock":{"required":["encryptedPin","keySerialNumber"],"description":"Contains encrypted PIN data and the Key Serial Number (KSN) used for online PIN verification.","type":"object","properties":{"encryptedPin":{"description":"The encrypted PIN data used for online PIN verification. This data is encrypted at the point of capture and remains secure during transmission.","type":"string","example":"1A2B3C4D5E6F7G8H"},"keySerialNumber":{"description":"The Key Serial Number (KSN) that identifies which key was used for encrypting the PIN. This is used in conjunction with the encrypted PIN for online PIN verification.","type":"string","example":"1234567890ABCDEFFEDCBA0987654321"}}},"primaryAccountNumberSequenceNumber":{"description":"EMV Tag 5F34: Identifies and differentiates cards with the same PAN.","type":"string","format":"string(1)","example":"01"},"pointOfSaleEntryMode1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F39: Indicates the method by which the PAN was entered, according to the first digit of the ISO 8583:1987 point of sale entry mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": contactChip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": contactlessEMV"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": magneticStripeReadFallback"},"children":[]}]}]}]}],"type":"string","example":"05"},"pointOfSaleEntryMode2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F39: Indicates the method by which the PAN was entered, according to the second digit of the ISO 8583:1987 point of sale Entry Mode."},"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":"00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": normal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": installment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": incremental"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": partialApproval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": preAuthorisation"},"children":[]}]}]}]}],"type":"string","example":"00"},"terminalCapabilities":{"description":"EMV Tag 9F33: Indicates the card data input, CVM, and security capabilities of the device.","type":"string","format":"string(3)","example":"E0F8C8"},"terminalCountryCode":{"description":"EMV Tag 9F1A: Indicates the country of the device, represented according to ISO 3166.","type":"string","format":"string(2)","example":"0840"},"terminalType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F35: Indicates the type of terminal involved in the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online only. A device that requires human interaction (e.g., a cashier) and is only capable of performing online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline with online capability: A device that requires human interaction and can perform both offline and online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline only. A device that requires human interaction and is only capable of performing offline transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online only. A device that does not require human interaction (e.g., self-service kiosk) and is only capable of performing online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline with online capability. A device that does not require human interaction and can perform both offline and online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline-only terminal with cash dispensing (e.g., attended ATM)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, both online and offline capable with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"21"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline-only terminal with goods dispensing (e.g., vending)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"23"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, both online and offline capable with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"26"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"34"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"36"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"61"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline only. A device that does not require human interaction and is only capable of performing offline transactions."},"children":[]}]}]}]}],"type":"string","example":"01"},"terminalVerificationResult":{"description":"EMV Tag 95: Status of the different functions as seen from the device.","type":"string","format":"string(5)","example":"8000048000"},"transactionStatusInformation":{"description":"EMV Tag 9B: Indicates the functions performed in a transaction.","type":"string","format":"string(2)","example":"E800"},"unpredictableNumber":{"description":"EMV Tag 9F37: Value to provide variability and uniqueness to the generation of a cryptogram.","type":"string","format":"string(4)","example":"6A5B4C3D"},"additionalTags":{"description":"Additional EMV tags, as required by acquirers (e.g., TTQ or CTQ). Encoded as concatenated TLV (Tag-Length-Value) structures in hexadecimal format.","type":"string","pattern":"^[0-9A-F]*$","example":"9F6604FFFFFFFF9F6C02FFFF"}},"type":"object","x-readme-ref-name":"emvData"},"dynamicDescriptors":{"$ref":"#/components/schemas/dynamicDescriptors"}},"type":"object","x-readme-ref-name":"cardPresent"}},"components/schemas/cardPresentEntryType":{"id":"components/schemas/cardPresentEntryType","kind":"json-schema","title":"cardPresentEntryType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which the card information was entered during a card present transaction. This field is crucial for determining the specific process and security measures used in the transaction. It helps in categorising the entry type, whether it involves physical card interaction or a contactless device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On create requests, this is sent in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData.card.pointOfInteraction.entryType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On query responses for in-store transactions, it may also be returned at the root of the transaction object."},"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":"ChipAndPin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read from the chip, with the user entering a PIN for verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ChipAndSignature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read from the chip, with the user providing a signature for verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardContactless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read through a contactless interaction, such as tapping the card on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardContactlessScaRetry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retry of a contactless card transaction following Strong Customer Authentication (SCA) requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PhoneContactless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read through a contactless interaction via a smartphone."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PhoneContactlessScaRetry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retry of a contactless phone transaction following Strong Customer Authentication (SCA) requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WatchContactless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read through a contactless interaction via a smartwatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WatchContactlessScaRetry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retry of a contactless watch transaction following Strong Customer Authentication (SCA) requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WearableContactless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read through a contactless interaction via other wearable devices like fitness trackers or rings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WearableContactlessScaRetry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retry of a contactless wearable transaction following Strong Customer Authentication (SCA) requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Swiped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information read from the magnetic stripe via swiping."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KeyEntry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information manually entered through the keypad."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FallbackToSwipe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card information is read from the magnetic stripe after three failed attempts to read the chip."},"children":[]}]}]}]}],"type":"string","enum":["ChipAndPin","ChipAndSignature","CardContactless","CardContactlessScaRetry","PhoneContactless","PhoneContactlessScaRetry","WatchContactless","WatchContactlessScaRetry","WearableContactless","WearableContactlessScaRetry","Swiped","KeyEntry","FallbackToSwipe"],"example":"ChipAndPin","x-readme-ref-name":"cardPresentEntryType"}},"components/schemas/cardScheme":{"id":"components/schemas/cardScheme","kind":"json-schema","title":"cardScheme","data":{"description":"The payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is represented by 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]+$","x-readme-ref-name":"cardScheme"}},"components/schemas/cardVerificationCode":{"id":"components/schemas/cardVerificationCode","kind":"json-schema","title":"cardVerificationCode","data":{"description":"The Card Verification Code (CVC) associated with the payment card, a security feature for transactions where the card is not physically present. The CVC is typically a 3 or 4 digit number found on the card, used to verify that the cardholder is in possession of the card during non-face-to-face transactions.","example":"123","type":"string","minLength":3,"maxLength":4,"x-readme-ref-name":"cardVerificationCode"}},"components/schemas/cardHolderName":{"id":"components/schemas/cardHolderName","kind":"json-schema","title":"cardHolderName","data":{"description":"The full name of the individual who owns the payment card. This name is printed on the physical card and is used for verifying the cardholder's identity during transactions. The cardholder name is a vital component for transaction processing, especially in cases of card-not-present transactions like online purchases. It should be treated with confidentiality to safeguard the cardholder's privacy and prevent potential misuse.","example":"Mr John Doe","type":"string","maxLength":100,"x-readme-ref-name":"cardHolderName"}},"components/schemas/primaryAccountNumber":{"id":"components/schemas/primaryAccountNumber","kind":"json-schema","title":"primaryAccountNumber","data":{"description":"The unique number assigned to a payment card, such as a credit or debit card. This number typically contains 13-19 digits, structured in a specific format to indicate the card network, issuing bank, and account number.","example":"4111111111111111","type":"string","minLength":13,"maxLength":19,"x-readme-ref-name":"primaryAccountNumber"}},"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","x-readme-ref-name":"providerResponseName"},"code":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string","x-readme-ref-name":"providerResponseCode"},"message":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string","x-readme-ref-name":"providerResponseMessage"},"merchantId":{"description":"The unique identifier assigned by the provider to represent the merchant involved in the transaction processing.","example":"77772182","type":"string","x-readme-ref-name":"providerResponseMerchantId"},"cardVerificationCodeResult":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Card Verification Code (CVC) result returned by the provider. This is a raw data indicating the outcome of the CVC check performed during the transaction processing. It will only be returned for card transactions where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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":"."},"children":[]}]}]}],"type":"string","example":"D","x-readme-ref-name":"providerResponseCvcResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/providerResponseAvsResult"},"emvDataResponse":{"description":"Response data from an EMV (Europay, Mastercard, and Visa) transaction.","type":"object","properties":{"applicationIdentifier":{"description":"EMV Tag 9F06: Identifies the application according to ISO/IEC 7816-5.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"EMV Tag 50: Mnemonic associated with the Application Identifier (AID) according to ISO/IEC 7816-5.","type":"string","example":"VISA"},"primaryAccountNumberSequenceNumber":{"description":"EMV Tag 5F34: Identifies and differentiates cards with the same PAN.","type":"string","example":"01"},"authorisationResponseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A two-digit code (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") indicating the result of the transaction authorisation, which may include approval, denial, or referral."},"children":[]}]}]}],"type":"string","example":"00"},"issuerAuthenticationData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"91"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") provided by the issuer to authenticate the transaction. This may include an authorisation response Cryptogram (ARPC)."},"children":[]}]}]}],"type":"string","example":"1234567890ABCDEF"},"issuerScriptTemplate1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer-provided script (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"71"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that can be used to update card parameters or perform specific actions on the card post authorisation."},"children":[]}]}]}],"type":"string","example":"710A1234567890ABCDEF"},"issuerScriptTemplate2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A second issuer-provided script (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"72"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that can be used for additional card updates or actions post authorisation."},"children":[]}]}]}],"type":"string","example":"720B1234567890ABCDEF12"}},"x-readme-ref-name":"emvDataResponse"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"retrievalReferenceNumber":{"$ref":"#/components/schemas/retrievalReferenceNumber"},"schemeTransactionId":{"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","x-readme-ref-name":"schemeTransactionId"},"electronicCommerceIndicatorAdjustment":{"$ref":"#/components/schemas/electronicCommerceIndicatorAdjustment"},"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","x-readme-ref-name":"merchantAdvice"},"settlementDate":{"$ref":"#/components/schemas/settlementDate"},"nameVerificationResult":{"$ref":"#/components/schemas/nameVerificationResult"}},"x-readme-ref-name":"cardProviderResponse"}},"components/schemas/expiryMonth":{"id":"components/schemas/expiryMonth","kind":"json-schema","title":"expiryMonth","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month [MM] of the card."},"children":[]}]}]}],"example":"03","maxLength":2,"minLength":2,"pattern":"^[0-9]","type":"string","x-readme-ref-name":"expiryMonth"}},"components/schemas/expiryYear":{"id":"components/schemas/expiryYear","kind":"json-schema","title":"expiryYear","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year [YYYY] of the card."},"children":[]}]}]}],"example":"2025","maxLength":4,"minLength":4,"pattern":"^[0-9]","type":"string","x-readme-ref-name":"expiryYear"}},"components/schemas/schemeTokenExpiryMonth":{"id":"components/schemas/schemeTokenExpiryMonth","kind":"json-schema","title":"schemeTokenExpiryMonth","data":{"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 scheme token ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"03","maxLength":2,"minLength":2,"pattern":"^[0-9]","type":"string","x-readme-ref-name":"schemeTokenExpiryMonth"}},"components/schemas/schemeTokenExpiryYear":{"id":"components/schemas/schemeTokenExpiryYear","kind":"json-schema","title":"schemeTokenExpiryYear","data":{"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 scheme token ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2025","maxLength":4,"minLength":4,"pattern":"^[0-9]","type":"string","x-readme-ref-name":"schemeTokenExpiryYear"}},"components/schemas/p2peCardData":{"id":"components/schemas/p2peCardData","kind":"json-schema","title":"p2peCardData","data":{"description":"Contains card data for transactions where point-to-point encryption (P2PE) is used.  P2PE ensures that cardholder data is encrypted at the point of capture and remains secure throughout the transmission process.\n","required":["encryptedPayload"],"properties":{"encryptedPayload":{"description":"Contains card data for transactions where point-to-point encryption (P2PE) is used.  P2PE ensures that cardholder data is encrypted at the point of capture and remains secure throughout the transmission process. The encrypted payload can include card data captured through various methods such as key entry, swiped (magstripe), chip and pin (EMV), or contactless (NFC) transactions.\n","example":"348BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplo1rgQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="}},"type":"object","x-readme-ref-name":"p2peCardData"}},"components/schemas/nonP2peCardData":{"id":"components/schemas/nonP2peCardData","kind":"json-schema","title":"nonP2peCardData","data":{"description":"Contains card data for transactions where point-to-point encryption (P2PE) is not used.  This includes manually entered card data and magnetic stripe data, which are not protected by encryption during transmission.\n","type":"object","properties":{"primaryAccountNumber":{"$ref":"#/components/schemas/primaryAccountNumber"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month [MM] of the card. This is present if the card is manually entered into a device without point-to-point encryption."},"children":[]}]}]}],"example":"03","maxLength":2,"minLength":2,"pattern":"^[0-9]{2}$","type":"string"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year [YYYY] of the card. This is present if the card is manually entered into a device without point-to-point encryption."},"children":[]}]}]}],"example":"2025","maxLength":4,"minLength":4,"pattern":"^[0-9]{4}$","type":"string"},"cardVerificationCode":{"description":"Represents the Card Verification Code (CVC) associated with the payment card, a security feature for transactions where the card is not physically present. The CVC is typically a 3 or 4 digit number found on the card, used to verify that the cardholder is in possession of the card during non-face-to-face transactions. This is present if the card is manually entered into a device without point-to-point encryption.","example":"123","minLength":3,"maxLength":4,"type":"string"},"holderName":{"description":"The Cardholder Name represents the full name of the individual who owns the payment card. This name is printed on the physical card and is used for verifying the cardholder's identity during transactions. The cardholder name is a vital component for transaction processing, especially in cases of card-not-present transactions like online purchases. It should be treated with confidentiality to safeguard the cardholder's privacy and prevent potential misuse.","example":"Mr John Doe","maxLength":100,"type":"string"},"track2":{"description":"This field contains Track 2 data from the magnetic stripe of the card. Track 2 data typically includes the card number, expiry date, and additional service data. This data is used for transaction processing when a card is swiped.","example":"4111111111111111=22122011234567890","maxLength":37,"type":"string"},"iccTrack2Equivalent":{"description":"This field contains Track 2 equivalent data from the chip of the card. This data is similar to Track 2 data but is obtained from the card's chip rather than the magnetic stripe.","example":"4111111111111111D22122011234567890","maxLength":37,"type":"string"}},"x-readme-ref-name":"nonP2peCardData"}},"components/schemas/emvData":{"id":"components/schemas/emvData","kind":"json-schema","title":"emvData","data":{"description":"Contains detailed EMV (Europay, Mastercard, and Visa) data required for instore card transactions that are either chip and pin or contactless. Each field within this object represents a specific EMV tag that provides critical information about the transaction, card, and device.\n","required":["applicationIdentifier","applicationInterchangeProfile","applicationLabel","applicationPreferredName","applicationTransactionCounter","applicationUsageControl","applicationVersionNumber","authorisationRequestCryptogram","cryptogramInformationData","cryptogramTransactionType","cardHolderVerificationMethodResults","dedicatedFilename","issuerActionCodesDefault","issuerActionCodesDenial","issuerActionCodesOnline","issuerApplicationData","primaryAccountNumberSequenceNumber","pointOfSaleEntryMode1","pointOfSaleEntryMode2","terminalCapabilities","terminalCountryCode","terminalType","terminalVerificationResult","track2EquivalentData","transactionStatusInformation","unpredictableNumber"],"properties":{"applicationIdentifier":{"description":"EMV Tag 9F06: Identifies the application according to ISO/IEC 7816-5.","type":"string","format":"string(5-16)","example":"A0000000031010"},"applicationInterchangeProfile":{"description":"EMV Tag 82: Indicates the card's capabilities for supporting specific functions in the application.","type":"string","format":"string(2)","example":"5C00"},"applicationLabel":{"description":"EMV Tag 50: Mnemonic associated with the Application Identifier (AID) according to ISO/IEC 7816-5.","type":"string","format":"string(1-16)","example":"VISA"},"applicationPreferredName":{"description":"The preferred name of the application as designated by the card issuer.","type":"string","format":"string(1-16)","example":"VISA CREDIT"},"applicationTransactionCounter":{"description":"EMV Tag 9F36: A counter maintained by the application in the ICC, incremented by the card for each transaction.","type":"string","format":"string(2)","example":"0012"},"applicationUsageControl":{"description":"EMV Tag 9F07: Indicates the issuer's specified restrictions on geographic usage and services allowed for the application.","type":"string","format":"string(2)","example":"FFC0"},"applicationVersionNumber":{"description":"EMV Tag 9F08: Version number assigned by the payment system for the application.","type":"string","format":"string(2)","example":"008C"},"authorisationRequestCryptogram":{"description":"EMV Tag 9F26: Cryptogram generated by the card during the transaction.","type":"string","format":"string(8)","example":"9F5B6A4C9F3F7C4D"},"contactless":{"properties":{"discretionaryData":{"description":"Additional data specified by the issuer, included in the transaction for contactless payments.","type":"string","format":"string(0-32)","example":"D1F2C3B4A567890123456789ABCDEF12"},"formFactor":{"description":"EMV Tag 9F6E: Indicates the type of device used in the transaction.","type":"string","format":"string(1-2)","example":"07"}}},"cryptogramInformationData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F27: Indicates the type of cryptogram and the actions to be performed by the device."},"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":"00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AAC (Application Authentication Cryptogram) - Transaction declined by the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"40"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": TC (Transaction Certificate) - Transaction approved by the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"80"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ARQC (Authorisation Request Cryptogram) - Request for online Authorisation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ARPC (Authorisation Response Cryptogram) - Response from issuer to ARQC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": AAR (Application Authentication Request) - Additional Authorisation request for offline data authentication."},"children":[]}]}]}]}],"type":"string","format":"string(2)","enum":["00","40","80","C0","10"],"example":"00"},"cryptogramTransactionType":{"description":"EMV Tag 9C: Indicates the type of financial transaction, represented by the first two digits of ISO 8583:1987 Processing Code.\n","type":"string","format":"string(1)","example":"00"},"cardHolderVerificationMethodResults":{"description":"EMV Tag 9F34: Indicates the results of the last cardholder verification method performed.","type":"string","format":"string(3)","example":"420300"},"dedicatedFilename":{"description":"EMV Tag 84: Identifies the application or file in the card.","type":"string","format":"string(5-16)","example":"A000000003"},"issuerActionCodesDefault":{"description":"EMV Tag 9F0D: Specifies the issuers conditions for transaction rejection when the device is unable to go online.","type":"string","format":"string(5)","example":"FFFFFFFFFF"},"issuerActionCodesDenial":{"description":"EMV Tag 9F0E: Specifies the issuers conditions that cause the denial of a transaction without an attempt to go online.","type":"string","format":"string(5)","example":"0102030405"},"issuerActionCodesOnline":{"description":"EMV Tag 9F0F: Specifies the issuers conditions that cause a transaction to be transmitted online.","type":"string","format":"string(5)","example":"A0B0C0D0E0"},"issuerApplicationData":{"description":"EMV Tag 9F10: Contains proprietary application data for transmission to the issuer in an online transaction.","type":"string","format":"string(2-32)","example":"06010A03600000"},"pinBlock":{"required":["encryptedPin","keySerialNumber"],"description":"Contains encrypted PIN data and the Key Serial Number (KSN) used for online PIN verification.","type":"object","properties":{"encryptedPin":{"description":"The encrypted PIN data used for online PIN verification. This data is encrypted at the point of capture and remains secure during transmission.","type":"string","example":"1A2B3C4D5E6F7G8H"},"keySerialNumber":{"description":"The Key Serial Number (KSN) that identifies which key was used for encrypting the PIN. This is used in conjunction with the encrypted PIN for online PIN verification.","type":"string","example":"1234567890ABCDEFFEDCBA0987654321"}}},"primaryAccountNumberSequenceNumber":{"description":"EMV Tag 5F34: Identifies and differentiates cards with the same PAN.","type":"string","format":"string(1)","example":"01"},"pointOfSaleEntryMode1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F39: Indicates the method by which the PAN was entered, according to the first digit of the ISO 8583:1987 point of sale entry mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": contactChip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": contactlessEMV"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": magneticStripeReadFallback"},"children":[]}]}]}]}],"type":"string","example":"05"},"pointOfSaleEntryMode2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F39: Indicates the method by which the PAN was entered, according to the second digit of the ISO 8583:1987 point of sale Entry Mode."},"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":"00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": normal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": recurring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": installment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": incremental"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": partialApproval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": preAuthorisation"},"children":[]}]}]}]}],"type":"string","example":"00"},"terminalCapabilities":{"description":"EMV Tag 9F33: Indicates the card data input, CVM, and security capabilities of the device.","type":"string","format":"string(3)","example":"E0F8C8"},"terminalCountryCode":{"description":"EMV Tag 9F1A: Indicates the country of the device, represented according to ISO 3166.","type":"string","format":"string(2)","example":"0840"},"terminalType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV Tag 9F35: Indicates the type of terminal involved in the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online only. A device that requires human interaction (e.g., a cashier) and is only capable of performing online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline with online capability: A device that requires human interaction and can perform both offline and online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline only. A device that requires human interaction and is only capable of performing offline transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online only. A device that does not require human interaction (e.g., self-service kiosk) and is only capable of performing online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline with online capability. A device that does not require human interaction and can perform both offline and online transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline-only terminal with cash dispensing (e.g., attended ATM)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, both online and offline capable with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with cash dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"21"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, offline-only terminal with goods dispensing (e.g., vending)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, online-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"23"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attended, both online and offline capable with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"26"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with goods dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"34"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline-only terminal with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, online-only terminal with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"36"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, both online and offline capable with services dispensing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"61"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unattended, offline only. A device that does not require human interaction and is only capable of performing offline transactions."},"children":[]}]}]}]}],"type":"string","example":"01"},"terminalVerificationResult":{"description":"EMV Tag 95: Status of the different functions as seen from the device.","type":"string","format":"string(5)","example":"8000048000"},"transactionStatusInformation":{"description":"EMV Tag 9B: Indicates the functions performed in a transaction.","type":"string","format":"string(2)","example":"E800"},"unpredictableNumber":{"description":"EMV Tag 9F37: Value to provide variability and uniqueness to the generation of a cryptogram.","type":"string","format":"string(4)","example":"6A5B4C3D"},"additionalTags":{"description":"Additional EMV tags, as required by acquirers (e.g., TTQ or CTQ). Encoded as concatenated TLV (Tag-Length-Value) structures in hexadecimal format.","type":"string","pattern":"^[0-9A-F]*$","example":"9F6604FFFFFFFF9F6C02FFFF"}},"type":"object","x-readme-ref-name":"emvData"}},"components/schemas/correlationId":{"id":"components/schemas/correlationId","kind":"json-schema","title":"correlationId","data":{"description":"The unique identifier for this error response. Include it when contacting PXP support.","example":"81f32b80-2ba0-4430-8ecd-0b559274ba9c","type":"string","x-readme-ref-name":"correlationId"}},"components/schemas/currencyCode":{"id":"components/schemas/currencyCode","kind":"json-schema","title":"currencyCode","data":{"description":"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,"x-readme-ref-name":"currencyCode"}},"components/schemas/cardVerificationCodeResult":{"id":"components/schemas/cardVerificationCodeResult","kind":"json-schema","title":"cardVerificationCodeResult","data":{"description":"The outcome of the Card Verification Code (CVC) check, an essential security measure for verifying the cardholder's presence during a transaction. This result indicates whether the provided CVC matches, does not match, or has not been checked against the card issuer's records, contributing to fraud prevention and transaction security.","type":"string","enum":["NoInformationAvailable","CardSecurityCodeMatched","CardSecurityCodeNotMatched","CardSecurityCodeNotChecked"],"example":"CardSecurityCodeMatched","x-readme-ref-name":"cardVerificationCodeResult"}},"components/schemas/details":{"id":"components/schemas/details","kind":"json-schema","title":"details","data":{"description":"Additional information about the error, such as field-level validation messages. Each entry is a string. May be empty.","example":["'$.site' - The site field is required."],"items":{"type":"string"},"type":"array","x-readme-ref-name":"details"}},"components/schemas/dynamicDescriptors":{"id":"components/schemas/dynamicDescriptors","kind":"json-schema","title":"dynamicDescriptors","data":{"description":"Merchant-defined descriptors that enhance transaction recognition on customer bank statements.","properties":{"cardAcceptorName":{"description":"A specific descriptor for enhancing transaction clarity, typically including key transaction details.","type":"string","maxLength":22,"pattern":"^[a-zA-Z0-9 -]*$"}},"type":"object","x-readme-ref-name":"dynamicDescriptors"}},"components/schemas/electronicCommerceIndicatorAdjustment":{"id":"components/schemas/electronicCommerceIndicatorAdjustment","kind":"json-schema","title":"electronicCommerceIndicatorAdjustment","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The electronicCommerceIndicatorAdjustment field if present represents the Electronic Commerce Indicator (ECI) adjustment made by the payment scheme after the initial transaction authorisation. The ECI signifies the level of security applied to an online transaction, indicating the authentication and verification methods used. Adjustments to the ECI reflect a reevaluation of the transaction's security level, which can be due to various factors such as risk assessment updates, compliance with security standards, outcomes of authentication processes, interchange fee considerations, or error corrections. An ECI adjustment can either upgrade or downgrade the transaction's security indicator, impacting interchange fees, chargeback liability, and the transaction's overall security assurance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with SSL or equivalent but without cardholder authentication (considered less secure, higher risk)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with cardholder authentication (e.g., 3D Secure), indicating a higher level of security."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed with 3D Secure authentication, cardholder authenticated successfully (high security)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction attempted 3D Secure authentication but could not be completed; cardholder not authenticated (medium security)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction processed without 3D Secure authentication, due to issuer or cardholder not participating in 3D Secure (considered less secure, higher risk)."},"children":[]}]}]}]}],"type":"string","example":"01","x-readme-ref-name":"electronicCommerceIndicatorAdjustment"}},"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":"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 "},"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":["Ecom","Moto","Instore"],"example":"Ecom","x-readme-ref-name":"entryType"}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the structure for reporting errors encountered during the transaction process. This object includes a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"correlationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for tracking and diagnosing the issue, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifying the type of error, and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" providing a descriptive explanation of the error. Additionally, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array may contain further information or context about the error, offering insights necessary for troubleshooting and resolution. This structured approach ensures precise error reporting and aids in efficient error management and support processes."},"children":[]}]}]}],"properties":{"correlationId":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"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","x-readme-ref-name":"error"}},"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","x-readme-ref-name":"errorCode"}},"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","x-readme-ref-name":"errorReason"}},"components/schemas/fundingData":{"id":"components/schemas/fundingData","kind":"json-schema","title":"fundingData","data":{"type":"object","oneOf":[{"title":"Card","$ref":"#/components/schemas/fundingDataCard"},{"title":"Pay by bank","$ref":"#/components/schemas/fundingDataPayByBank"}]}},"components/schemas/fundingDataCard":{"id":"components/schemas/fundingDataCard","kind":"json-schema","title":"Card","data":{"title":"Card","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card and wallet funding for the transaction. Use this shape when "},"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":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to one card type only and include the fields for that type:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Encrypted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applePayToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or decrypted card details with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card not present:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Standard PAN entry, or decrypted Apple Pay/Google Pay with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"walletType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card present"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme token number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme token ID"},"children":[]}]}]}]}]}],"required":["card"],"properties":{"card":{"$ref":"#/components/schemas/card"}}}},"components/schemas/fundingDataPayByBank":{"id":"components/schemas/fundingDataPayByBank","kind":"json-schema","title":"Pay by bank","data":{"title":"Pay by bank","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-by-bank APM funding for the transaction (Aeropay or SPEI). Use this shape when "},"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":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apmProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the fields required for that provider."},"children":[]}]}]}],"required":["payByBank"],"properties":{"payByBank":{"$ref":"#/components/schemas/payByBank"}}}},"components/schemas/payByBank":{"id":"components/schemas/payByBank","kind":"json-schema","title":"payByBank","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-by-bank funding details for alternative payment method (APM) transactions. Used when "},"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":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The shape depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apmProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"title":"Aeropay","$ref":"#/components/schemas/payByBankAeropay"},{"title":"SPEI","$ref":"#/components/schemas/payByBankSpei"}],"discriminator":{"propertyName":"apmProvider","mapping":{"Aeropay":"#/components/schemas/payByBankAeropay","Spei":"#/components/schemas/payByBankSpei"}}}},"components/schemas/payByBankAeropay":{"id":"components/schemas/payByBankAeropay","kind":"json-schema","title":"payByBankAeropay","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-by-bank funding details for Aeropay. Used when "},"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":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apmProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aeropay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["apmProvider","user","bank"],"properties":{"apmProvider":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the alternative payment method (APM) provider that processes the pay-by-bank transaction. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aeropay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this funding shape."},"children":[]}]}]}],"type":"string","enum":["Aeropay"],"example":"Aeropay"},"user":{"description":"The APM user associated with this pay-by-bank payment.","type":"object","required":["id"],"properties":{"id":{"description":"The unique identifier of the user at the APM provider.","type":"string","example":"761a3e91-4062-4fc2-80a4-dc12c8601522"}}},"bank":{"description":"The bank account selected for this pay-by-bank payment.","type":"object","required":["accountId"],"properties":{"accountId":{"description":"The bank account identifier at the APM provider.","type":"integer","example":1895546}}}}}},"components/schemas/payByBankSpei":{"id":"components/schemas/payByBankSpei","kind":"json-schema","title":"payByBankSpei","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-by-bank funding details for SPEI (Mexican interbank transfer). Used when "},"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":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apmProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"successRedirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureRedirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supply either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewaytokenid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the full triple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Redirect and language fields do not apply to payout."},"children":[]}]}]}],"type":"object","required":["apmProvider"],"properties":{"apmProvider":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the alternative payment method (APM) provider that processes the pay-by-bank transaction. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this funding shape."},"children":[]}]}]}],"type":"string","enum":["Spei"],"example":"Spei"},"language":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code for the hosted SPEI experience, in ISO 639-1 format. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only; omit on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Za-z]{2}$","example":"ES","maxLength":2,"minLength":2},"bankAccountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination CLABE or bank account number. Optional on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", required with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewaytokenid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't supplied."},"children":[]}]}]}],"type":"string","example":"012345678901234567"},"bankCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination bank code. Optional on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", required with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewaytokenid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't supplied."},"children":[]}]}]}],"type":"string","example":"40012"},"accountType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination bank account type, for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gatewaytokenid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't supplied."},"children":[]}]}]}],"type":"string","enum":["Savings","Current","Clabe"],"example":"Clabe"},"gatewaytokenid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference to a stored PXP payment account for the destination bank account, for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aren't all supplied. Capture this value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stateData.gatewayTokenId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on an earlier accepted payout response."},"children":[]}]}]}],"type":"string","example":"b6e2f1a4c3d84f7ab1e9d2c3f4a5b6c7"},"successRedirectUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional HTTPS URL where the shopper is returned after a successful hosted SPEI "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"uri","example":"https://merchant.example/spei/success"},"failureRedirectUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional HTTPS URL where the shopper is returned after a failed hosted SPEI "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"uri","example":"https://merchant.example/spei/failure"}}}},"components/schemas/apmProvider":{"id":"components/schemas/apmProvider","kind":"json-schema","title":"apmProvider","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The alternative payment method (APM) provider that processes the pay-by-bank transaction (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aeropay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). On modifications where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is required — if omitted, the gateway defaults to Aeropay. For SPEI refunds, set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["Aeropay","Spei"],"example":"Aeropay"}},"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","Cage","Paypal","PayByBank"],"example":"Card"}},"components/schemas/gatewayTokenId":{"id":"components/schemas/gatewayTokenId","kind":"json-schema","title":"gatewayTokenId","data":{"description":"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":40,"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":"An optional field that captures 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","x-readme-ref-name":"gratuity"}},"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"],"x-readme-ref-name":"serviceCharge"}},"components/schemas/identityVerification":{"id":"components/schemas/identityVerification","kind":"json-schema","title":"identityVerification","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a set of boolean flags that indicate the results of various identity verification checks. This object is applicable only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.intent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for transactions processed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ecom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry types. These checks are essential to ensure that the information provided matches the cardholder's details on file, crucial for enhancing security and reducing fraud risks. Each property within this object represents a different aspect of the cardholder's identity being verified."},"children":[]}]}]}],"type":"object","properties":{"nameVerification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the cardholder's name matches the name associated with the registered address on file. Accepted only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.intent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Moto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ecom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry types); other intents reject this field."},"children":[]}]}]}],"example":true,"type":"boolean","default":false}},"required":["nameVerification"]}},"components/schemas/inline_response_400":{"id":"components/schemas/inline_response_400","kind":"json-schema","title":"inline_response_400","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","x-readme-ref-name":"inline_response_400"}},"components/schemas/inline_response_401":{"id":"components/schemas/inline_response_401","kind":"json-schema","title":"inline_response_401","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","x-readme-ref-name":"inline_response_401"}},"components/schemas/inline_response_403":{"id":"components/schemas/inline_response_403","kind":"json-schema","title":"inline_response_403","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","x-readme-ref-name":"inline_response_403"}},"components/schemas/inline_response_404":{"id":"components/schemas/inline_response_404","kind":"json-schema","title":"inline_response_404","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","x-readme-ref-name":"inline_response_404"}},"components/schemas/inline_response_413":{"id":"components/schemas/inline_response_413","kind":"json-schema","title":"inline_response_413","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","x-readme-ref-name":"inline_response_413"}},"components/schemas/inline_response_422":{"id":"components/schemas/inline_response_422","kind":"json-schema","title":"inline_response_422","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","x-readme-ref-name":"inline_response_422"}},"components/schemas/inline_response_500":{"id":"components/schemas/inline_response_500","kind":"json-schema","title":"inline_response_500","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","x-readme-ref-name":"inline_response_500"}},"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. Each intent dictates a specific transaction flow and affects how the transaction is handled by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported intents by funding type:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card:"},"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":", "},"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":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paypal:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cage:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"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":"Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayByBank - Aeropay:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayByBank - SPEI:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"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":"Payout"},"children":[]}]}]}]}],"type":"string","enum":["Authorisation","EstimatedAuthorisation","Purchase","Payout","Refund","Verification","Create"],"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,"x-readme-ref-name":"merchant"}},"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","x-readme-ref-name":"merchantAdvice"}},"components/schemas/merchantTransactionDate":{"id":"components/schemas/merchantTransactionDate","kind":"json-schema","title":"merchantTransactionDate","data":{"description":"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","x-readme-ref-name":"merchantTransactionDate"}},"components/schemas/merchantTransactionId":{"id":"components/schemas/merchantTransactionId","kind":"json-schema","title":"merchantTransactionId","data":{"description":"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,"x-readme-ref-name":"merchantTransactionId"}},"components/schemas/merchantTransactionGroupId":{"id":"components/schemas/merchantTransactionGroupId","kind":"json-schema","title":"merchantTransactionGroupId","data":{"description":"An optional identifier assigned by you to group related transactions together, enabling easier tracking and reporting.","example":"This_is_my_merchant_transaction_group_id","type":"string","maxLength":50}},"components/schemas/nameVerificationResult":{"id":"components/schemas/nameVerificationResult","kind":"json-schema","title":"nameVerificationResult","data":{"description":"The outcome of the name verification process, which is a security measure to ensure that the cardholder's name matches the name on the card.","type":"string","enum":["NoInformationAvailable","FirstNameMatchedLastNameMatched","FirstNameMatchedLastNameNotMatched","FirstNameMatchedLastNameNotChecked","FirstNameMatchedLastNamePartialMatch","FirstNameNotMatchedLastNameMatched","FirstNameNotMatchedLastNameNotMatched","FirstNameNotMatchedLastNameNotChecked","FirstNameNotMatchedLastNamePartialMatch","FirstNameNotCheckedLastNameMatched","FirstNameNotCheckedLastNameNotMatched","FirstNameNotCheckedLastNameNotChecked","FirstNameNotCheckedLastNamePartialMatch","FirstNamePartialMatchLastNameMatched","FirstNamePartialMatchLastNameNotMatched","FirstNamePartialMatchLastNameNotChecked","FirstNamePartialMatchLastNamePartialMatch","FirstNamePartialMatchLastNamePartialMatch","FirstNamePartialMatchLastNamePartialMatch"],"example":"FirstNameMatchedLastNameMatched","x-readme-ref-name":"nameVerificationResult"}},"components/schemas/operation":{"id":"components/schemas/operation","kind":"json-schema","title":"operation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the operation to be applied to the previous transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported operations by funding type:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalCapture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Incremental"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paypal:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalCapture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Void"},"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":"Update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayByBank - Aeropay:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Incremental"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayByBank - SPEI:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]}],"enum":["Capture","FinalCapture","Incremental","Refund","Void","Authorisation","Update"],"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","x-readme-ref-name":"paymentAccountReference"}},"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","x-readme-ref-name":"providerResponseName"}},"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","x-readme-ref-name":"providerResponseCode"}},"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","x-readme-ref-name":"providerResponseMessage"}},"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","x-readme-ref-name":"providerResponseMerchantId"}},"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.","x-readme-ref-name":"providerTransactionId"}},"components/schemas/pointOfInteraction":{"id":"components/schemas/pointOfInteraction","kind":"json-schema","title":"pointOfInteraction","data":{"required":["entryType","interfaceSerialNumber","kernelApplicationVersion","deviceModelName","operatingSystemVersion","pointOfSaleId","pointOfSaleApplicationVersion","serialNumber"],"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":{"entryType":{"$ref":"#/components/schemas/cardPresentEntryType"},"interfaceSerialNumber":{"type":"string","description":"The serial number of the interface used for the transaction, typically associated with the hardware component of the device."},"kernelApplicationVersion":{"type":"string","description":"The version of the kernel application running on the device, which manages the card interaction process."},"deviceModelName":{"type":"string","description":"The device model name of the point of sale device used for processing the transaction.","example":"CastlesSaturn1000","enum":["CastlesSaturn1000"]},"operatingSystemVersion":{"type":"string","description":"The version of the operating system installed on the point of sale device."},"pointOfSaleId":{"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},"merchantPointOfSaleId":{"type":"string","description":"A merchant-specific identifier for the point of sale device.","example":"POS-001"},"pointOfSaleApplicationVersion":{"type":"string","description":"The version of the point of sale application software installed on the device.","example":"4.23.060.0","maxLength":20},"serialNumber":{"type":"string","description":"The serial number of the point of sale device, which uniquely identifies the hardware device."},"storeAndForward":{"description":"Contains response data related to an EMV (Europay, Mastercard, and Visa) transaction processed in-store. The store-and-forward mechanism allows transactions to be authorised offline when the device is unable to connect to the host. Once connectivity is restored, the transactions are forwarded to the PXP host for authorisation.","type":"object","properties":{"storeAndForwardType":{"$ref":"#/components/schemas/storeAndForwardType"},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"}}}},"x-readme-ref-name":"pointOfInteraction"}},"components/schemas/providerResponseAvsResult":{"id":"components/schemas/providerResponseAvsResult","kind":"json-schema","title":"providerResponseAvsResult","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Address Verification Service (AVS) result returned by the provider. This is a raw data indicating the outcome of the AVS check performed during the transaction processing. It will only be returned for card transactions where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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":"."},"children":[]}]}]}],"type":"string","example":"A","x-readme-ref-name":"providerResponseAvsResult"}},"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":"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":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No store and forward mechanism is used. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StoreAndForward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Used when the merchant is configured for transactions that fail to reach the PXP gateway. Transactions are securely stored offline until communication with the gateway is re-established. - "},"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","StoreAndForward","ForcedStoreAndForward"],"example":"StoreAndForward","type":"string","x-readme-ref-name":"storeAndForwardType"}},"components/schemas/emvDataResponse":{"id":"components/schemas/emvDataResponse","kind":"json-schema","title":"emvDataResponse","data":{"description":"Response data from an EMV (Europay, Mastercard, and Visa) transaction.","type":"object","properties":{"applicationIdentifier":{"description":"EMV Tag 9F06: Identifies the application according to ISO/IEC 7816-5.","type":"string","example":"A0000000031010"},"applicationLabel":{"description":"EMV Tag 50: Mnemonic associated with the Application Identifier (AID) according to ISO/IEC 7816-5.","type":"string","example":"VISA"},"primaryAccountNumberSequenceNumber":{"description":"EMV Tag 5F34: Identifies and differentiates cards with the same PAN.","type":"string","example":"01"},"authorisationResponseCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A two-digit code (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") indicating the result of the transaction authorisation, which may include approval, denial, or referral."},"children":[]}]}]}],"type":"string","example":"00"},"issuerAuthenticationData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"91"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") provided by the issuer to authenticate the transaction. This may include an authorisation response Cryptogram (ARPC)."},"children":[]}]}]}],"type":"string","example":"1234567890ABCDEF"},"issuerScriptTemplate1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer-provided script (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"71"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that can be used to update card parameters or perform specific actions on the card post authorisation."},"children":[]}]}]}],"type":"string","example":"710A1234567890ABCDEF"},"issuerScriptTemplate2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A second issuer-provided script (EMV tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"72"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that can be used for additional card updates or actions post authorisation."},"children":[]}]}]}],"type":"string","example":"720B1234567890ABCDEF12"}}}},"components/schemas/providerResponseCvcResult":{"id":"components/schemas/providerResponseCvcResult","kind":"json-schema","title":"providerResponseCvcResult","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Card Verification Code (CVC) result returned by the provider. This is a raw data indicating the outcome of the CVC check performed during the transaction processing. It will only be returned for card transactions where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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":"."},"children":[]}]}]}],"type":"string","example":"D","x-readme-ref-name":"providerResponseCvcResult"}},"components/schemas/psd2Data":{"id":"components/schemas/psd2Data","kind":"json-schema","title":"psd2Data","data":{"type":"object","description":"Contains PSD2-related information for the transaction, including any applicable Strong Customer Authentication (SCA) exemptions.","properties":{"scaExemption":{"type":"string","description":"Specifies the type of SCA exemption being requested for this transaction. Select the most applicable exemption type.","enum":["LowValue","OneLegOut","AnonymousCard","SecureCorporate","TransactionRiskAnalysis","TrustedBeneficiary"]}},"required":["scaExemption"],"x-readme-ref-name":"psd2Data"}},"components/schemas/recurring":{"id":"components/schemas/recurring","kind":"json-schema","title":"recurring","data":{"description":"The recurring payment details associated with the transaction.","properties":{"processingModel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of recurring payment associated with the transaction. When you first create a token, this indicates what type of recurring payment the token is intended for. For subsequent payments, it indicates the type of recurring payment. Specifically, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequencyInDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequencyExpiration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties are applicable only when this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantInitiatedInitialRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["cardOnFileShopperConsent","cardOnFileShopperInitiated","merchantInitiatedReAuthorisation","merchantInitiatedResubmission","merchantInitiatedDelayedCharge","merchantInitiatedNoShow","merchantInitiatedInitialRecurring","merchantInitiatedSubsequentRecurring"],"example":"merchantInitiatedInitialRecurring","type":"string"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"frequencyInDays":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the interval in days between each recurring transaction for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MerchantInitiatedInitialRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processing model. This defines how often the recurring payments are attempted following the initial charge."},"children":[]}]}]}],"example":30,"type":"integer","x-applicableTo":["MerchantInitiatedInitialRecurring"]},"frequencyExpiration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the expiration date for the recurring transaction authorisation specific to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantInitiatedInitialRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processing model. After this date, no further recurring transactions are processed."},"children":[]}]}]}],"example":"2025-12-31","type":"string","format":"date","x-applicableTo":["merchantInitiatedInitialRecurring"]},"settlementDate":{"type":"string","format":"date","description":"The date 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 YYYY-MM-DD.","example":"2024-01-25","x-readme-ref-name":"settlementDate"},"schemeTransactionLinkId":{"$ref":"#/components/schemas/schemeTransactionLinkId"}},"required":["processingModel"],"x-readme-ref-name":"recurring"}},"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","x-readme-ref-name":"schemeTransactionId"}},"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/schemeTokenNumberObject":{"id":"components/schemas/schemeTokenNumberObject","kind":"json-schema","title":"Scheme token number","data":{"title":"Scheme token number","type":"object","description":"Scheme token variant using a token number generated by card networks such as Visa or Mastercard, facilitating secure transaction processing through a numeric token identifier.","properties":{"schemeTokenNumber":{"type":"string","description":"A scheme token number issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.","example":"4837261112345678"},"expiryMonth":{"$ref":"#/components/schemas/schemeTokenExpiryMonth"},"expiryYear":{"$ref":"#/components/schemas/schemeTokenExpiryYear"},"cardVerificationCode":{"$ref":"#/components/schemas/cardVerificationCode"},"holderName":{"$ref":"#/components/schemas/cardHolderName"},"schemeTokenCryptogram":{"$ref":"#/components/schemas/schemeTokenCryptogram"},"dynamicDescriptors":{"$ref":"#/components/schemas/dynamicDescriptors"}},"required":["schemeTokenNumber","expiryMonth","expiryYear","cardScheme"],"x-readme-ref-name":"schemeTokenNumberObject"}},"components/schemas/schemeTokenIdObject":{"id":"components/schemas/schemeTokenIdObject","kind":"json-schema","title":"Scheme token ID","data":{"title":"Scheme token ID","type":"object","description":"Scheme token variant using a token ID generated by card networks such as Visa or Mastercard, facilitating secure transaction processing through a unique token identifier.","properties":{"schemeTokenId":{"type":"string","description":"A scheme token ID issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.","example":"4837261112345678"},"cardVerificationCode":{"$ref":"#/components/schemas/cardVerificationCode"},"dynamicDescriptors":{"$ref":"#/components/schemas/dynamicDescriptors"}},"required":["schemeTokenId"],"x-readme-ref-name":"schemeTokenIdObject"}},"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":"1234567890123456789012","x-readme-ref-name":"schemeTransactionLinkId"}},"components/schemas/schemeTokenNumber":{"id":"components/schemas/schemeTokenNumber","kind":"json-schema","title":"schemeTokenNumber","data":{"type":"string","description":"The scheme token number represents a scheme token issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.","example":"4837261112345678","x-readme-ref-name":"schemeTokenNumber"}},"components/schemas/schemeTokenCryptogram":{"id":"components/schemas/schemeTokenCryptogram","kind":"json-schema","title":"schemeTokenCryptogram","data":{"type":"string","description":"A unique cryptogram generated during the tokenisation process, utilized for enhancing the security of transaction processing. This cryptogram acts as a secure and unique identifier, akin to the TAVV, ensuring that each transaction is authenticated and verified without directly using sensitive card details. It plays a crucial role in the secure electronic payment ecosystem, especially in tokenised transactions, by providing an additional layer of security and authentication.","example":"AAEBAwQjSQAAXXXXXXXJYe0BbQA=","x-readme-ref-name":"schemeTokenCryptogram"}},"components/schemas/settlementDate":{"id":"components/schemas/settlementDate","kind":"json-schema","title":"settlementDate","data":{"type":"string","format":"date","description":"The date 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 YYYY-MM-DD.","example":"2024-01-25","x-readme-ref-name":"settlementDate"}},"components/schemas/shopper":{"id":"components/schemas/shopper","kind":"json-schema","title":"shopper","data":{"description":"Details of the shopper involved in the transaction.","properties":{"dateOfBirth":{"description":"The date of birth of the shopper. Format should be YYYY-MM-DD.","format":"date","maxLength":10,"minLength":10,"type":"string"},"email":{"description":"The email address of the shopper.","example":"shopper@example.com","format":"email","maxLength":100,"type":"string"},"firstName":{"description":"The first name of the shopper.","example":"John","maxLength":100,"type":"string"},"lastName":{"description":"The last name of the shopper.","example":"Doe","maxLength":100,"type":"string"},"id":{"description":"The unique identifier of the shopper.","example":"Shopper_01","maxLength":50,"type":"string"},"houseNumberOrName":{"description":"The house number or name associated with the shopper's address. This field supports up to 100 characters to accommodate various global addressing formats.","example":"10","type":"string","maxLength":100},"street":{"description":"The street associated with the shopper's address.","example":"Downing Street","type":"string","maxLength":100},"addressLine2":{"description":"The second line of the shopper's address.","example":"Flat 3","type":"string","maxLength":100},"city":{"description":"The city associated with the shopper's address.","example":"London","type":"string","maxLength":100},"postalCode":{"description":"The postal code of the shopper's address. This field accepts up to 5 digits for US addresses or up to 10 characters for addresses in other countries, accommodating global variations in postal code formats.","example":"SW1A 2AA","type":"string","maxLength":10},"state":{"description":"The state or province associated with the shopper's address. This field should be formatted using the ISO 3166-2 standard, which provides worldwide codes for the principal subdivisions of all countries. For example, US-CA for California, or IN-MH for Maharashtra. This is optional and specific to certain countries.\n","minLength":2,"maxLength":2,"example":"CA","type":"string"},"countryCode":{"description":"The country code identifying the country associated with the shopper's address, in ISO-3166-1 alpha-2 format.","example":"GB","minLength":2,"maxLength":2,"type":"string"},"phoneNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopper's phone number. For SPEI, required in E.164 format (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+5215555555555"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"+447911123456","type":"string","maxLength":50},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopper identity document type. Used for SPEI only. For SPEI, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxIdNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Mexican RFC) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CivilRegisterId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Mexican CURP) are accepted. When supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also required. Omit for other payment methods."},"children":[]}]}]}],"type":"string","enum":["TaxIdNumber","CivilRegisterId"],"example":"TaxIdNumber"},"documentNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shopper identity document number. Used for SPEI only. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied. For SPEI, exactly 13 alphanumeric characters for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxIdNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RFC), or exactly 18 alphanumeric characters for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CivilRegisterId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CURP). Omit for other payment methods."},"children":[]}]}]}],"type":"string","example":"HEGJ850101ABC","maxLength":18},"products":{"description":"Details about the products associated with the shopper.","type":"object","additionalProperties":{"type":"string"}},"orderDescription":{"description":"A description of the order.","type":"string"}},"type":"object","x-readme-ref-name":"shopper"}},"components/schemas/shopperSecurityData":{"id":"components/schemas/shopperSecurityData","kind":"json-schema","title":"shopperSecurityData","data":{"description":"Security-related information to enhance transaction safety and fraud prevention.","required":["ipAddress","deviceFingerprint"],"properties":{"ipAddress":{"description":"The IP address of the shopper's device, used to analyse transaction patterns and detect potential fraud based on geographical and behavioural insights.","example":"192.168.1.1","type":"string","maxLength":15},"deviceFingerprint":{"description":"A hashed value representing a unique identifier for the shopper's device, generated from a combination of device characteristics.","example":"4eb53ed8428b6fed13a6952177640972248af1001a3fc72eaf57ad5c09d54bcd","type":"string","maxLength":100}},"type":"object","x-readme-ref-name":"shopperSecurityData"}},"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","x-readme-ref-name":"site"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"state","data":{"description":"The current state of the transaction.","enum":["Authorised","Refused","Cancelled","Captured","Error","Executed","Pending","Refunded","Updated","Rejected","Approved","Aborted","Expired","Declined","Referred"],"example":"Authorised","type":"string","x-readme-ref-name":"state"}},"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/transactions/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"},"gatewayTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A PXP reference to the destination bank account used for a SPEI payout. Present on every accepted SPEI payout create response. Capture it and reuse it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData.payByBank.gatewaytokenid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a later payout to the same destination. Not returned on query responses or idempotent create replays."},"children":[]}]}]}],"type":"string","example":"b6e2f1a4c3d84f7ab1e9d2c3f4a5b6c7"}},"example":{"code":"CRD000","message":"Approved"},"x-readme-ref-name":"stateData"}},"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","APM4100","APM4101","APM4102","APM4103","APM4104","APM4105","APM4106","APM001","APM004","APM007","APM011","APM012","APM013"],"x-readme-ref-name":"stateDataCode"}},"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","An internal server error occurred.","The server has detected a conflict while processing this request.","Authentication failed due to missing authorization header, or invalid authentication credentials.","Request is not well-formed, syntactically incorrect, or violates schema.","Authorization failed due to insufficient permissions.","The requested action could not be performed, semantically incorrect, or failed business validation.","The specified resource does not exist."],"x-readme-ref-name":"stateDataMessage"}},"components/schemas/systemTransactionId":{"id":"components/schemas/systemTransactionId","kind":"json-schema","title":"systemTransactionId","data":{"description":"A unique identifier generated by PXP for each transaction. It serves as a reference for tracking and querying transactions within the PXP system. This ID is crucial for performing modifications or querying transaction details.","example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","minLength":36,"maxLength":40,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string","x-readme-ref-name":"systemTransactionId"}},"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":"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","x-readme-ref-name":"transaction"}},"components/schemas/modificationTransaction":{"id":"components/schemas/modificationTransaction","kind":"json-schema","title":"modificationTransaction","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the 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":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPEI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refunds, this must be the same as the original transaction amount (only full refunds are supported)."},"children":[]}]}]}],"example":30.32,"type":"number","x-readme-ref-name":"modificationTransaction"}},"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"],"x-readme-ref-name":"transactionMethod"}},"components/schemas/threeDSecureData":{"id":"components/schemas/threeDSecureData","kind":"json-schema","title":"threeDSecureData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about 3D Secure for e-commerce transactions. Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (from PXP 3D Secure) or inline authentication fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digital wallets:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay (encrypted):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threeDSecureData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay (decrypted):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderAuthenticationVerificationValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electronicCommerceIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google Pay (decrypted):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If the decrypt response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodDetails.cryptogram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", map it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderAuthenticationVerificationValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodDetails.eciIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electronicCommerceIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from PXP 3D Secure."},"children":[]}]}]}]}],"properties":{"cardHolderAuthenticationVerificationValue":{"$ref":"#/components/schemas/cardHolderAuthenticationVerificationValue"},"directoryServerTransactionId":{"$ref":"#/components/schemas/directoryServerTransactionId"},"electronicCommerceIndicator":{"$ref":"#/components/schemas/electronicCommerceIndicator"},"threeDSecureVersion":{"$ref":"#/components/schemas/threeDSecureVersion"},"threeDSecureTransactionStatus":{"$ref":"#/components/schemas/threeDSecureTransactionStatus"},"authenticationId":{"$ref":"#/components/schemas/authenticationId"}},"x-readme-ref-name":"threeDSecureData"}},"components/schemas/dccData":{"id":"components/schemas/dccData","kind":"json-schema","title":"dccData","data":{"type":"object","description":"Details about the Dynamic Currency Conversion (DCC).","properties":{"rateSelectedIndicator":{"type":"string","enum":["NotSelected","Selected","NotAvailable","CardNotEligible","Error"],"description":"Whether a DCC rate was selected for the transaction.","example":"Selected","x-readme-ref-name":"rateSelectedIndicator"},"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 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":1,"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":100},"currencyCode":{"type":"string","description":"The currency code in ISO 4217 format.","example":"USD","minLength":1,"maxLength":3}},"required":["transaction","currencyCode"]}},"required":["local","cardholder"],"x-readme-ref-name":"amounts"},"exchangeRate":{"type":"number","description":"The exchange rate used for the DCC.","example":0.855},"providerData":{"type":"object","description":"Details about the DCC provider.","properties":{"provider":{"type":"string","description":"The name of the DCC provider.","example":"Elavon"},"referenceId":{"type":"string","description":"The reference ID provided by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.","example":"REF123456789"},"merchantId":{"type":"string","description":"The merchant ID assigned by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.","example":"MERCH001"},"terminalId":{"type":"string","description":"The terminal ID assigned by the DCC provider. This is required if your provider is Elavon, otherwise it's ignored.","example":"TERM001"},"markupTextIndicator":{"type":"integer","description":"The markup text indicator for the DCC provider.","example":1}},"required":["provider"]},"markupRate":{"type":"number","description":"The mark-up rate.","example":3.92,"nullable":true},"disclaimer":{"type":"string","description":"The disclaimer text.","example":"This is an example disclaimer.","nullable":true}},"required":["rateSelectedIndicator","amounts","exchangeRate","providerData"],"x-readme-ref-name":"dccData"}},"components/schemas/riskScreeningData":{"id":"components/schemas/riskScreeningData","kind":"json-schema","title":"riskScreeningData","data":{"type":"object","description":"Details about the transaction for risk screening purposes.","properties":{"excludeDeviceData":{"type":"boolean","description":"Whether to exclude device fingerprinting data from analysis.","example":false},"performRiskScreening":{"type":"boolean","description":"Whether to enable risk screening for this transaction.","example":true},"deviceSessionId":{"type":"string","description":"The unique session identifier for the customer's end-user session on your site or app. This must be the same session ID used in the device data collection from the client-side Kount SDK.","example":"sadfw343434","pattern":"^[0-9A-Za-z]*$","maxLength":256},"items":{"type":"array","description":"Array of details about the items included in the transaction.","items":{"type":"object","description":"Details about the item.","properties":{"price":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of the single item in the lowest currency factor. For example, the lowest currency in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is pennies, so $1.00 would have the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a natural number including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":95,"minimum":0},"quantity":{"type":"integer","description":"The quantity of the item being purchased.","example":1,"minimum":1},"category":{"type":"string","description":"A high-level or generalised description of the item.","example":"Electronics"},"sku":{"type":"string","description":"The item's Stock Keeping Unit identifier (SKU).","example":"ELEC123"}}}},"fulfillments":{"type":"array","description":"Array of details about the fulfillment of the order.","items":{"type":"object","description":"Details about the fulfillment.","properties":{"type":{"type":"string","description":"The type of fulfillment.","enum":["Shipped","Digital","StorePickUp","LocalDelivery","StoreDriveUp","InPerson"],"example":"Shipped"},"recipientPerson":{"type":"object","description":"Details about the order's recipient.","properties":{"name":{"type":"object","description":"Details about the recipient's name.","properties":{"first":{"type":"string","description":"The recipient's first name.","example":"John"},"middle":{"type":"string","description":"The recipient's middle name or initial.","example":"A"},"family":{"type":"string","description":"The recipient's family/last name.","example":"Doe"},"prefix":{"type":"string","description":"The prefix of the recipient's name.","example":"Mr"},"suffix":{"type":"string","description":"The suffix of the recipient's name.","example":null},"preferred":{"type":"string","description":"The recipient's preferred name.","example":"John"}}},"address":{"type":"object","description":"Details about the recipient's address.","properties":{"line1":{"type":"string","description":"The first line of the address."},"line2":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city of the address."},"region":{"type":"string","description":"The state, province, or region code of the address."},"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"The country of the address, in ISO 3166-1 alpha-2 format."},"postalCode":{"type":"string","description":"The postal or ZIP code of the address."}}},"email":{"type":"string","description":"The recipient's email address.","example":"john.doe@pxp.io"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","example":"00359885674367"}}}}}},"transaction":{"type":"object","description":"Details about the transaction.","properties":{"subtotal":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the order without shipping and tax included, in its lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a total of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The total must be a natural number, which includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":95}}},"customFields":{"type":"object","description":"Additional custom fields for risk screening. Can contain any key-value pairs specific to your business requirements.","additionalProperties":true}},"x-readme-ref-name":"riskScreeningData"}},"components/schemas/cardFundingDataResponse":{"id":"components/schemas/cardFundingDataResponse","kind":"json-schema","title":"Card funding data (response)","data":{"title":"Card funding data (response)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card and Cage response funding details, returned at the root of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primaryAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is obfuscated when present."},"children":[]}]}]}],"type":"object","properties":{"cardScheme":{"$ref":"#/components/schemas/cardScheme"},"primaryAccountNumber":{"description":"The Primary Account Number (PAN) of the card used for the transaction. Obfuscated when present.","type":"string","example":"************1111"},"expiryMonth":{"$ref":"#/components/schemas/expiryMonth"},"expiryYear":{"$ref":"#/components/schemas/expiryYear"},"gatewayTokenId":{"$ref":"#/components/schemas/gatewayTokenId"},"schemeTokenNumber":{"$ref":"#/components/schemas/schemeTokenNumber"},"cardVerificationCodeResult":{"$ref":"#/components/schemas/cardVerificationCodeResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/addressVerificationServiceResult"},"providerResponse":{"$ref":"#/components/schemas/cardProviderResponse"}}}},"components/schemas/payByBankFundingDataResponse":{"id":"components/schemas/payByBankFundingDataResponse","kind":"json-schema","title":"Pay-by-bank funding data (response)","data":{"title":"Pay-by-bank funding data (response)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-by-bank response funding details wrapped under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData.payByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["payByBank"],"properties":{"payByBank":{"type":"object","description":"Pay-by-bank funding outcome for the transaction.","required":["apmProvider"],"properties":{"apmProvider":{"$ref":"#/components/schemas/apmProvider"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider-reported status for the pay-by-bank transaction. On SPEI query responses this mirrors the root "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"Authorised"},"redirectUrl":{"description":"Hosted page URL where the shopper completes a SPEI Purchase transfer. Present on successful Purchase create responses. Omitted for Payout (no browser step) and may be omitted once the transaction has moved past the initial redirect stage.","type":"string","format":"uri","example":"https://hosted-payment-page.example/spei/..."},"paymentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OKTO's own payment identifier for this operation (deposit, payout, or refund), returned unchanged from OKTO. Present on Purchase, Payout, Refund, and query responses. Informational only — always use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for subsequent PXP API calls."},"children":[]}]}]}],"type":"string","example":"6f2b6d0a-8b1a-4e2b-9c3d-0a1b2c3d4e5f"},"processorPaymentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OKTO's underlying clearing/processor reference for this operation, returned unchanged from OKTO. Same value as the response-root "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"providerTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when both are present. Always present for Purchase; omitted on the immediate Payout create response until a later query after background status check; present for Refund only when the post-refund lookup succeeds. Omitted (never null) when unknown. Informational only — always use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for subsequent PXP API calls."},"children":[]}]}]}],"type":"string","example":"9a4c7e21-3f5d-4b8e-8a1c-2d3e4f5a6b7c"},"paymentAgreementId":{"description":"Unity-owned payment-agreement identifier for providers that return reusable agreements.","type":"string","format":"uuid"},"paymentInstrumentId":{"description":"Unity-owned payment-instrument identifier for providers that return reusable instruments.","type":"string","format":"uuid"}}}}}},"components/schemas/fundingDataResponse":{"id":"components/schemas/fundingDataResponse","kind":"json-schema","title":"fundingDataResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding details returned on create, modify, and query responses. Card responses use flat card fields at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" root. Pay-by-bank responses wrap details under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData.payByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"title":"Card","$ref":"#/components/schemas/cardFundingDataResponse"},{"title":"Pay by bank","$ref":"#/components/schemas/payByBankFundingDataResponse"}]}},"schema_142":{"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]}],"properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"merchantTransactionGroupId":{"$ref":"#/components/schemas/merchantTransactionGroupId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"transactionMethod":{"$ref":"#/components/schemas/transactionMethod"},"fundingData":{"$ref":"#/components/schemas/fundingData"},"addressVerification":{"$ref":"#/components/schemas/addressVerification"},"identityVerification":{"$ref":"#/components/schemas/identityVerification"},"amounts":{"$ref":"#/components/schemas/amounts"},"shopper":{"$ref":"#/components/schemas/shopper"},"shopperSecurityData":{"$ref":"#/components/schemas/shopperSecurityData"},"recurring":{"$ref":"#/components/schemas/recurring"},"threeDSecureData":{"$ref":"#/components/schemas/threeDSecureData"},"psd2Data":{"$ref":"#/components/schemas/psd2Data"},"dccData":{"$ref":"#/components/schemas/dccData"},"riskScreeningData":{"$ref":"#/components/schemas/riskScreeningData"}},"required":["fundingData","amounts","merchant","merchantTransactionId","merchantTransactionDate","site","transactionMethod"],"type":"object","x-readme-ref-name":"transactionRequest"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"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/fundingDataResponse"},"dccData":{"type":"object","description":"Details about the DCC (Dynamic Currency Conversion).","properties":{"dccSelectedIndicator":{"type":"string","description":"Whether a DCC rate was selected.","enum":["NotSelected","Selected","NotAvailable","CardNotEligible","Error"],"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 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","maxLength":3}}},"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","maxLength":3}}}}},"providerData":{"type":"object","description":"Details about the DCC provider.","properties":{"provider":{"type":"string","description":"The name of the DCC provider.","example":"Elavon"},"referenceId":{"type":"string","description":"The reference ID provided by the DCC provider.","example":"REF123456789"},"merchantId":{"type":"string","description":"The merchant ID assigned by the DCC provider.","example":"MERCH001"},"terminalId":{"type":"string","description":"The terminal ID assigned by the DCC provider.","example":"TERM001"},"markupTextIndicator":{"type":"integer","description":"The markup text indicator for the DCC provider.","example":1}}},"exchangeRate":{"type":"number","description":"The exchange rate used for the DCC.","example":1.0778},"markupRate":{"type":"number","description":"The markup rate applied.","example":3},"disclaimer":{"type":"string","description":"Disclaimer text for DCC.","example":"Exchange rate includes 3% margin."}},"required":["exchangeRate"]}},"required":["systemTransactionId","merchantTransactionId","merchantTransactionDate"],"x-readme-ref-name":"transactionResponse"},"id":"schema_143"},"schema_144":{"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":{"$ref":"#/components/schemas/correlationId"},"details":{"$ref":"#/components/schemas/details"},"errorCode":{"$ref":"#/components/schemas/errorCode"},"errorReason":{"$ref":"#/components/schemas/errorReason"}},"required":["correlationId","errorCode","errorReason"],"type":"object","x-readme-ref-name":"error"},"id":"schema_144"},"schema_145":{"kind":"json-schema","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","x-readme-ref-name":"systemTransactionId"},"id":"schema_145"},"schema_146":{"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":"The modification request contains details required to perform a modification on a transaction, such as a refund, increment, void, capture, or authorisation. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation is available exclusively for PayPal transactions."},"children":[]}]}]}],"required":["merchant","amounts","merchantTransactionId","operation","site","fundingType"],"properties":{"fundingType":{"description":"The type of funding source used for the transaction.","type":"string","enum":["Card","Paypal","PayByBank"],"example":"Card"},"apmProvider":{"$ref":"#/components/schemas/apmProvider"},"amounts":{"$ref":"#/components/schemas/modificationAmounts"},"merchant":{"$ref":"#/components/schemas/merchant"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"merchantTransactionGroupId":{"$ref":"#/components/schemas/merchantTransactionGroupId"},"operation":{"$ref":"#/components/schemas/operation"},"site":{"$ref":"#/components/schemas/site"},"remark":{"description":"Optional remark or note about the modification.","type":"string","example":"Customer requested partial refund","nullable":true},"data":{"description":"Optional key-value pairs for additional data.","type":"object","additionalProperties":true,"example":{},"nullable":true},"dccData":{"$ref":"#/components/schemas/dccData"},"currencyCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code for the modification amount, in ISO 4217 format. For SPEI refunds, this must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MXN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"MXN","minLength":3,"maxLength":3}},"type":"object","x-readme-ref-name":"modificationRequest"},"id":"schema_146"},"schema_147":{"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":{"$ref":"#/components/schemas/state"},"stateData":{"$ref":"#/components/schemas/stateData"},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"providerTransactionId":{"$ref":"#/components/schemas/providerTransactionId"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"amounts":{"description":"Details of the various amounts associated with the transaction.","type":"object","properties":{"transaction":{"$ref":"#/components/schemas/transaction"},"currencyCode":{"description":"The currency code in ISO 4217 format.","type":"string","example":"EUR","minLength":3,"maxLength":3},"shipping":{"description":"The shipping amount.","type":"number","format":"double","example":5,"nullable":true},"gratuity":{"$ref":"#/components/schemas/gratuity"},"cashback":{"description":"The cashback amount.","type":"number","format":"double","example":10,"nullable":true},"cash":{"description":"The cash amount.","type":"number","format":"double","example":50,"nullable":true},"chip":{"description":"The chip amount.","type":"number","format":"double","example":5,"nullable":true},"cheque":{"description":"The cheque amount.","type":"number","format":"double","example":20,"nullable":true},"winningTicket":{"description":"The winning ticket amount.","type":"number","format":"double","example":100,"nullable":true},"serviceCharge":{"description":"Details of any service charge applied to the transaction.","type":"object","properties":{"amount":{"description":"The service charge amount.","type":"number","format":"double","example":10},"percentage":{"description":"The service charge percentage.","type":"integer","example":10}},"required":["amount","percentage"],"nullable":true}},"required":["currencyCode"]},"fundingData":{"$ref":"#/components/schemas/fundingDataResponse"},"riskScreeningData":{"description":"Details about risk screening results for the transaction.","type":"object","properties":{"riskScreeningId":{"description":"The unique identifier for the risk screening.","type":"string","example":"RISK-123456","nullable":true},"providerResults":{"description":"Results from risk screening providers.","type":"object","properties":{"kount":{"description":"Risk screening results from Kount.","type":"object","properties":{"decision":{"description":"The decision from Kount risk screening.","type":"string","example":"APPROVED","nullable":true},"riskScore":{"description":"The risk score assigned by Kount.","type":"number","format":"double","example":25.5,"nullable":true},"rawResponse":{"description":"The raw response from Kount.","type":"string","example":"AUTO=A&SCOR=25","nullable":true}},"nullable":true}},"nullable":true}},"nullable":true},"dccData":{"description":"Dynamic Currency Conversion data for the transaction response.","type":"object","properties":{"dccSelectedIndicator":{"description":"Indicates whether a DCC rate was selected.","type":"string","enum":["NotSelected","Selected","ErrorRetrievingDccData","DccNotEligible","InvalidDccTerminalId","InvalidDccMerchantId","NoDccSupported","NoDccRateAvailable","ServerErrorRetrievingDccData","InvalidDccRequest","DccTimeout"],"example":"Selected","nullable":true},"amounts":{"description":"Amount details in local and cardholder currencies.","type":"object","properties":{"local":{"description":"Local currency amounts.","type":"object","properties":{"transaction":{"description":"Transaction amount in local currency.","type":"number","format":"double","example":45,"nullable":true},"currencyCode":{"description":"Local currency code in ISO 4217 format.","type":"string","example":"EUR","nullable":true}},"nullable":true},"cardholder":{"description":"Cardholder currency amounts.","type":"object","properties":{"transaction":{"description":"Transaction amount in cardholder currency.","type":"number","format":"double","example":48.5,"nullable":true},"currencyCode":{"description":"Cardholder currency code in ISO 4217 format.","type":"string","example":"USD","nullable":true}},"nullable":true}},"nullable":true},"providerData":{"description":"Provider-specific DCC data.","type":"object","properties":{"provider":{"description":"The DCC provider name.","type":"string","example":"FEXCO","nullable":true},"referenceId":{"description":"Provider reference ID.","type":"string","example":"RATE789012","nullable":true},"merchantId":{"description":"Provider merchant ID.","type":"string","example":"MERCH001","nullable":true},"terminalId":{"description":"Provider terminal ID.","type":"string","example":"TERM001","nullable":true},"markupTextIndicator":{"description":"Markup text indicator.","type":"integer","example":1,"nullable":true}},"nullable":true},"providerResponse":{"description":"Additional provider response data for DCC.","type":"object","properties":{"provider":{"description":"The provider name.","type":"string","example":"FEXCO","nullable":true},"merchantId":{"description":"Merchant ID from provider response.","type":"string","example":"MERCH001","nullable":true},"terminalId":{"description":"Terminal ID from provider response.","type":"string","example":"TERM001","nullable":true},"settlementDate":{"description":"Settlement date from provider.","type":"string","format":"date-time","example":"2025-12-04T00:00:00Z","nullable":true},"merchantAdvice":{"description":"Merchant advice from provider.","type":"string","example":"00","nullable":true},"schemeTransactionLinkId":{"description":"Scheme transaction link ID.","type":"string","example":"LINK123456","nullable":true},"electronicCommerceIndicatorAdjustment":{"description":"Electronic commerce indicator adjustment.","type":"string","example":"05","nullable":true},"schemeTransactionId":{"description":"Scheme transaction ID.","type":"string","example":"TX1234567890","nullable":true},"paymentAccountReference":{"description":"Payment account reference.","type":"string","example":"PAR12345678901234567890","nullable":true},"cardVerificationCodeResult":{"description":"Card verification code result.","type":"string","example":"M","nullable":true},"addressVerificationServiceResult":{"description":"Address verification service result.","type":"string","example":"Y","nullable":true},"emvDataResponse":{"description":"EMV data from the provider response.","type":"object","properties":{"applicationIdentifier":{"description":"EMV application identifier.","type":"string","example":"A0000000031010","nullable":true},"applicationLabel":{"description":"EMV application label.","type":"string","example":"VISA DEBIT","nullable":true},"primaryAccountNumberSequenceNumber":{"description":"PAN sequence number.","type":"string","example":"01","nullable":true},"authorisationResponseCode":{"description":"Authorization response code.","type":"string","example":"00","nullable":true},"issuerAuthenticationData":{"description":"Issuer authentication data.","type":"string","example":"0123456789ABCDEF","nullable":true},"issuerScriptTemplate1":{"description":"Issuer script template 1.","type":"string","example":"","nullable":true},"issuerScriptTemplate2":{"description":"Issuer script template 2.","type":"string","example":"","nullable":true}},"nullable":true}},"nullable":true},"exchangeRate":{"description":"The exchange rate applied.","type":"number","format":"double","example":1.0778},"markupRate":{"description":"The markup rate applied.","type":"number","format":"double","example":3,"nullable":true},"disclaimer":{"description":"Disclaimer text for DCC.","type":"string","example":"Exchange rate includes 3% margin.","nullable":true}},"required":["exchangeRate"],"nullable":true},"shippingAddress":{"description":"Shipping address details.","type":"object","properties":{"addressLine1":{"description":"First line of the shipping address.","type":"string","example":"123 Main St","nullable":true},"addressLine2":{"description":"Second line of the shipping address.","type":"string","example":"Apt 4B","nullable":true},"postalCode":{"description":"Postal code.","type":"string","example":"12345","nullable":true},"countryCode":{"description":"Country code in ISO 3166-1 alpha-2 format.","type":"string","example":"US","nullable":true},"city":{"description":"City name.","type":"string","example":"New York","nullable":true},"county":{"description":"County name.","type":"string","example":"New York County","nullable":true},"state":{"description":"State or province.","type":"string","example":"NY","nullable":true}},"nullable":true}},"required":["state","systemTransactionId","merchantTransactionId","merchantTransactionDate"],"x-readme-ref-name":"modificationResponse"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"description":"This response denotes an unauthorised 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","x-readme-ref-name":"inline_response_401"},"id":"schema_148"},"schema_149":{"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":{"description":"The error code returned for the operation.","example":"INVALID_REQUEST","type":"string","x-readme-ref-name":"errorCode"},"errorReason":{"description":"The error reason returned for the operation.","example":"One or more validation errors occurred.","type":"string","x-readme-ref-name":"errorReason"}},"type":"object","x-readme-ref-name":"inline_response_422"},"id":"schema_149"},"schema_150":{"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":{"description":"The error code returned for the operation.\n","example":"INVALID_REQUEST","type":"string","x-readme-ref-name":"errorCode"},"errorReason":{"description":"The error reason returned for the operation.\n","example":"One or more validation errors occurred.","type":"string","x-readme-ref-name":"errorReason"}},"type":"object","x-readme-ref-name":"inline_response_500"},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"$ref":"#/components/schemas/merchant"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"$ref":"#/components/schemas/site"},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"$ref":"#/components/schemas/merchantTransactionId"},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"$ref":"#/components/schemas/systemTransactionId"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"$ref":"#/components/schemas/fundingType"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"$ref":"#/components/schemas/apmProvider"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"array","maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction lookup result. Contains zero items if no matching transaction is found, or one item when a match is found. When querying by identifier, expect either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a single-element array."},"children":[]}]}]}],"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object provides comprehensive details regarding the status and data associated with the transaction. It includes information about the current state of the transaction, transaction-specific details, funding data related information, and the response received from the payment provider."},"children":[]}]}]}],"properties":{"state":{"$ref":"#/components/schemas/state"},"stateData":{"$ref":"#/components/schemas/stateData"},"transactionMethod":{"description":"Details about the transaction method, including the entry type, funding type, and intent.","type":"object","properties":{"entryType":{"description":"The entry type for the transaction.","type":"string","example":"Ecom","enum":["Ecom","Moto","Instore"]},"fundingType":{"description":"The funding type used for the transaction.","type":"string","example":"Card","enum":["Card","Wallet","PayByBank"]},"intent":{"description":"The transaction intent.","type":"string","example":"Authorisation","enum":["Authorisation","Purchase","EstimatedAuthorisation","Verification","Payout"]}}},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"entryType":{"$ref":"#/components/schemas/cardPresentEntryType"},"providerTransactionId":{"$ref":"#/components/schemas/providerTransactionId"},"fundingData":{"$ref":"#/components/schemas/fundingDataResponse"}},"required":["systemTransactionId","merchantTransactionId","merchantTransactionDate"],"type":"object","x-readme-ref-name":"transactionResponse"}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"string","maxLength":50,"example":"MERCHANT-1","x-readme-ref-name":"merchant"},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"string","example":"SITE-1","x-readme-ref-name":"site"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"string","example":"paypal","x-readme-ref-name":"fundingType"},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"string","minLength":36,"maxLength":40,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","x-readme-ref-name":"systemTransactionId"},"id":"schema_161"},"schema_162":{"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":"Order details for the transaction. Identifiers are top-level; provider-specific funding is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"providerTransactionId":{"$ref":"#/components/schemas/providerTransactionId"},"fundingData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider-specific order funding details (e.g., PayPal shipping and payment source fields). The exact shape depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true}}},"id":"schema_162"}},"exampleStore":{"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation","summary":"Ecom - Card authorisation","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","dynamicDescriptors":{"cardAcceptorName":"ACME LTD"}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (with dynamic descriptor)","summary":"Ecom - Card authorisation (with dynamic descriptor)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with dynamic descriptor)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"},"shopperSecurityData":{"ipAddress":"127.2.5.10","deviceFingerprint":"4eb53ed8428b6fed13a6952177640972248af1001a3fc72eaf57ad5c09d54bcd"}},"key":"Ecom - Card authorisation (Shopper Security Data)","summary":"Ecom - Card authorisation (Shopper Security Data)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Shopper Security Data)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Gateway Token)","summary":"Ecom - Card authorisation (Gateway Token)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Gateway Token)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"schemeTokenNumber":"4837261112345678","expiryMonth":"03","expiryYear":"2027","cardScheme":"Visa"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b","electronicCommerceIndicator":"07","threeDSecureVersion":"2.1.0"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Scheme Token without Token Cryptogram)","summary":"Ecom - Card authorisation (Scheme Token without Token Cryptogram)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Token without Token Cryptogram)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"schemeTokenNumber":"4837261112345678","expiryMonth":"03","expiryYear":"2027","cardScheme":"Visa","schemeTokenCryptogram":"AAEBAwQjSQAAXXXXXXXJYe0BbQA="}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b","electronicCommerceIndicator":"07","threeDSecureVersion":"2.1.0"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","summary":"Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Scheme Tokenisation with Token Cryptogram)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"John Doe","walletType":"ApplePay"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","electronicCommerceIndicator":"05"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Apple Pay decrypted token)","summary":"Ecom - Card authorisation (Apple Pay decrypted token)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay decrypted token)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"John Doe","walletType":"GooglePay"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Google Pay decrypted token)","summary":"Ecom - Card authorisation (Google Pay decrypted token)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Google Pay decrypted token)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"applePayToken":"{\"version\":\"EC_v1\",\"data\":\"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0...\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQEx...\",\"header\":{\"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\",\"publicKeyHash\":\"h0j3M6S0X8/x...\",\"transactionId\":\"32b030ca0603b2c5f0e2c5c8f0c0e0c0\"}}"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Apple Pay encrypted token)","summary":"Ecom - Card authorisation (Apple Pay encrypted token)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Apple Pay encrypted token)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (CVC)","summary":"Ecom - Card authorisation (CVC)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (CVC)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (AVS)","summary":"Ecom - Card authorisation (AVS)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (AVS)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (3DS2)","summary":"Ecom - Card authorisation (3DS2)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (3DS2)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"07","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"psd2Data":{"scaExemption":"LowValue"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (with SCA Exemption)","summary":"Ecom - Card authorisation (with SCA Exemption)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (with SCA Exemption)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"cardOnFileShopperConsent","schemeTransactionId":"TX1234567890123456"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Card on File with Shoppers Consent)","summary":"Ecom - Card authorisation (Card on File with Shoppers Consent)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shoppers Consent)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"countryCode":"GB","houseNumberOrName":"120","postalCode":"EN87JJ"},"recurring":{"processingModel":"cardOnFileShopperInitiated","schemeTransactionId":"TX1234567890123456"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Card on File with Shopper Initiated)","summary":"Ecom - Card authorisation (Card on File with Shopper Initiated)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Card on File with Shopper Initiated)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedReAuthorisation","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","summary":"Ecom - Card authorisation (Merchant Initiated Re-Authorisation)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Re-Authorisation)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedResubmission","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Merchant Initiated Resubmission)","summary":"Ecom - Card authorisation (Merchant Initiated Resubmission)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Resubmission)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedDelayedCharge","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Merchant Initiated Delayed Charge)","summary":"Ecom - Card authorisation (Merchant Initiated Delayed Charge)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Delayed Charge)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedNoShow","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Merchant Initiated No Show)","summary":"Ecom - Card authorisation (Merchant Initiated No Show)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated No Show)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedSubsequentRecurring","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","summary":"Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card authorisation (Merchant Initiated Subsequent Recurring)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase","summary":"Ecom - Card purchase","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (with Gateway Tokenisation)","summary":"Ecom - Card purchase (with Gateway Tokenisation)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with Gateway Tokenisation)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (with CVC)","summary":"Ecom - Card purchase (with CVC)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with CVC)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (with AVS)","summary":"Ecom - Card purchase (with AVS)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with AVS)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (with 3DS 2 Data)","summary":"Ecom - Card purchase (with 3DS 2 Data)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with 3DS 2 Data)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"cardOnFileShopperConsent","schemeTransactionId":"TX1234567890123456"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Card on File with Shoppers Consent)","summary":"Ecom - Card purchase (Card on File with Shoppers Consent)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shoppers Consent)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"countryCode":"GB","houseNumberOrName":"120","postalCode":"EN87JJ"},"recurring":{"processingModel":"cardOnFileShopperInitiated","schemeTransactionId":"TX1234567890123456"},"threeDSecureData":{"threeDSecureVersion":"2.1.0","electronicCommerceIndicator":"05","cardHolderAuthenticationVerificationValue":"MjAwNjI0MDkwMTEwMjA4NjU0MTY=","directoryServerTransactionId":"f25084f0-5b16-4c0a-ae5d-b24808a95e4b"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Card on File with Shopper Initiated)","summary":"Ecom - Card purchase (Card on File with Shopper Initiated)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Card on File with Shopper Initiated)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedReAuthorisation","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated Re-Authorisation)","summary":"Ecom - Card purchase (Merchant Initiated Re-Authorisation)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Re-Authorisation)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedResubmission","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated Resubmission)","summary":"Ecom - Card purchase (Merchant Initiated Resubmission)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Resubmission)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedDelayedCharge","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated Delayed Charge)","summary":"Ecom - Card purchase (Merchant Initiated Delayed Charge)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Delayed Charge)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedNoShow","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated No Show)","summary":"Ecom - Card purchase (Merchant Initiated No Show)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated No Show)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedInitialRecurring","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated Initial Recurring)","summary":"Ecom - Card purchase (Merchant Initiated Initial Recurring)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Initial Recurring)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"gatewayTokenId":"2357e042-2bf0-4886-8d9d-718fa5909761"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"recurring":{"processingModel":"merchantInitiatedSubsequentRecurring","schemeTransactionId":"TX1234567890123456"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","summary":"Ecom - Card purchase (Merchant Initiated Subsequent Recurring)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (Merchant Initiated Subsequent Recurring)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"email":"john.doe@example.com","firstName":"John","lastName":"Doe","countryCode":"US","state":"CA","city":"San Francisco","postalCode":"94102","street":"Market Street","houseNumberOrName":"123","phoneNumber":"+1-555-123-4567","addressLine2":"Apt 4B"},"riskScreeningData":{"performRiskScreening":true,"excludeDeviceData":true,"deviceSessionId":"session_xyz123456","items":[{"price":4525,"quantity":2,"category":"Electronics","sku":"WIDGET_001"},{"price":1000,"quantity":1,"category":"Electronics","sku":"WIDGET_002"}],"fulfillments":[{"type":"Shipped","recipientPerson":{"name":{"first":"Jane","middle":"Marie","family":"Smith","prefix":"Ms.","suffix":null,"preferred":"Jane"},"address":{"line1":"456 Shipping Street","line2":"Apartment 2B","city":"London","region":"Greater London","countryCode":"GB","postalCode":"SW2B2BB"},"email":"jane.smith@example.com","phoneNumber":"+442079460958"}}],"transaction":{"subtotal":10050}}},"key":"Ecom - Card purchase (with risk screening data)","summary":"Ecom - Card purchase (with risk screening data)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card purchase (with risk screening data)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Verification","entryType":"Ecom","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":0,"currencyCode":"EUR"},"identityVerification":{"nameVerification":true},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","email":"shopper@example.com"}},"key":"Ecom - Card verification","summary":"Ecom - Card verification","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Card verification"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Aeropay","user":{"id":"761a3e91-4062-4fc2-80a4-dc12c8601522"},"bank":{"accountId":1895546}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Ecom - Aeropay authorisation","summary":"Ecom - Aeropay authorisation","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - Aeropay authorisation"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"SPEI-TXN-001","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei","language":"ES"}},"amounts":{"transaction":100,"currencyCode":"MXN"},"shopper":{"id":"Shopper_MX_01","firstName":"Juan","lastName":"Garcia","dateOfBirth":"1990-01-01","email":"juan.garcia@example.com","countryCode":"MX","documentType":"TaxIdNumber","documentNumber":"HEGJ850101ABC","phoneNumber":"+5215555555555"}},"key":"Ecom - SPEI purchase","summary":"Ecom - SPEI purchase","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI purchase"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"SPEI-PAYOUT-001","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei","bankAccountNumber":"012180001234567890","bankCode":"012","accountType":"Clabe"}},"amounts":{"transaction":100,"currencyCode":"MXN"},"shopper":{"id":"Shopper_MX_01","firstName":"Juan","lastName":"Garcia","dateOfBirth":"1990-01-01","email":"juan.garcia@example.com","countryCode":"MX","documentType":"TaxIdNumber","documentNumber":"HEGJ850101ABC","phoneNumber":"+5215555555555"}},"key":"Ecom - SPEI payout (new bank account)","summary":"Ecom - SPEI payout (new bank account)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (new bank account)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"SPEI-PAYOUT-002","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei","gatewaytokenid":"b6e2f1a4c3d84f7ab1e9d2c3f4a5b6c7"}},"amounts":{"transaction":100,"currencyCode":"MXN"},"shopper":{"id":"Shopper_MX_01","firstName":"Juan","lastName":"Garcia","dateOfBirth":"1990-01-01","email":"juan.garcia@example.com","countryCode":"MX","documentType":"TaxIdNumber","documentNumber":"HEGJ850101ABC","phoneNumber":"+5215555555555"}},"key":"Ecom - SPEI payout (stored bank account)","summary":"Ecom - SPEI payout (stored bank account)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Ecom - SPEI payout (stored bank account)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Moto","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Moto - Card authorisation","summary":"Moto - Card authorisation","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Moto","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":"123"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Moto - Card authorisation (with CVC)","summary":"Moto - Card authorisation (with CVC)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with CVC)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Moto","fundingType":"Card"},"fundingData":{"card":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe"}},"amounts":{"transaction":30.32,"currencyCode":"EUR"},"addressVerification":{"houseNumberOrName":"en","postalCode":"","countryCode":"GB"},"shopper":{"id":"Shopper_01","firstName":"John","lastName":"Doe","dateOfBirth":"1980-03-01","email":"shopper@example.com"}},"key":"Moto - Card authorisation (with AVS)","summary":"Moto - Card authorisation (with AVS)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Moto - Card authorisation (with AVS)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{},"amounts":{"transaction":100,"currencyCode":"USD"},"dccData":{}},"key":"Instore - Card authorisation","summary":"Instore - Card authorisation","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{},"amounts":{"transaction":100,"currencyCode":"USD","gratuity":5.01},"dccData":{}},"key":"Instore - Card authorisation (with gratuity)","summary":"Instore - Card authorisation (with gratuity)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with gratuity)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{},"amounts":{"transaction":100,"currencyCode":"USD","serviceCharge":{"amount":10,"percentage":10}},"dccData":{}},"key":"Instore - Card authorisation (with service charge)","summary":"Instore - Card authorisation (with service charge)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with service charge)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"ChipAndPin","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"encryptedPayload":"48BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplogQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="},"emvData":{"applicationIdentifier":"A0000000041010","applicationInterchangeProfile":"5800","applicationLabel":"MasterCard","applicationPreferredName":"Mastercard","applicationTransactionCounter":"0003","applicationUsageControl":"FF00","applicationVersionNumber":"0002","authorisationRequestCryptogram":"975C5CE3ED29C82B","cryptogramInformationData":"40","cryptogramTransactionType":"00","cardHolderVerificationMethodResults":"410302","dedicatedFileName":"fdsffsr4rwtgfgdsgsfgdfgdsg","issuerActionCodesDefault":"F040642000","issuerActionCodesDenial":"0010880000","issuerActionCodesOnline":"F0E064F800","issuerApplicationData":"020000000000","pinBlock":{"ksn":"43243443244234","pin":"31232139097491247234"},"primaryAccountNumberSequenceNumber":"00","pointOfSaleEntryMode1":"3","pointOfSaleEntryMode2":"2","terminalCapabilities":"E0F8C8","terminalCountryCode":"826","terminalType":"22","terminalVerificationResult":"420000E000","track2EquivalentData":"87yf89f87yfs87fyhsihfuijkhkfdfsdf","transactionStatusInformation":"E800","unpredictableNumber":"68396050","additionalTags":"9F6604FFFFFFFF9F6C02FFFF"}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Instore - Card authorisation (Icc with P2PE)","summary":"Instore - Card authorisation (Icc with P2PE)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc with P2PE)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"CardContactless","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"encryptedPayload":"48BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplogQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="},"emvData":{"applicationIdentifier":"A0000000041010","applicationInterchangeProfile":"5800","applicationLabel":"MasterCard","applicationPreferredName":"Mastercard","applicationTransactionCounter":"0003","applicationUsageControl":"FF00","applicationVersionNumber":"0002","authorisationRequestCryptogram":"975C5CE3ED29C82B","contactless":{"discretionaryData":"4E2JA4F4","formFactor":"6EfJ"},"cryptogramInformationData":"40","cryptogramTransactionType":"00","cardHolderVerificationMethodResults":"410302","dedicatedFileName":"fdsffsr4rwtgfgdsgsfgdfgdsg","issuerActionCodesDefault":"F040642000","issuerActionCodesDenial":"0010880000","issuerActionCodesOnline":"F0E064F800","issuerApplicationData":"020000000000","pinBlock":{"ksn":"43243443244234","pin":"31232139097491247234"},"primaryAccountNumberSequenceNumber":"00","pointOfSaleEntryMode1":"3","pointOfSaleEntryMode2":"2","terminalCapabilities":"E0F8C8","terminalCountryCode":"826","terminalType":"22","terminalVerificationResult":"420000E000","track2EquivalentData":"87yf89f87yfs87fyhsihfuijkhkfdfsdf","transactionStatusInformation":"E800","unpredictableNumber":"68396050","additionalTags":"9F6604FFFFFFFF9F6C02FFFF"}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Instore - Card authorisation (IccContactless with P2PE)","summary":"Instore - Card authorisation (IccContactless with P2PE)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (IccContactless with P2PE)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"KeyEntry","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"encryptedPayload":"48BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplogQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Instore - Card authorisation (Keyed with P2PE)","summary":"Instore - Card authorisation (Keyed with P2PE)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Keyed with P2PE)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"Swiped","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"encryptedPayload":"48BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplogQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Instore - Card authorisation (Swiped with P2PE)","summary":"Instore - Card authorisation (Swiped with P2PE)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Swiped with P2PE)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"ChipAndPin","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"primaryAccountNumber":"4111111111111111","expiryMonth":"03","expiryYear":"2027","holderName":"Mr John Doe","cardVerificationCode":123},"emvData":{"applicationIdentifier":"A0000000041010","applicationInterchangeProfile":"5800","applicationLabel":"MasterCard","applicationPreferredName":"Mastercard","applicationTransactionCounter":"0003","applicationUsageControl":"FF00","applicationVersionNumber":"0002","authorisationRequestCryptogram":"975C5CE3ED29C82B","cryptogramInformationData":"40","cryptogramTransactionType":"00","cardHolderVerificationMethodResults":"410302","dedicatedFileName":"fdsffsr4rwtgfgdsgsfgdfgdsg","issuerActionCodesDefault":"F040642000","issuerActionCodesDenial":"0010880000","issuerActionCodesOnline":"F0E064F800","issuerApplicationData":"020000000000","pinBlock":{"ksn":"43243443244234","pin":"31232139097491247234"},"primaryAccountNumberSequenceNumber":"00","pointOfSaleEntryMode1":"3","pointOfSaleEntryMode2":"2","terminalCapabilities":"E0F8C8","terminalCountryCode":"826","terminalType":"22","terminalVerificationResult":"420000E000","track2EquivalentData":"87yf89f87yfs87fyhsihfuijkhkfdfsdf","transactionStatusInformation":"E800","unpredictableNumber":"68396050","additionalTags":"9F6604FFFFFFFF9F6C02FFFF"}}},"amounts":{"transaction":30.32,"currencyCode":"EUR"}},"key":"Instore - Card authorisation (Icc without P2PE)","summary":"Instore - Card authorisation (Icc without P2PE)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (Icc without P2PE)"},"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)":{"value":{"merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","transactionMethod":{"intent":"Authorisation","entryType":"Instore","fundingType":"Card"},"fundingData":{"card":{"pointOfInteraction":{"entryType":"CardContactless","interfaceSerialNumber":"75040371","kernelApplicationVersion":"4.21.35290_WP","deviceModelName":"Castles Saturn F1000","operatingSystemVersion":"release-31014000","pointOfSaleId":"001","merchantPointOfSaleId":"POS-001","pointOfSaleApplicationVersion":"4.23.060.0","serialNumber":"275-040-371"},"securityLevel":{"encryptedPayload":"48BCFZFUklGT05F348CBFA0MDDfjwMLMjc1LTA0MC0zNzHfjwYBAN+PBwQbTVL4348ECv//AAAQACXgAA/fjwUIPmP5MQz/poffjwhoreYH9Y6M47xapI7MALlOG7zWO97lD7rVPK5pUVdHUotneMaiaBwE/2EMliZV3ZIiWPi4Xaa3A3wcnEFjAT9SqwwEEVI6XmDQXAbplogQzMQsOsDFmIGXaTPb9sVdTumSsyFAmZwRE="},"emvData":{"applicationIdentifier":"A0000000041010","applicationInterchangeProfile":"5800","applicationLabel":"MasterCard","applicationPreferredName":"Mastercard","applicationTransactionCounter":"0003","applicationUsageControl":"FF00","applicationVersionNumber":"0002","authorisationRequestCryptogram":"975C5CE3ED29C82B","contactless":{"discretionaryData":"4E2JA4F4","formFactor":"6EfJ"},"cryptogramInformationData":"40","cryptogramTransactionType":"00","cardHolderVerificationMethodResults":"410302","dedicatedFileName":"fdsffsr4rwtgfgdsgsfgdfgdsg","issuerActionCodesDefault":"F040642000","issuerActionCodesDenial":"0010880000","issuerActionCodesOnline":"F0E064F800","issuerApplicationData":"020000000000","pinBlock":{"ksn":"43243443244234","pin":"31232139097491247234"},"primaryAccountNumberSequenceNumber":"00","pointOfSaleEntryMode1":"3","pointOfSaleEntryMode2":"2","terminalCapabilities":"E0F8C8","terminalCountryCode":"826","terminalType":"22","terminalVerificationResult":"420000E000","track2EquivalentData":"87yf89f87yfs87fyhsihfuijkhkfdfsdf","transactionStatusInformation":"E800","unpredictableNumber":"68396050","additionalTags":"9F6604FFFFFFFF9F6C02FFFF"}}},"amounts":{"transaction":100,"currencyCode":"USD"},"dccData":{"rateSelectedIndicator":"Selected","amounts":{"local":{"transaction":2.5,"currencyCode":"GBP"},"cardholder":{"transaction":2.98,"currencyCode":"EUR"}},"exchangeRate":1.193665,"providerData":{"provider":"Elavon","referenceId":"25092610071199","terminalId":"210011226201","markupTextIndicator":1},"markupRate":3.92,"disclaimer":"This is an example disclaimer"}},"key":"Instore - Card authorisation (with DCC data)","summary":"Instore - Card authorisation (with DCC data)","id":"paths/~1transactions/post/requestBody/content/application~1json/examples/Instore - Card authorisation (with DCC data)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemeTokenNumber":"4837261112345678","addressVerificationServiceResult":"noInformationAvailable","cardVerificationCodeResult":"noInformationAvailable","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","cardVerificationCodeResult":"A","addressVerificationServiceResult":"D","schemeTransactionId":"TX1234567890123456","schemeTransactionLinkId":"TX1234567890123456","paymentAccountReference":"PAR12345678901234567890","retrievalReferenceNumber":"613808317649","electronicCommerceIndicatorAdjustment":"01","settlementDate":"2024-01-25T00:00:00.000Z"}}},"key":"Ecom - Card authorised","summary":"Ecom - Card authorised","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card authorised"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused":{"value":{"state":"Refused","stateData":{"code":"CRD100","message":"Do not honour"},"merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemeTokenNumber":"4837261112345678","providerResponse":{"provider":"PXPFinancial","code":"05","message":"Do not honour","merchantId":"77772182","terminalId":"75836665","retrievalReferenceNumber":"613808317649","merchantAdvice":{"code":"01","message":"New account information available"}}}},"key":"Ecom - Card refused","summary":"Ecom - Card refused","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card refused"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemeTokenNumber":"4837261112345678"}},"key":"Ecom - Card error (general)","summary":"Ecom - Card error (general)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (general)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)":{"value":{"state":"Error","stateData":{"code":"CRD183","message":"Timeout / Malfunction"},"merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemeTokenNumber":"4837261112345678"}},"key":"Ecom - Card error (communication timeout)","summary":"Ecom - Card error (communication timeout)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (communication timeout)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)":{"value":{"state":"Error","stateData":{"code":"CRD102","message":"Suspected fraud"},"merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","schemeTokenNumber":"4837261112345678"}},"key":"Ecom - Card error (risk refusal)","summary":"Ecom - Card error (risk refusal)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (risk refusal)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)":{"value":{"state":"Error","stateData":{"code":"CRD109","message":"Invalid merchant"},"merchantTransactionId":"This_is_my_merchant_transaction_id"},"key":"Ecom - Card error (setup failure)","summary":"Ecom - Card error (setup failure)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - Card error (setup failure)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"401445","merchantTransactionDate":"2025-03-28T10:24:51","merchantTransactionId":"433835e6-a332-452a-861b-069593dbb7c5","systemTransactionId":"238e5bc9-0166-4a8b-84b2-a12b804182bc","fundingData":{"cardScheme":"MasterCard","primaryAccountNumber":"4111111111111111","expiryMonth":"01","expiryYear":"2031","gatewayTokenId":"5fbd77ce-02c1-40ed-94bc-1016660b7512","providerResponse":{"provider":"pxpfinancial","code":"00","merchantId":"7171910017","terminalId":"32454401","retrievalReferenceNumber":"613808317649","emvDataResponse":{"applicationIdentifier":"A0000000032010","applicationLabel":"VISA ELECTRON","primaryAccountNumberSequenceNumber":"0001","authorisationResponseCode":"00","issuerAuthenticationData":"C9DF3CA29138D5E83030"},"electronicCommerceIndicatorAdjustment":"07","merchantAdvice":{},"authorisedAmount":6},"processorTransactionId":"f9c1f0ea-6c2f-4517-b2ca-460645f07e40"},"dccData":{"dccSelectedIndicator":"Selected","amounts":{"local":{"transaction":100,"currencyCode":"USD"},"cardholder":{"transaction":85.5,"currencyCode":"EUR"}},"providerData":{"provider":"Elavon","referenceId":"REF123456789","merchantId":"MERCH001","terminalId":"TERM001","markupTextIndicator":1},"exchangeRate":1.1696,"markupRate":3.5,"disclaimer":"Exchange rate includes 3.5% margin."}},"key":"Instore - Card authorised with DCC result","summary":"Instore - Card authorised with DCC result","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Instore - Card authorised with DCC result"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)":{"value":{"state":"Pending","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionId":"SPEI-TXN-001","providerTransactionId":"9a4c7e21-3f5d-4b8e-8a1c-2d3e4f5a6b7c","fundingData":{"payByBank":{"apmProvider":"Spei","redirectUrl":"https://hosted-payment-page.example/spei/...","paymentId":"6f2b6d0a-8b1a-4e2b-9c3d-0a1b2c3d4e5f","processorPaymentId":"9a4c7e21-3f5d-4b8e-8a1c-2d3e4f5a6b7c"}}},"key":"Ecom - SPEI purchase (pending)","summary":"Ecom - SPEI purchase (pending)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI purchase (pending)"},"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)":{"value":{"state":"Pending","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionId":"SPEI-PAYOUT-001","fundingData":{"payByBank":{"apmProvider":"Spei","paymentId":"7c1d8e32-4a6b-4f9c-b2d3-1e2f3a4b5c6d"}},"stateData":{"gatewayTokenId":"b6e2f1a4c3d84f7ab1e9d2c3f4a5b6c7"}},"key":"Ecom - SPEI payout (pending)","summary":"Ecom - SPEI payout (pending)","id":"paths/~1transactions/post/responses/200/content/application~1json/examples/Ecom - SPEI payout (pending)"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":30.32},"operation":"Refund"},"key":"Card - Refund","summary":"Card - Refund","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Refund"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":30.32},"operation":"Capture"},"key":"Card - Capture","summary":"Card - Capture","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":30.32},"operation":"FinalCapture"},"key":"Card - Final capture","summary":"Card - Final capture","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Final capture"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":1},"operation":"Incremental"},"key":"Card - Incremental","summary":"Card - Incremental","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":30.32},"operation":"Void"},"key":"Card - Void","summary":"Card - Void","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Void"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC":{"value":{"fundingType":"Card","merchant":"MERCH001","site":"SITE001","merchantTransactionId":"MOD-20251203-001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-12-03T11:00:00Z","operation":"Capture","remark":"Partial capture with DCC","data":[],"amounts":{"currencyCode":"EUR","transaction":45},"dccData":{"rateSelectedIndicator":"Selected","amounts":{"local":{"transaction":45,"currencyCode":"EUR"},"cardholder":{"transaction":48.5,"currencyCode":"USD"}},"providerData":{"provider":"FEXCO","referenceId":"RATE789012","merchantId":"MERCH001","terminalId":"TERM001","markupTextIndicator":1},"exchangeRate":1.0778,"markupRate":3,"disclaimer":"Exchange rate includes 3% margin."}},"key":"Card - Capture with DCC","summary":"Card - Capture with DCC","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Capture with DCC"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC":{"value":{"fundingType":"Card","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-09-11T14:19:49.1178265+07:00","amounts":{"transaction":25,"gratuity":0},"operation":"Incremental","dccData":{"rateSelectedIndicator":"Selected","amounts":{"local":{"transaction":25,"currencyCode":"GBP"},"cardholder":{"transaction":48.45,"currencyCode":"AUD"}},"exchangeRate":1.938037,"providerData":{"provider":"Elavon","referenceId":"25091108151706","terminalId":"210011226201","markupTextIndicator":1},"disclaimer":"This is an example disclaimer","markupRate":3.5}},"key":"Card - Incremental with DCC","summary":"Card - Incremental with DCC","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Card - Incremental with DCC"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation":{"value":{"fundingType":"Paypal","operation":"Authorisation","site":"SITE-1","merchant":"MERCHANT-1","merchantTransactionId":"AUTHORISATION_TXN_001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-10-08T10:30:00.000Z"},"key":"PayPal - Authorisation","summary":"PayPal - Authorisation","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Authorisation"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture":{"value":{"fundingType":"Paypal","operation":"Capture","site":"SITE-1","amounts":{"transaction":100},"merchant":"MERCHANT-1","merchantTransactionId":"CAPTURE_TXN_001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-10-08T10:30:00.000Z"},"key":"PayPal - Capture","summary":"PayPal - Capture","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Capture"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture":{"value":{"fundingType":"Paypal","operation":"FinalCapture","site":"SITE-1","amounts":{"transaction":50},"merchant":"MERCHANT-1","merchantTransactionId":"FINAL_CAPTURE_001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-10-08T10:30:00.000Z","remark":"Final shipment completed"},"key":"PayPal - Final capture","summary":"PayPal - Final capture","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Final capture"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund":{"value":{"fundingType":"Paypal","operation":"Refund","site":"SITE-1","amounts":{"transaction":100},"merchant":"MERCHANT-1","merchantTransactionId":"REFUND_TXN_001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-10-08T10:30:00.000Z"},"key":"PayPal - Refund","summary":"PayPal - Refund","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Refund"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void":{"value":{"fundingType":"Paypal","operation":"Void","site":"SITE-1","merchant":"MERCHANT-1","merchantTransactionId":"VOID_TXN_001","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2025-10-08T10:30:00.000Z"},"key":"PayPal - Void","summary":"PayPal - Void","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/PayPal - Void"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund":{"value":{"fundingType":"PayByBank","apmProvider":"Aeropay","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_merchant_transaction_id","merchantTransactionGroupId":"This_is_my_merchant_transaction_group_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","amounts":{"transaction":30.32},"operation":"Refund"},"key":"Aeropay - Refund","summary":"Aeropay - Refund","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/Aeropay - Refund"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund":{"value":{"fundingType":"PayByBank","apmProvider":"Spei","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"SPEI-RFD-001","currencyCode":"MXN","amounts":{"transaction":100},"operation":"Refund"},"key":"SPEI - Full refund","summary":"SPEI - Full refund","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/requestBody/content/application~1json/examples/SPEI - Full refund"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC":{"value":{"state":"Captured","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"654321","merchantTransactionId":"MOD-20251203-001","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","providerTransactionId":"PROV-TX-123456","merchantTransactionDate":"2025-12-03T11:00:00Z","amounts":{"transaction":45,"currencyCode":"EUR"},"fundingData":{"cardScheme":"Visa","primaryAccountNumber":"************1111","expiryMonth":"12","expiryYear":"26","gatewayTokenId":"TOKEN-GTW-123","schemeTokenNumber":"4837261112345678","cardVerificationCodeResult":"M","addressVerificationServiceResult":"Y","providerResponse":{"provider":"PXPFinancial","merchantId":"MID-001","terminalId":"TID-001","code":"00","message":"Capture Approved","retrievalReferenceNumber":"613808317649"}},"dccData":{"dccSelectedIndicator":"Selected","amounts":{"local":{"transaction":45,"currencyCode":"EUR"},"cardholder":{"transaction":48.5,"currencyCode":"USD"}},"providerData":{"provider":"FEXCO","referenceId":"RATE789012","merchantId":"MERCH001","terminalId":"TERM001","markupTextIndicator":1},"providerResponse":{"provider":"FEXCO","merchantId":"MERCH001","terminalId":"TERM001","settlementDate":"2025-12-04T00:00:00Z","merchantAdvice":"00","schemeTransactionLinkId":"LINK123456","electronicCommerceIndicatorAdjustment":"05","schemeTransactionId":"TX1234567890","paymentAccountReference":"PAR12345678901234567890","cardVerificationCodeResult":"M","addressVerificationServiceResult":"Y","emvDataResponse":{"applicationIdentifier":"A0000000031010","applicationLabel":"VISA DEBIT","primaryAccountNumberSequenceNumber":"01","authorisationResponseCode":"00","issuerAuthenticationData":"0123456789ABCDEF","issuerScriptTemplate1":"","issuerScriptTemplate2":""}},"exchangeRate":1.0778,"markupRate":3,"disclaimer":"Exchange rate includes 3% margin."}},"key":"Capture with DCC","summary":"Capture with DCC","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture with DCC"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)":{"value":{"state":"Captured","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"***************5678","expiryMonth":"03","expiryYear":"2027","paymentAccountReference":"PAR12345678901234567890","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649","settlementDate":"2024-01-25T00:00:00.000Z"}},"key":"Capture (Captured)","summary":"Capture (Captured)","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Capture (Captured)"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionDetails":null,"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"***************5678","expiryMonth":"03","expiryYear":"2027","paymentAccountReference":"PAR12345678901234567890","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649"}},"key":"Incremental (Authorised)","summary":"Incremental (Authorised)","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Incremental (Authorised)"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)":{"value":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"***************5678","expiryMonth":"03","expiryYear":"2027","paymentAccountReference":"PAR12345678901234567890","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649"}},"key":"Refund (Authorised)","summary":"Refund (Authorised)","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Refund (Authorised)"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)":{"value":{"state":"Cancelled","approvalCode":"123456","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","fundingData":{"cardScheme":"Visa","primaryAccountNumber":"***************5678","expiryMonth":"03","expiryYear":"2027","paymentAccountReference":"PAR12345678901234567890","gatewayTokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678"},"providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","terminalId":"75836665","schemeTransactionId":"TX1234567890123456","retrievalReferenceNumber":"613808317649"}},"key":"Void (Authorised)","summary":"Void (Authorised)","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/Void (Authorised)"},"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)":{"value":{"state":"Pending","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionId":"SPEI-RFD-001","providerTransactionId":"8d2e4f6a-1b3c-4d5e-9f6a-7b8c9d0e1f2a","fundingData":{"payByBank":{"apmProvider":"Spei","paymentId":"3b4c5d6e-7f8a-4b9c-8d1e-2f3a4b5c6d7e","processorPaymentId":"8d2e4f6a-1b3c-4d5e-9f6a-7b8c9d0e1f2a"}}},"key":"SPEI - Full refund (Pending)","summary":"SPEI - Full refund (Pending)","id":"paths/~1transactions~1{systemTransactionId}~1modifications/post/responses/200/content/application~1json/examples/SPEI - Full refund (Pending)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)":{"value":[{"systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionMethod":{"intent":"Authorisation","fundingType":"Card","entryType":"Ecom"},"approvalCode":"123456","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_transaction_id","merchantTransactionDate":"2024-01-27T08:51:02.826Z","fundingData":{"cardScheme":"Visa","expiryMonth":"12","expiryYear":"2025","providerResponse":{"provider":"pxpfinancial","code":"00","message":"Transaction Approved","retrievalReferenceNumber":"613808317649"},"primaryAccountNumber":"************1234"}}],"key":"Ecom card authorisation (authorised)","summary":"Ecom card authorisation (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card authorisation (authorised)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)":{"value":[{"systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionMethod":{"intent":"Purchase","fundingType":"Card","entryType":"Ecom"},"approvalCode":"789012","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_transaction_id","merchantTransactionDate":"2021-10-27T08:51:02.826Z","fundingData":{"cardScheme":"Mastercard","expiryMonth":"06","expiryYear":"2026","providerResponse":{"provider":"pxpfinancial","code":"00","message":"Transaction Approved","retrievalReferenceNumber":"613808317649"},"primaryAccountNumber":"************5678"}}],"key":"Ecom card purchase (authorised)","summary":"Ecom card purchase (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom card purchase (authorised)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)":{"value":[{"systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionMethod":{"intent":"Authorisation","fundingType":"Card","entryType":"Moto"},"approvalCode":"345678","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_transaction_id","merchantTransactionDate":"2021-10-27T08:51:02.826Z","fundingData":{"cardScheme":"AmericanExpress","expiryMonth":"03","expiryYear":"2027","providerResponse":{"provider":"pxpfinancial","code":"00","message":"Transaction Approved","retrievalReferenceNumber":"613808317649"},"primaryAccountNumber":"************9012"}}],"key":"MOTO card authorisation (authorised)","summary":"MOTO card authorisation (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card authorisation (authorised)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)":{"value":[{"systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionMethod":{"intent":"Purchase","fundingType":"Card","entryType":"Moto"},"approvalCode":"901234","merchant":"MERCHANT-1","site":"SITE-1","merchantTransactionId":"This_is_my_transaction_id","merchantTransactionDate":"2021-10-27T08:51:02.826Z","fundingData":{"cardScheme":"Diners","expiryMonth":"09","expiryYear":"2028","providerResponse":{"provider":"pxpfinancial","code":"00","message":"Transaction Approved","retrievalReferenceNumber":"613808317649"},"primaryAccountNumber":"************3456"}}],"key":"MOTO card purchase (authorised)","summary":"MOTO card purchase (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/MOTO card purchase (authorised)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)":{"value":[{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"transactionMethod":{"entryType":"Instore","fundingType":"Card","intent":"EstimatedAuthorisation"},"merchantTransactionDate":"2026-05-08 09:24:25.000000","systemTransactionId":"0cc27966-4d38-4a7a-8877-135c666952bb","approvalCode":"233765","merchant":"Unity","site":"UnityELVInStore","merchantTransactionId":"1703164920260508","entryType":"CardContactless","fundingData":{"expiryMonth":"12","expiryYear":"2049","cardScheme":"MasterCard","providerResponse":{"emvDataResponse":"","paymentAccountReference":"","settlementDate":"","electronicCommerceIndicatorAdjustment":"","cardVerificationCodeResult":"","schemeTransactionLinkId":"","merchantId":"2100112262","schemeTransactionId":"MMCC0004VC000 000508","retrievalReferenceNumber":"613808317649","provider":"elavon","merchantAdvice":"","terminalId":"210011226202","issuerResponseCode":"","message":"APPROVAL","code":"A","nameVerificationResult":"","addressVerificationServiceResult":""},"primaryAccountNumber":"************0190"}}],"key":"Instore card estimated authorisation (authorised)","summary":"Instore card estimated authorisation (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Instore card estimated authorisation (authorised)"},"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)":{"value":[{"state":"Authorised","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionId":"SPEI-TXN-001","merchant":"MERCHANT-1","site":"SITE-1","providerTransactionId":"9a4c7e21-3f5d-4b8e-8a1c-2d3e4f5a6b7c","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei","status":"Authorised","redirectUrl":"https://hosted-payment-page.example/spei/...","paymentId":"6f2b6d0a-8b1a-4e2b-9c3d-0a1b2c3d4e5f","processorPaymentId":"9a4c7e21-3f5d-4b8e-8a1c-2d3e4f5a6b7c"}},"shopper":{"id":"Shopper_MX_01","firstName":"Juan","lastName":"Garcia","dateOfBirth":"1990-01-01","email":"juan.garcia@example.com"}}],"key":"Ecom - SPEI purchase (authorised)","summary":"Ecom - SPEI purchase (authorised)","id":"paths/~1transactions~1{merchant}~1{site}/get/responses/200/content/application~1json/examples/Ecom - SPEI purchase (authorised)"}},"securitySchemeStore":{},"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/transaction","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/transaction.json?download"},{"url":"/_bundle/apis/transaction.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Transactions service","description":"This is an API reference for the Transaction service API."}},"baseSlug":"/apis/transaction","routesMapping":{}}