{"items":[{"type":"link","label":"Merchant webhooks service API","link":"/apis/merchant-webhook","routeSlug":"/apis/merchant-webhook","content":{"contentType":"overview","meta":{"name":"Merchant webhooks service API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"merchant-webhook.json","url":"/_bundle/apis/merchant-webhook.json?download"},{"kind":"download","label":"merchant-webhook.yaml","url":"/_bundle/apis/merchant-webhook.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":"Merchant webhooks service API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the merchant webhooks service."}],"sectionId":"/apis/merchant-webhook"}],"sectionId":"/apis/merchant-webhook"}]}]}},{"label":"Process a merchant webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merchant-webhook/other/process-merchant-webhook","routeSlug":"/apis/merchant-webhook/other/process-merchant-webhook","metadata":{"seo":{"title":"Process a merchant webhook","description":"The /merchant-webhooks endpoint is designed for real-time notifications about transaction events, enabling you to automatically receive updates on transaction statuses such as authorisations, captures, and cancellations. Supported products include card payments, PayPal (including Pay Later and Venmo), Aeropay pay-by-bank events (including user suspended and user activated), and SPEI pay-by-bank events (purchase, payout, and refund outcomes)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"process-merchant-webhook","name":"Process a merchant webhook","isWebhook":false,"pointer":"/paths/~1merchant-webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process a merchant webhook","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":"/merchant-webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint is designed for real-time notifications about transaction events, enabling you to automatically receive updates on transaction statuses such as authorisations, captures, and cancellations. Supported products include card payments, PayPal (including Pay Later and Venmo), Aeropay pay-by-bank events (including user suspended and user activated), and SPEI pay-by-bank events (purchase, payout, and refund outcomes)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"PXP-UST1","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-UST1 authentication with HMAC-SHA256 signature. Format: PXP-UST1 {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merchantWebhookRequest","exampleIds":["paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"]}},"schemaId":"components/schemas/merchantWebhookRequest","exampleIds":["paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"],"pointer":"/paths/~1merchant-webhooks/post/requestBody","description":"Merchant webhooks"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchant-webhooks","servers":[{"url":"https://merchantEndpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PXP-UST1","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/merchantWebhookRequest","exampleIds":["paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/merchant-webhooks","href":"other/process-merchant-webhook","openApiOperationId":"process-merchant-webhook","summary":"Process a merchant webhook"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://merchantEndpoint"}],"schemaId":"components/schemas/merchantWebhookRequest","exampleIds":["paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merchantWebhookRequest","exampleIds":["paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)","paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchantWebhookResponse"}},"schemaId":"components/schemas/merchantWebhookResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Unauthorised","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1merchant-webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/merchantWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchantWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"403","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/process-merchant-webhook"}],"panels":[]}]},"httpPath":"/merchant-webhooks"}],"store":{"schemaStore":{"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 alphanumeric characters, starting with an uppercase letter, and serves as a key reference for authorisation verification.","example":"A123456","type":"string","pattern":"^[A-Z]"}},"components/schemas/addressVerificationServiceResult":{"id":"components/schemas/addressVerificationServiceResult","kind":"json-schema","title":"addressVerificationServiceResult","data":{"description":"The result of the Address Verification System (AVS) check. This provides 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"}},"components/schemas/authenticationData":{"id":"components/schemas/authenticationData","kind":"json-schema","title":"authenticationData","data":{"properties":{"authenticationId":{"type":"string","description":"Unique reference provided by PXP for the authentication request, represented as a GUID.","example":"71e2698f-10ec-44d4-8302-dcff7bdcfe90"},"state":{"$ref":"#/components/schemas/authenticationState"},"transactionStatus":{"$ref":"#/components/schemas/transactionStatus"},"transactionStatusReason":{"type":"string","description":"Reason for the current transaction status."},"directoryServerTransactionId":{"type":"string","description":"Unique identifier for the directory server transaction.","example":"71e2698f-10ec-44d4-8302-dcff7bdcfe90"},"threeDSecureVersion":{"type":"string","description":"Version of the 3D Secure protocol.","example":"2.2.0"},"electronicCommerceIndicator":{"type":"string","description":"Indicator used to signify the level of security used in the authentication, often used in electronic commerce transactions.","example":"01"},"authenticationFlow":{"$ref":"#/components/schemas/authenticationFlow"},"challengeCancel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator informing the ACS and the DS that the authentication has been cancelled."},"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":": Cardholder selected 'Cancel'"},"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":": Reserved for EMVCo future use (values invalid until defined by EMVCo)."},"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":": Transaction Timed Out - Decoupled Authentication"},"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":": Transaction Timed Out at ACS - other timeouts"},"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 Timed Out at ACS - First CReq not received by ACS"},"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 Error"},"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":": Unknown"},"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":": Transaction Timed Out at 3DS SDK"},"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":": Error Message in response to the CRes message sent by the ACS"},"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":": Error Message in response to the CReq message received by the ACS"},"children":[]}]}]}]}],"type":"string","example":"01"},"challengeErrorReporting":{"description":"A copy of the error message sent or received by the ACS in case of error in the CReq/CRes messages.","type":"string"}}}},"components/schemas/authenticationFlow":{"id":"components/schemas/authenticationFlow","kind":"json-schema","title":"authenticationFlow","data":{"description":"Flow of the authentication process.","enum":["Frictionless","Challenge"],"example":"Challenge","type":"string"}},"components/schemas/authenticationState":{"id":"components/schemas/authenticationState","kind":"json-schema","title":"authenticationState","data":{"description":"The state of authentication indicating the outcome or current status of the authentication process.","enum":["PendingClientData","AuthenticationSuccessful","AuthenticationFailed","AuthenticationRejected","AuthenticationError","PendingCustomerChallenge"],"example":"AuthenticationSuccessful","type":"string"}},"components/schemas/cardScheme":{"id":"components/schemas/cardScheme","kind":"json-schema","title":"cardScheme","data":{"description":"Specifies the payment card's scheme, indicating the network through which the card transactions are processed. The card scheme is typically represented by a capitalized abbreviation or name of the card network. This information is crucial for identifying the card type and facilitating transaction processing in accordance with the network's regulations and standards.","example":"Visa","type":"string","pattern":"^[A-Z]+$"}},"components/schemas/emvDataResponse":{"id":"components/schemas/emvDataResponse","kind":"json-schema","title":"emvDataResponse","data":{"description":"Response data from an EMV transaction.","type":"object","properties":{"applicationIdentifier":{"type":"string","description":"Identifier assigned to each application on an EMV chip card."},"applicationLabel":{"type":"string","description":"Label of the application used in the EMV process."},"primaryAccountNumberSequenceNumber":{"type":"string","description":"EMV tag 5F34: identifies and differentiates cards with the same PAN."},"authorisationResponseCode":{"type":"string","description":"EMV tag 8A authorisation response code."},"issuerAuthenticationData":{"type":"string","description":"EMV tag 91 issuer authentication data."},"issuerScriptTemplate1":{"type":"string","description":"EMV tag 71 issuer script template."},"issuerScriptTemplate2":{"type":"string","description":"EMV tag 72 issuer script template."}}}},"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":{"$ref":"#/components/schemas/providerResponseName"},"code":{"$ref":"#/components/schemas/providerResponseCode"},"message":{"$ref":"#/components/schemas/providerResponseMessage"},"merchantId":{"$ref":"#/components/schemas/providerResponseMerchantId"},"cardVerificationCodeResult":{"$ref":"#/components/schemas/providerResponseCvcResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/providerResponseAvsResult"},"paymentAccountReference":{"$ref":"#/components/schemas/paymentAccountReference"},"schemeTransactionId":{"$ref":"#/components/schemas/schemeTransactionId"},"electronicCommerceIndicatorAdjustment":{"$ref":"#/components/schemas/electronicCommerceIndicatorAdjustment"},"merchantAdvice":{"$ref":"#/components/schemas/merchantAdvice"},"settlementDate":{"$ref":"#/components/schemas/settlementDate"},"terminalId":{"type":"string","description":"The terminal identifier used for the transaction."},"authorisedAmount":{"type":"number","description":"The authorised amount returned by the provider."},"issuerResponseCode":{"type":"string","description":"The issuer response code returned by the provider."},"emvDataResponse":{"$ref":"#/components/schemas/emvDataResponse"}}}},"components/schemas/card":{"id":"components/schemas/card","kind":"json-schema","title":"card","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":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object contains essential information about a card involved in a transaction, including its scheme, payment account reference, and token IDs. Additionally, it provides verification results for enhanced security, such as CVC and AVS checks, enabling merchants to ensure transaction integrity and mitigate fraud risks efficiently. This object is returned if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is of type 'Card' or 'SchemeToken'."},"children":[]}]}]}],"properties":{"cardScheme":{"$ref":"#/components/schemas/cardScheme"},"gatewayTokenId":{"$ref":"#/components/schemas/gatewayTokenId"},"schemeTokenNumber":{"$ref":"#/components/schemas/schemeTokenNumber"},"cardVerificationCodeResult":{"$ref":"#/components/schemas/cardVerificationCodeResult"},"addressVerificationServiceResult":{"$ref":"#/components/schemas/addressVerificationServiceResult"},"nameVerificationResult":{"type":"string","nullable":true,"description":"The outcome of the cardholder name verification check."},"providerResponse":{"$ref":"#/components/schemas/cardProviderResponse"}},"type":"object"}},"components/schemas/paypal":{"id":"components/schemas/paypal","kind":"json-schema","title":"paypal","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":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object contains information about PayPal, Pay Later, or Venmo transactions."},"children":[]}]}]}],"properties":{"payeeEmailAddress":{"type":"string","description":"The email address of the payee.","example":"john.doe@pxp.io"},"paymentSource":{"type":"string","description":"The source of the payment (PayPal, Pay Later, or Venmo).","enum":["Paypal","PayLater","Venmo"],"example":"Paypal"},"experienceContext":{"type":"object","description":"Additional context about the payment experience.","properties":{"paymentDescription":{"type":"string","description":"Description of the payment.","example":"Purchase from test site"},"userAction":{"type":"string","description":"The user action type.","example":"PAY_NOW"},"orderType":{"type":"string","description":"The type of order.","example":"Authorisation"},"shippingPreference":{"type":"string","description":"The shipping preference.","example":"GET_FROM_FILE"}}},"shippingSelected":{"type":"object","description":"Information about the selected shipping option.","properties":{"id":{"type":"string","description":"Shipping option identifier.","example":"shipping_id"},"label":{"type":"string","description":"Shipping option label.","example":"shipping_label"},"selected":{"type":"boolean","description":"Whether this shipping option is selected.","example":true},"amounts":{"type":"object","properties":{"shipping":{"type":"number","description":"The shipping amount.","example":1},"currencyCode":{"type":"string","description":"The currency code for the shipping amount.","example":"USD"}}},"type":{"type":"string","description":"The type of shipping.","example":"shipping"}}}},"type":"object"}},"components/schemas/payByBank":{"id":"components/schemas/payByBank","kind":"json-schema","title":"payByBank","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 details for Aeropay transactions. Present 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":[]}]}]}],"type":"object","properties":{"apmProvider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative payment method provider. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aeropay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this object is present for Aeropay webhooks."},"children":[]}]}]}],"example":"Aeropay"},"achStatus":{"type":"string","description":"ACH settlement status when applicable.","example":"Approved"},"apFee":{"type":"string","description":"Application fee returned by Aeropay when present (often on modification webhooks).","example":"222"},"isRtp":{"type":"boolean","description":"Whether the payment uses real-time payments (RTP).","example":false},"authorisationExpiryDate":{"type":"string","format":"date-time","description":"Authorisation expiry datetime when available.","example":"2026-07-17T08:00:00+00:00"},"user":{"type":"object","description":"Aeropay user associated with the payment.","properties":{"id":{"type":"string","description":"Aeropay user identifier.","example":"761a3e91-4062-4fc2-80a4-dc12c8601522"},"name":{"type":"string","description":"User display name.","example":"John Doe"},"email":{"type":"string","format":"email","description":"User email address.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"User phone number when available.","example":"+15551234567"}}},"bank":{"type":"object","description":"Linked bank account details.","properties":{"accountId":{"type":"integer","format":"int64","description":"Bank account identifier.","example":1895546},"name":{"type":"string","description":"Bank name.","example":"Chase Bank"},"accountLastFour":{"type":"string","description":"Last four digits of the account number.","example":"1234"},"accountType":{"type":"string","description":"Account type (for example Checking).","example":"Checking"}}}}}},"components/schemas/aeropayProviderResponse":{"id":"components/schemas/aeropayProviderResponse","kind":"json-schema","title":"aeropayProviderResponse","data":{"description":"Provider outcome for Aeropay transaction webhooks when available.","type":"object","properties":{"providerTransactionId":{"type":"string","description":"Transaction identifier from Aeropay.","example":"67b68945-aab8-4404-a474-4270a588491b"},"providerTransactionStatus":{"type":"string","description":"Status reported by Aeropay.","example":"live"},"providerResponseCode":{"type":"string","description":"Response code from Aeropay when available."},"providerResponseMessage":{"type":"string","description":"Response message from Aeropay when available.","example":"Refund transaction created"}}}},"components/schemas/aeropayUserStatusData":{"id":"components/schemas/aeropayUserStatusData","kind":"json-schema","title":"aeropayUserStatusData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload for Aeropay user suspended ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_USP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and user activated ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_UAC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") webhooks. Status is indicated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not by a field in this object."},"children":[]}]}]}],"type":"object","required":["eventCode","userId"],"properties":{"eventCode":{"type":"string","description":"Aeropay user status event code.","enum":["TXNAP_USP","TXNAP_UAC"],"example":"TXNAP_USP"},"userId":{"type":"string","description":"Aeropay user identifier.","example":"761a3e91-4062-4fc2-80a4-dc12c8601522"}}}},"components/schemas/reportingData":{"id":"components/schemas/reportingData","kind":"json-schema","title":"reportingData","data":{"description":"Data related to reporting events.","properties":{"url":{"type":"string","description":"The URL to download the generated report.","example":"https://api-gateway-transactions.qa.kube.qa/api/v1/reporting/scheduled-report-executions/d1adbc0d-d931-4775-8613-c44853c5464f/content-download-url"}},"required":["url"],"type":"object"}},"components/schemas/userInfoData":{"id":"components/schemas/userInfoData","kind":"json-schema","title":"userInfoData","data":{"description":"Data related to user information creation events.","properties":{"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"customerInformation":{"type":"object","description":"Customer information that was created and verified.","properties":{"id":{"type":"string","format":"uuid","description":"A unique identifier for the customer information.","example":"a7cd91cd-1bb8-4f82-af24-350d6d0b8680"},"name":{"type":"string","description":"The customer's name.","example":"John Doe"},"email":{"type":"string","format":"email","description":"The customer's email address.","example":"sb-oejwh44573747@business.example.com"},"verified":{"type":"boolean","description":"Whether the customer is verified.","example":true},"payerId":{"type":"string","description":"The PayPal payer ID.","example":"BLLXSEJZ9B7ZA"},"address":{"type":"object","description":"The customer's address.","properties":{"streetAddress":{"type":"string","description":"The customer's street address.","example":"1 Main St"},"locality":{"type":"string","description":"The customer's city or locality.","example":"San Jose"},"region":{"type":"string","description":"The customer's state or region.","example":"CA"},"postalCode":{"type":"string","description":"The customer's postal code.","example":"95131"},"countryCode":{"type":"string","description":"The customer's country code.","example":"US"}}},"verifiedAccount":{"type":"boolean","description":"Whether the account is verified.","example":true},"emailVerified":{"type":"boolean","description":"Whether the email is verified.","example":true}}},"eventCode":{"type":"string","description":"The event code for the user info creation.","example":"TXNPP_UIC"}},"required":["merchant","site","customerInformation","eventCode"],"type":"object"}},"components/schemas/currencyCode":{"id":"components/schemas/currencyCode","kind":"json-schema","title":"currencyCode","data":{"description":"The currency code associated with the transaction, in ISO 4217 format. This three-character code specifies the currency in which the transaction is processed, ensuring clarity and consistency across international transactions.","example":"EUR","type":"string","minLength":3,"maxLength":3}},"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"}},"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":"If present, this field 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":"text","inline":true,"attributes":{"content":"\"01\": 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":"text","inline":true,"attributes":{"content":"\"02\": 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":"text","inline":true,"attributes":{"content":"\"05\": 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":"text","inline":true,"attributes":{"content":"\"06\": 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":"text","inline":true,"attributes":{"content":"\"07\": 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"}},"components/schemas/entryType":{"id":"components/schemas/entryType","kind":"json-schema","title":"entryType","data":{"description":"The environment and method by which the transaction is initiated, reflecting the nature of the transaction's origin. This classification is crucial for applying the appropriate security measures and compliance standards. The entry types include 'Ecom' for online transactions, 'Moto' for mail order/telephone order transactions, and 'Instore' for physical retail environments, each representing different transaction contexts and risk profiles.","type":"string","enum":["Ecom","Moto","Instore"],"example":"Ecom"}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"description":"Details about the error.","properties":{"correlationId":{"description":"A unique identifier generated by PXP.","type":"string"},"details":{"description":"An array of additional details about the error, potentially including system-specific information, sub-errors, or contextual data to aid in troubleshooting.","type":"array","items":{}},"errorCode":{"description":"A standardised code that categorises the type of error encountered, enabling quick identification of common issues.","type":"string"},"errorReason":{"description":"A human-readable explanation of the error, providing clarity on the nature of the problem encountered.","type":"string"}},"required":["correlationId","errorCode","errorReason"],"type":"object"}},"components/schemas/eventCategory":{"id":"components/schemas/eventCategory","kind":"json-schema","title":"eventCategory","data":{"description":"The category of the webhook event sent from PXP to you. This field classifies the nature of the event being notified, facilitating targeted processing by your system. Event categories encompass a range of types, including but not limited to transactions (such as purchases, authorisations, captures), chargebacks, disputes, and more. Each category signifies a specific area of payment operations, enabling merchants to listen for and respond to relevant events effectively.","type":"string","enum":["authentication","reporting","token","transaction"],"example":"transaction"}},"components/schemas/eventDate":{"id":"components/schemas/eventDate","kind":"json-schema","title":"eventDate","data":{"description":"The date and time when the event occurred, sent to the merchant as part of the webhook payload. This timestamp is crucial for tracking the timing of specific events, such as transaction authorisations, captures, or any other significant activity related to the merchant's operations. The format adheres to ISO 8601 standards, ensuring consistency and ease of parsing for system integration.","type":"string","format":"date-time","example":"2021-10-27T08:51:04.826Z"}},"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","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":36,"minLength":36,"type":"string"}},"components/schemas/gratuityValue":{"id":"components/schemas/gratuityValue","kind":"json-schema","title":"gratuityValue","data":{"description":"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.","example":5.01,"type":"number"}},"components/schemas/intent":{"id":"components/schemas/intent","kind":"json-schema","title":"intent","data":{"description":"The purpose or action of the transaction, indicating the intended money flow direction. This field is crucial for categorising the transaction type and guiding the processing logic accordingly. Options include 'Authorisation' for reserving funds on the customer's payment method, 'Purchase' for immediate fund capture following authorisation, and 'Payout' for sending funds to a recipient. Each intent dictates a specific transaction flow and affects how the transaction is handled by the system.","type":"string","enum":["Authorisation","Capture","Create","EstimatedAuthorisation","Purchase","Payout","Refund","Verification","Void"],"example":"Authorisation"}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"merchant","data":{"description":"A unique identifier assigned by PXP to represent a merchant entity, such as a store, hotel, or website, within the payment processing system. This identifier is crucial for routing transactions to the correct merchant account, ensuring accurate processing, settlement, and reporting. Merchants receive this value upon registration or integration with PXP, and it must be included in transaction requests to identify the merchant for whom the transaction is being processed.","example":"MERCHANT-1","type":"string","maxLength":20}},"components/schemas/merchantAdvice":{"id":"components/schemas/merchantAdvice","kind":"json-schema","title":"merchantAdvice","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides additional guidance or recommendations from the card network regarding the transaction. This information is particularly useful for understanding the reasons behind a transaction's refusal and can offer suggestions for next steps. For instance, it might indicate that updated account information is available or suggest specific actions to resolve the refusal. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantAdvice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to detail this advisory information, making it easier for merchants to take corrective action or understand the refusal context."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"An advisory code provided by the card network that categorises the type of advice or recommendation."},"message":{"type":"string","description":"A human-readable message that provides further details or clarification about the advice code, potentially suggesting next steps or reasons for the transaction refusal."}},"type":"object"}},"components/schemas/merchantOrderId":{"id":"components/schemas/merchantOrderId","kind":"json-schema","title":"merchantOrderId","data":{"description":"A unique order reference provided by you, the merchant, to uniquely identify and link multiple related transactions. This identifier serves as a key component for tracking and reconciling transactions associated with specific purchase orders or service requests within your system. Utilizing this reference enables efficient management and querying of transactional data, ensuring consistency across your financial reporting and customer service operations.","example":"merchant_order_id","type":"string","maxLength":50}},"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"}},"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":"merchant_transaction_id","type":"string","maxLength":50}},"components/schemas/eventOwner":{"id":"components/schemas/eventOwner","kind":"json-schema","title":"eventOwner","data":{"description":"The entity that owns the event.","type":"object","properties":{"partner":{"type":"string","description":"The partner identifier.","example":"partner-1"},"merchantGroup":{"type":"string","description":"The merchant group identifier.","example":"merchant-group-1"},"merchant":{"type":"string","description":"The merchant identifier.","example":"merchant-1"},"site":{"type":"string","description":"The site identifier.","example":"site-1"}}}},"components/schemas/merchantWebhookRequest":{"id":"components/schemas/merchantWebhookRequest","kind":"json-schema","title":"merchantWebhookRequest","data":{"description":"The payload of a webhook request sent to the merchant, containing details of a transaction event. This schema includes information such as the event date, merchant identifier, site, transaction method, transaction amounts, transaction state, transaction details, card details, and provider response.","required":["eventDate","eventCategory","eventData"],"properties":{"eventDate":{"$ref":"#/components/schemas/eventDate"},"eventCategory":{"$ref":"#/components/schemas/eventCategory"},"eventOwner":{"$ref":"#/components/schemas/eventOwner"},"eventData":{"oneOf":[{"$ref":"#/components/schemas/authenticationData"},{"$ref":"#/components/schemas/transactionData"},{"$ref":"#/components/schemas/aeropayTransactionData"},{"$ref":"#/components/schemas/speiTransactionData"},{"$ref":"#/components/schemas/tokenData"},{"$ref":"#/components/schemas/reportingData"},{"$ref":"#/components/schemas/userInfoData"},{"$ref":"#/components/schemas/aeropayUserStatusData"}]}}}},"components/schemas/merchantWebhookResponse":{"id":"components/schemas/merchantWebhookResponse","kind":"json-schema","title":"merchantWebhookResponse","data":{"description":"The response sent by the merchant to acknowledge receipt and processing status of a PXP webhook request. This schema includes the state of the response, indicating whether the processing was successful or encountered an error.","properties":{"state":{"description":"The current state of the response.","enum":["Success"],"example":"Success","type":"string"}},"required":["state"]}},"components/schemas/paymentAccountReference":{"id":"components/schemas/paymentAccountReference","kind":"json-schema","title":"paymentAccountReference","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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.  Will only be sent if the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SchemeTokenCreated"},"children":[]}]}]}],"type":"string","example":"acc-987654321"}},"components/schemas/providerResponseName":{"id":"components/schemas/providerResponseName","kind":"json-schema","title":"providerResponseName","data":{"description":"The name of the provider that processed the transaction.","example":"PXPFinancial","type":"string"}},"components/schemas/providerResponseCode":{"id":"components/schemas/providerResponseCode","kind":"json-schema","title":"providerResponseCode","data":{"description":"The raw result code returned by the provider that processed the transaction.","example":"00","type":"string"}},"components/schemas/providerResponseMessage":{"id":"components/schemas/providerResponseMessage","kind":"json-schema","title":"providerResponseMessage","data":{"description":"The raw message associated with the result code from the provider that processed the transaction.","example":"Transaction Approved","type":"string"}},"components/schemas/providerResponseMerchantId":{"id":"components/schemas/providerResponseMerchantId","kind":"json-schema","title":"providerResponseMerchantId","data":{"description":"The unique identifier assigned by the provider to represent the merchant involved in the transaction processing.","example":"77772182","type":"string"}},"components/schemas/providerTransactionId":{"id":"components/schemas/providerTransactionId","kind":"json-schema","title":"providerTransactionId","data":{"type":"string","nullable":true,"description":"A unique identifier assigned by the financial service provider for the transaction. It facilitates tracking, reconciliation, and support processes."}},"components/schemas/providerResponseAvsResult":{"id":"components/schemas/providerResponseAvsResult","kind":"json-schema","title":"providerResponseAvsResult","data":{"description":"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 fundingType is 'card'.","type":"string","example":"A"}},"components/schemas/providerResponseCvcResult":{"id":"components/schemas/providerResponseCvcResult","kind":"json-schema","title":"providerResponseCvcResult","data":{"description":"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 fundingType is 'card'.","type":"string","example":"D"}},"components/schemas/schemeTransactionId":{"id":"components/schemas/schemeTransactionId","kind":"json-schema","title":"schemeTransactionId","data":{"type":"string","description":"A unique identifier assigned by the card scheme (e.g., Visa, Mastercard) to each transaction. This identifier is crucial for tracking, reconciliation, and managing the lifecycle of the transaction, especially in contexts like chargebacks and fraud analysis. For card transactions, this could be the Visa Transaction Identifier or MasterCard Banknet Reference Number.","example":"1234567890123456789012"}},"components/schemas/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"}},"components/schemas/settlementDate":{"id":"components/schemas/settlementDate","kind":"json-schema","title":"settlementDate","data":{"type":"string","format":"date-time","description":"The date and time on which the transaction funds are settled between banks for Mastercard payments. Returned as an ISO 8601 date-time.","example":"2024-01-25T00:00:00Z"}},"components/schemas/site":{"id":"components/schemas/site","kind":"json-schema","title":"site","data":{"description":"The unique site identifier associated with the transaction. This could represent a physical location, website, or any other distinct entity where the transaction occurs. The value for this field is generated by PXP.","example":"SITE-1","maxLength":20,"type":"string"}},"components/schemas/tokenState":{"id":"components/schemas/tokenState","kind":"json-schema","title":"tokenState","data":{"description":"The state of the scheme token indicating its current status or action taken.","enum":["Completed","Error","SchemeTokenCardUpdated","SchemeTokenCreated","SchemeTokenDisabled","SchemeTokenUpdated"],"example":"SchemeTokenCreated","type":"string"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"state","data":{"description":"The current state of the transaction.","enum":["Authorised","Cancelled","Captured","Error","Executed","Pending","Refunded","Refused","Aborted","Expired","Rejected"],"example":"Authorised","type":"string"}},"components/schemas/systemTransactionId":{"id":"components/schemas/systemTransactionId","kind":"json-schema","title":"systemTransactionId","data":{"description":"The unique identifier generated by PXP for each transaction. It serves as a reference for tracking and querying transactions within the PXP system. This Id is crucial for performing modifications or querying transaction details.","example":"1ed768bb-e88a-4636-91ae-67927ccbb02b","minimum":36,"maximum":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"components/schemas/transactionValue":{"id":"components/schemas/transactionValue","kind":"json-schema","title":"transactionValue","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the amount of the transaction. The numbers after the decimal will be zero padded if they are less than the expected currencyCode exponent. For example, GBP 1.1 = GBP 1.10, EUR 1 = EUR 1.00, or BHD 1.3 = 1.300. The transaction will be rejected if numbers after the decimal are greater than the expected currencyCode exponent, for example, GBP 1.234, or if a decimal is supplied when the currencyCode of exponent does not require it, for example, JPY 1.0."},"children":[]}]}]}],"example":30.32,"type":"number"}},"components/schemas/transactionStatus":{"id":"components/schemas/transactionStatus","kind":"json-schema","title":"transactionStatus","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The EMV 3D Secure transaction status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") returned for the authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Not authenticated / account not verified; transaction denied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification could not be performed (for example, a technical problem)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attempts processing performed; not authenticated or verified, but proof of attempted authentication or verification is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge required; additional authentication is required using the CReq/CRes messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge required; decoupled authentication confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Authentication / account verification rejected; the issuer is rejecting authentication or verification and requests that authorisation not be attempted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational only; the 3DS Requestor challenge preference is acknowledged."},"children":[]}]}]}]}],"enum":["Y","N","U","A","C","D","R","I"],"example":"Y","type":"string"}},"components/schemas/tokenData":{"id":"components/schemas/tokenData","kind":"json-schema","title":"tokenData","data":{"required":["state","schemeTokenProvider","schemeTokenId","expiryMonth","expiryYear","maskedPrimaryAccountNumber"],"properties":{"state":{"type":"string","description":"The state of the scheme token.","enum":["Completed","Error"],"example":"Completed"},"schemeTokenProvider":{"description":"Indicates whether the scheme token provider is Visa or Mastercard for the API notification being sent to a merchant.","type":"string","example":"Visa","enum":["Mastercard","Visa"]},"schemeTokenId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique scheme token ID generated by PXP. It is used as a reference to extract the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schemeTokenNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","format":"uuid","type":"string"},"externalSchemeTokenId":{"description":"A unique identifier token provided by the external payment scheme. This token allows merchants to process payments through different payment service providers (PSPs) or transaction service providers (TSPs). The token facilitates interoperability between different PSPs, enabling merchants to seamlessly integrate with and utilize various payment processing services.","format":"uuid","example":"ext-123456789","type":"string","nullable":true},"paymentAccountReference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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.  Will only be sent if the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SchemeTokenCreated"},"children":[]}]}]}],"type":"string","example":"acc-987654321"},"expiryMonth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry month [MM] of the card."},"children":[]}]}]}],"example":3,"type":"integer"},"expiryYear":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiry year [YYYY] of the card."},"children":[]}]}]}],"example":2025,"type":"integer"},"maskedPrimaryAccountNumber":{"description":"A masked version of the unique number assigned to a payment card, such as a credit or debit card.","example":"411111*********1111","maxLength":19,"minLength":10,"type":"string"}}}},"components/schemas/transactionData":{"id":"components/schemas/transactionData","kind":"json-schema","title":"transactionData","data":{"required":["state","merchant","site","merchantTransactionDate","merchantTransactionId","systemTransactionId"],"properties":{"eventCode":{"type":"string","description":"A short code identifying the webhook event type.","example":"TXN_RFU"},"state":{"$ref":"#/components/schemas/state"},"stateData":{"type":"object","description":"Key value pair for various state data. Every transaction response includes a response code and response message that provide detailed information about the transaction outcome. These codes follow the ISO 8535 standard.","properties":{"code":{"type":"string","description":"The state details code following the ISO 8535 standard.","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","VAN0001"],"example":"CRD000"},"message":{"type":"string","description":"The state details message corresponding to the code.","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","General execution error"],"example":"Approved"}}},"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"transactionMethod":{"oneOf":[{"title":"object","allOf":[{"$ref":"#/components/schemas/transactionMethod"}]},{"title":"string","type":"string","description":"Transaction method as a string (used for payout transactions).","example":"Payout"}]},"amounts":{"type":"object","required":["currencyCode"],"properties":{"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"transaction":{"$ref":"#/components/schemas/transactionValue"},"transactionValue":{"$ref":"#/components/schemas/transactionValue"},"gratuityValue":{"$ref":"#/components/schemas/gratuityValue"}}},"amount":{"type":"object","description":"Amount details for payout transactions (singular, used instead of amounts).","properties":{"transaction":{"type":"number","description":"The transaction amount.","example":100},"currencyCode":{"$ref":"#/components/schemas/currencyCode"}}},"approvalCode":{"$ref":"#/components/schemas/approvalCode"},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"merchantOrderId":{"$ref":"#/components/schemas/merchantOrderId"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"providerTransactionId":{"$ref":"#/components/schemas/providerTransactionId"},"shippingAddress":{"type":"object","description":"Shipping address details for the transaction.","properties":{"addressLine1":{"type":"string","description":"First line of the address.","example":"123 Main St"},"addressLine2":{"type":"string","description":"Second line of the address.","example":"Apt 4B"},"postalCode":{"type":"string","description":"Postal code.","example":"12345"},"countryCode":{"type":"string","description":"Country code.","example":"US"},"city":{"type":"string","description":"City name.","example":"New York"},"county":{"type":"string","description":"County or region.","example":"Manhattan"}}},"fundingData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data specifying the payment method used for the transaction. Contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on the funding type."},"children":[]}]}]}],"type":"object","properties":{"card":{"$ref":"#/components/schemas/card"},"paypal":{"$ref":"#/components/schemas/paypal"}}}}}},"components/schemas/transactionMethod":{"id":"components/schemas/transactionMethod","kind":"json-schema","title":"transactionMethod","data":{"description":"Comprehensive details about the intent, capture method, and origin of a transaction.","required":["entryType","fundingType","intent"],"properties":{"entryType":{"$ref":"#/components/schemas/entryType"},"fundingType":{"$ref":"#/components/schemas/fundingType"},"intent":{"$ref":"#/components/schemas/intent"}},"type":"object"}},"components/schemas/aeropayTransactionData":{"id":"components/schemas/aeropayTransactionData","kind":"json-schema","title":"aeropayTransactionData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload for Aeropay pay-by-bank transaction webhooks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_AUTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_CPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_CNC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TXNAP_RFD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Delivered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a single webhook object. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is injected by the notifications service when the webhook is sent."},"children":[]}]}]}],"type":"object","required":["eventCode","state","merchant","site","merchantTransactionDate","merchantTransactionId","systemTransactionId","amounts","transactionMethod","fundingData"],"properties":{"eventCode":{"type":"string","description":"Aeropay transaction webhook event code.","enum":["TXNAP_AUTH","TXNAP_CPT","TXNAP_CNC","TXNAP_RFD"],"example":"TXNAP_AUTH"},"state":{"type":"string","description":"Transaction state for the Aeropay event.","enum":["Authorised","Captured","Cancelled","Refunded"],"example":"Authorised"},"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"transactionMethod":{"type":"object","description":"Method details for the Aeropay transaction.","required":["intent","fundingType","entryType"],"properties":{"intent":{"type":"string","description":"Transaction intent for this event.","enum":["Purchase","Authorisation","Capture","Void","Refund","EstimatedAuthorisation"],"example":"Purchase"},"fundingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Aeropay transaction webhooks."},"children":[]}]}]}],"enum":["PayByBank"],"example":"PayByBank"},"entryType":{"$ref":"#/components/schemas/entryType"}}},"amounts":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction amount. Aeropay uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":["transaction","currencyCode"],"properties":{"transaction":{"$ref":"#/components/schemas/transactionValue"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"}}},"merchantTransactionDate":{"$ref":"#/components/schemas/merchantTransactionDate"},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"originalSystemTransactionId":{"type":"string","description":"Identifier of the original system transaction. Present on modification webhooks (capture, void, refund, and incremental authorisation).","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","example":"4f2f8f79-1fa6-4c88-9dee-3de55925498c"},"fundingData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data for Aeropay. Contains only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["payByBank"],"properties":{"payByBank":{"$ref":"#/components/schemas/payByBank"}}},"providerResponse":{"$ref":"#/components/schemas/aeropayProviderResponse"}}}},"components/schemas/speiPayByBank":{"id":"components/schemas/speiPayByBank","kind":"json-schema","title":"speiPayByBank","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 details for SPEI transaction webhooks. Present 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":". Webhooks do not include OKTO payment identifiers."},"children":[]}]}]}],"type":"object","required":["apmProvider"],"properties":{"apmProvider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative payment method provider. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for SPEI webhooks."},"children":[]}]}]}],"enum":["Spei"],"example":"Spei"}}}},"components/schemas/speiProviderResponse":{"id":"components/schemas/speiProviderResponse","kind":"json-schema","title":"speiProviderResponse","data":{"description":"Mapped provider outcome for SPEI transaction webhooks. Uses PXP-mapped values only; never raw OKTO ingress fields.","type":"object","properties":{"provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider name. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Spei"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for SPEI webhooks."},"children":[]}]}]}],"enum":["Spei"],"example":"Spei"},"providerTransactionStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapped provider transaction status. Mirrors the webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the correlated intent."},"children":[]}]}]}],"example":"Authorised"},"providerResponseCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapped provider response code (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUNDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"EXECUTED"},"providerResponseMessage":{"type":"string","description":"Mapped provider response message.","example":"Payment executed"}}}},"components/schemas/speiTransactionData":{"id":"components/schemas/speiTransactionData","kind":"json-schema","title":"speiTransactionData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload for SPEI pay-by-bank transaction webhooks. Delivered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a single webhook object. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionMethod.intent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to distinguish Purchase from Payout when the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies to both."},"children":[]}]}]}],"type":"object","required":["eventCode","state","stateData","merchant","site","merchantTransactionId","systemTransactionId","amounts","transactionMethod","fundingData"],"properties":{"eventCode":{"type":"string","description":"The SPEI transaction webhook notification type.","enum":["spei-transaction-order-executed","spei-transaction-order-declined","spei-transaction-order-expired","spei-transaction-order-failed","spei-transaction-order-refunded","spei-transaction-order-rejected"],"example":"spei-transaction-order-executed"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction state for the SPEI event. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spei-transaction-order-declined"},"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":" resolves to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Aborted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resolves to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Refused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Authorised","Aborted","Refused","Expired","Refunded","Rejected"],"example":"Authorised"},"stateData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state details for the SPEI outcome. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values follow the shared APM convention."},"children":[]}]}]}],"required":["code","message"],"properties":{"code":{"type":"string","description":"The SPEI state details code.","enum":["APM001","APM004","APM007","APM011","APM012","APM013"],"example":"APM001"},"message":{"type":"string","description":"The human-readable state details message.","example":"Payment executed"}}},"merchant":{"$ref":"#/components/schemas/merchant"},"site":{"$ref":"#/components/schemas/site"},"transactionMethod":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method details for the SPEI transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects the original stored transaction ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), including on terminal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications."},"children":[]}]}]}],"required":["intent","fundingType","entryType"],"properties":{"intent":{"type":"string","description":"The original transaction intent.","enum":["Purchase","Payout"],"example":"Purchase"},"fundingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The funding this. This is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for SPEI transaction webhooks."},"children":[]}]}]}],"enum":["PayByBank"],"example":"PayByBank"},"entryType":{"$ref":"#/components/schemas/entryType"}}},"amounts":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction amount. SPEI uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MXN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["transaction","currencyCode"],"properties":{"transaction":{"$ref":"#/components/schemas/transactionValue"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"}}},"merchantTransactionId":{"$ref":"#/components/schemas/merchantTransactionId"},"systemTransactionId":{"$ref":"#/components/schemas/systemTransactionId"},"fundingData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding data for SPEI. Contains only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payByBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["payByBank"],"properties":{"payByBank":{"$ref":"#/components/schemas/speiPayByBank"}}},"providerResponse":{"$ref":"#/components/schemas/speiProviderResponse"}}}}},"exampleStore":{"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"transaction","eventData":{"state":"Authorised","stateData":{"code":"CRD000","message":"Approved"},"approvalCode":"123456","merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Authorisation","fundingType":"Card","entryType":"Ecom"},"amounts":{"transactionValue":50.05,"currencyCode":"EUR"},"merchantOrderId":"merchant_order_id","merchantTransactionId":"merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","fundingData":{"cardScheme":"Visa","tokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","addressVerificationServiceResult":"D","cardVerificationCodeResult":"A","schemeTransactionId":"TX1234567890123456","paymentAccountReference":"PAR12345678901234567890","electronicCommerceIndicatorAdjustment":"01","settlementDate":"2024-01-25"}}}},"key":"Transaction authorised (card)","summary":"Transaction authorised (card)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (card)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"transaction","eventData":{"state":"Captured","stateData":{"code":"CRD000","message":"Approved"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Capture","fundingType":"Card","entryType":"Ecom"},"amounts":{"transactionValue":50.05,"currencyCode":"EUR"},"merchantOrderId":"This_is_my_merchant_order_id","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","fundingData":{"cardScheme":"Visa","tokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456","settlementDate":"2024-01-25T00:00:00Z"}}}},"key":"Transaction captured (card)","summary":"Transaction captured (card)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (card)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"transaction","eventData":{"state":"Cancelled","stateData":{"code":"CRD000","message":"Approved"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Void","fundingType":"Card","entryType":"Ecom"},"amounts":{"transactionValue":50.05,"currencyCode":"EUR"},"merchantOrderId":"This_is_my_merchant_order_id","merchantTransactionId":"This_is_my_merchant_transaction_id","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b","merchantTransactionDate":"2024-01-27 08:51:02.826445+00:00","fundingData":{"cardScheme":"Visa","tokenId":"1ed768bb-e88a-4636-91ae-67927ccbb03a","schemeTokenNumber":"4837261112345678","providerResponse":{"provider":"PXPFinancial","code":"00","message":"Approved","merchantId":"77772182","paymentAccountReference":"PAR12345678901234567890","schemeTransactionId":"TX1234567890123456"}}}},"key":"Transaction cancelled (card)","summary":"Transaction cancelled (card)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (card)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)":{"value":{"eventCategory":"transaction","eventData":{"amounts":{"currencyCode":"GBP","transaction":40},"eventCode":"TXN_RFU","fundingData":{"card":{"cardScheme":"JCB","gatewayTokenId":"821e3173-5c21-4a39-8495-627dcdfc12e8","nameVerificationResult":null,"providerResponse":{"addressVerificationServiceResult":"","authorisedAmount":0,"cardVerificationCodeResult":"","code":"30","issuerResponseCode":"","merchantAdvice":{},"merchantId":"000100800004485","message":"Format error.","provider":"lloydscardnet","settlementDate":"2026-06-26T00:00:00.000Z","terminalId":"30121285"}}},"merchant":"Unity","merchantTransactionDate":"2026-06-26T11:14:02.123445+00:00","merchantTransactionId":"283996_11","providerTransactionId":null,"site":"UnityLLD","state":"Refused","stateData":{"code":"CRD182","message":"Bad format"},"systemTransactionId":"2eb35ccd-fa18-4fe9-adb6-33f395851482","transactionMethod":{"entryType":"Instore","fundingType":"Card","intent":"Purchase"}},"eventDate":"2026-06-26T10:34:43.2760930Z","eventOwner":{"merchant":"Unity","merchantGroup":"UnityGroup","site":"UnityLLD"}},"key":"Transaction refused (card)","summary":"Transaction refused (card)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refused (card)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)":{"value":{"eventCategory":"transaction","eventData":{"amounts":{"currencyCode":"GBP","transaction":5.68},"eventCode":"TXN_ERR","fundingData":{"card":{"gatewayTokenId":"84136fa0-78b7-48b9-8a0a-1d9fd399c923","nameVerificationResult":null,"providerResponse":{"emvDataResponse":{"applicationIdentifier":"A0000000041010","applicationLabel":"MASTERCARD","primaryAccountNumberSequenceNumber":"11"},"merchantAdvice":{}}}},"merchant":"Unity","merchantTransactionDate":"2026-06-26T09:53:31.5562494+00:00","merchantTransactionId":"713-392-236_26062026045330454","providerTransactionId":null,"site":"UnityVAN","state":"Error","stateData":{"code":"VAN0001","message":"General execution error"},"systemTransactionId":"e68beb39-55bb-4575-8c2c-bf22c630c324","transactionMethod":{"entryType":"Instore","fundingType":"Card","intent":"Purchase"}},"eventDate":"2026-06-26T09:53:56.7153731Z","eventOwner":{"merchant":"Unity","merchantGroup":"UnityGroup","site":"UnityVAN"}},"key":"Transaction error (card)","summary":"Transaction error (card)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction error (card)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"token","eventData":{"schemeTokenId":"68412215-aae5-4380-be63-c52e7868eab5","schemeTokenProvider":"Visa","state":"Completed","externalSchemeTokenId":"7a60cfe4-df64-4e5d-b3d3-0b70713dd70b","paymentAccountReference":"V0010013024080362079202015296","expiryMonth":4,"expiryYear":2030,"maskedPrimaryAccountNumber":"47158511****6438"}},"key":"Scheme token created","summary":"Scheme token created","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token created"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"token","eventData":{"schemeTokenId":"bf53d5d5-6481-4c6b-9a99-deb4a319fb06","schemeTokenProvider":"Mastercard","state":"Completed","externalSchemeTokenId":"1c871554-d90d-4676-89a6-e11a1bed3999","paymentAccountReference":"50010P4G3SYR1Q9RJVY18EDBHWQZT","expiryMonth":12,"expiryYear":2030,"maskedPrimaryAccountNumber":"52660010****0025"}},"key":"Scheme token card updated","summary":"Scheme token card updated","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token card updated"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"token","eventData":{"schemeTokenId":"bd420b08-00bc-4cfe-9b6b-84e52176c5b7","schemeTokenProvider":"Mastercard","state":"Completed","externalSchemeTokenId":"a43d958e-e7a9-47b0-9a37-2f923744f59e","paymentAccountReference":"50010P4G3SYR1Q9RJVY18EDBHWQZT","expiryMonth":4,"expiryYear":2027,"maskedPrimaryAccountNumber":"52660010****0026"}},"key":"Scheme token disabled","summary":"Scheme token disabled","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token disabled"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"token","eventData":{"schemeTokenId":"fc8aa727-ec3c-4cf1-9c2b-26e4f78ce7b7","schemeTokenProvider":"Visa","state":"Error","externalSchemeTokenId":null,"paymentAccountReference":null,"expiryMonth":3,"expiryYear":2033,"maskedPrimaryAccountNumber":"41000000******0001"}},"key":"Scheme token creation error","summary":"Scheme token creation error","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token creation error"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"token","eventData":{"state":"SchemeTokenUpdated"}},"key":"Scheme token updated","summary":"Scheme token updated","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheme token updated"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed":{"value":{"eventDate":"2021-10-27T08:51:04.8264455Z","eventCategory":"authentication","eventData":{"authenticationId":"5a13aae9-a0b1-4e3d-bcfb-1dbc90b5611f","authenticationState":"AuthenticationSuccessful","transactionStatus":"A","transactionStatusReason":null,"directoryServerTransactionId":"5a4d019d-6c96-44c8-a625-636bc35ca0ac","threeDSecureVersion":"2.2.0","electronicCommerceIndicator":"05","authenticationFlow":"Challenge","challengeCancel":null,"challengeErrorReporting":null}},"key":"Challenge completed","summary":"Challenge completed","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Challenge completed"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Pending","amounts":{"transaction":100,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445+00:00","merchantTransactionId":"Create test 2","systemTransactionId":"cb6c3fb9-fb0f-4924-b301-798d4606a3a8","providerTransactionId":"8TV523960U3224341","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Paypal","experienceContext":{"paymentDescription":"Louis Vuitton bag QC Test","userAction":"PAY_NOW","orderType":"Authorisation","shippingPreference":"GET_FROM_FILE"}}}}},"key":"Transaction created (PayPal)","summary":"Transaction created (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Executed","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445+00:00","merchantTransactionId":"Create test 2","systemTransactionId":"cb6c3fb9-fb0f-4924-b301-798d4606a3a8","providerTransactionId":"8TV523960U3224341","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Paypal"}}}},"key":"Transaction executed (PayPal)","summary":"Transaction executed (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)":{"value":{"eventDate":"2025-06-20T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Captured","amounts":{"transaction":10,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Capture","fundingType":"Paypal","entryType":"Ecom"},"shippingAddress":{"addressLine1":"123 Main St","addressLine2":"Apt 4B","postalCode":"12345","countryCode":"US","city":"New York","county":"Manhattan"},"merchantTransactionDate":"2025-06-20T03:13:22.93Z","merchantTransactionId":"merchant_transaction_confirm_id_007","systemTransactionId":"e155b186-c6ea-4cb9-9a6c-590ef6daeeed","providerTransactionId":"52K24494FC626730T","fundingData":{"paypal":{"payeeEmailAddress":"payee@mail.com","paymentSource":"Paypal","experienceContext":{"paymentDescription":"Purchase from test site","userAction":"pay_now","orderType":"goods","shippingPreference":"set_provided_address"},"shippingSelected":{"id":"shipping_id","label":"shipping_label","selected":true,"amounts":{"shipping":1,"currencyCode":"USD"},"type":"shipping"}}}}},"key":"Transaction captured (PayPal)","summary":"Transaction captured (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Authorised","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Authorisation","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_confirm_id_0001","systemTransactionId":"38e1cc67-b1c9-4b46-abda-03ec5caeae8d","providerTransactionId":"95488117F3090464T","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Paypal"}}}},"key":"Transaction authorised (PayPal)","summary":"Transaction authorised (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Refunded","amounts":{"transaction":0.1,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Refund","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_refund_id_0001","systemTransactionId":"875f36e7-dbd9-44a1-be71-46bd97bc5efc","providerTransactionId":"8UE54115C2538705D","fundingData":{"paypal":{"paymentSource":"Paypal"}}}},"key":"Transaction refunded (PayPal)","summary":"Transaction refunded (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Cancelled","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Void","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_void_id_0003","systemTransactionId":"43326543-6956-469d-a1a0-64e6d9bb54c7","fundingData":{"paypal":{"paymentSource":"Paypal"}}}},"key":"Transaction cancelled (PayPal)","summary":"Transaction cancelled (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Pending","amounts":{"transaction":100,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445+00:00","merchantTransactionId":"Create test paylater 6","systemTransactionId":"671ebf55-22a9-4717-a1b9-0d592e3d6ede","providerTransactionId":"79095268FF6175738","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"PayLater","experienceContext":{"paymentDescription":"Louis Vuitton bag QC Test","userAction":"PAY_NOW","orderType":"Authorisation","shippingPreference":"GET_FROM_FILE"}}}}},"key":"Transaction created (Pay Later)","summary":"Transaction created (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Executed","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445","merchantTransactionId":"Create test paylater 6","systemTransactionId":"671ebf55-22a9-4717-a1b9-0d592e3d6ede","providerTransactionId":"79095268FF6175738","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"PayLater"}}}},"key":"Transaction executed (Pay Later)","summary":"Transaction executed (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Authorised","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Authorisation","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_confirm_paylater_id_0005","systemTransactionId":"4d91b167-fa3d-4d5a-aa6b-ecd5a97a5cae","providerTransactionId":"1B135095DL3382301","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"PayLater"}}}},"key":"Transaction authorised (Pay Later)","summary":"Transaction authorised (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)":{"value":{"eventDate":"2025-06-20T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Captured","amounts":{"transaction":1,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Capture","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T03:13:22.93Z","merchantTransactionId":"merchant Capture TransactionId paylater 0004","systemTransactionId":"3470aaa0-5136-409a-9e3e-fc58ef4c6fa5","providerTransactionId":"1X609527EV445235N","fundingData":{"paypal":{"paymentSource":"PayLater"}}}},"key":"Transaction captured (Pay Later)","summary":"Transaction captured (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Refunded","amounts":{"transaction":0.1,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Refund","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_refund_paylater_id_0002","systemTransactionId":"810c2d26-b606-4c0d-8e25-89997ede486d","providerTransactionId":"80B21926CC5840333","fundingData":{"paypal":{"paymentSource":"PayLater"}}}},"key":"Transaction refunded (Pay Later)","summary":"Transaction refunded (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Cancelled","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Void","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_void_paylater_id_0006","systemTransactionId":"72aed261-41e0-4696-b46a-e272c127e6c9","fundingData":{"paypal":{"paymentSource":"PayLater"}}}},"key":"Transaction cancelled (Pay Later)","summary":"Transaction cancelled (Pay Later)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Pay Later)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Pending","amounts":{"transaction":100,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445+00:00","merchantTransactionId":"Create test 4","systemTransactionId":"b3436453-f347-4444-9871-5a3beabf4acc","providerTransactionId":"5E781953VF346004S","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Venmo","experienceContext":{"paymentDescription":"Louis Vuitton bag QC Test","userAction":"PAY_NOW","orderType":"Authorisation","shippingPreference":"GET_FROM_FILE"}}}}},"key":"Transaction created (Venmo)","summary":"Transaction created (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction created (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)":{"value":{"eventDate":"2025-06-20T00:00:00.826445Z","eventCategory":"transaction","eventData":{"state":"Executed","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Create","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T00:00:00.826445","merchantTransactionId":"Create test 4","systemTransactionId":"b3436453-f347-4444-9871-5a3beabf4acc","providerTransactionId":"5E781953VF346004S","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Venmo"}}}},"key":"Transaction executed (Venmo)","summary":"Transaction executed (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Authorised","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Authorisation","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_confirm_id_0003","systemTransactionId":"60e41343-6ef2-490f-a679-ae7738b603cf","providerTransactionId":"84V813517U892664E","fundingData":{"paypal":{"payeeEmailAddress":"john.doe@pxp.io","paymentSource":"Venmo"}}}},"key":"Transaction authorised (Venmo)","summary":"Transaction authorised (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)":{"value":{"eventDate":"2025-06-20T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Captured","amounts":{"transaction":1,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Capture","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-20T03:13:22.93Z","merchantTransactionId":"merchant Capture TransactionId Venmo 0003","systemTransactionId":"af200906-3cf3-4693-a2f7-d8a5a14b6657","providerTransactionId":"62965733U4680700F","fundingData":{"paypal":{"paymentSource":"Venmo"}}}},"key":"Transaction captured (Venmo)","summary":"Transaction captured (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Refunded","amounts":{"transaction":0.1,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Refund","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_refund_venmo_id_0001","systemTransactionId":"b065e353-1e5c-4436-85dc-03bc3f6531cc","providerTransactionId":"01A49403R4069073P","fundingData":{"paypal":{"paymentSource":"Venmo"}}}},"key":"Transaction refunded (Venmo)","summary":"Transaction refunded (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"state":"Cancelled","amounts":{"transaction":16,"currencyCode":"USD"},"merchant":"merchant-1","site":"site-1","transactionMethod":{"intent":"Void","fundingType":"Paypal","entryType":"Ecom"},"merchantTransactionDate":"2025-06-27T03:13:22.93Z","merchantTransactionId":"merchant_transaction_void_venmo_id_0004","systemTransactionId":"8bebd5a3-2b49-4461-8599-f0a7b913473a","fundingData":{"paypal":{"paymentSource":"Venmo"}}}},"key":"Transaction cancelled (Venmo)","summary":"Transaction cancelled (Venmo)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Venmo)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)":{"value":{"eventDate":"2025-12-16T07:37:11.1613200Z","eventCategory":"transaction","eventData":{"state":"Authorised","amount":{"transaction":100,"currencyCode":"USD"},"transactionMethod":"Payout","merchant":"merchant-1","site":"site-1","merchantTransactionDate":"2025-12-16T07:37:11.1613200Z","merchantTransactionId":"PAYOUT_001","systemTransactionId":"787ebfee-c0ce-497a-82c3-265d1bf19b0c","providerTransactionId":"PAYPAL_PAYOUT_ITEM_ID","fundingData":{"paypal":{"paymentSource":"Paypal"}}}},"key":"Payout authorised (PayPal)","summary":"Payout authorised (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Payout authorised (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"transaction","eventData":{"merchant":"merchant-1","site":"site-1","customerInformation":{"id":"a7cd91cd-1bb8-4f82-af24-350d6d0b8680","name":"John Doe","email":"sb-oejwh44573747@business.example.com","verified":true,"payerId":"BLLXSEJZ9B7ZA","address":{"streetAddress":"1 Main St","locality":"San Jose","region":"CA","postalCode":"95131","countryCode":"US"},"verifiedAccount":true,"emailVerified":true},"eventCode":"TXNPP_UIC"}},"key":"User info created (PayPal)","summary":"User info created (PayPal)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User info created (PayPal)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)":{"value":{"eventDate":"2026-07-10T08:30:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"merchant-1","site":"site-1"},"eventData":{"eventCode":"TXNAP_AUTH","state":"Authorised","merchant":"merchant-1","site":"site-1","merchantTransactionId":"merch-txn-001","merchantTransactionDate":"2026-07-10T08:00:00Z","systemTransactionId":"6b0320d8-b24e-404c-9048-136d83e033f7","amounts":{"transaction":100,"currencyCode":"USD"},"transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Aeropay","achStatus":"Approved","isRtp":false,"authorisationExpiryDate":"2026-07-17T08:00:00+00:00","user":{"id":"761a3e91-4062-4fc2-80a4-dc12c8601522","name":"John Doe","email":"john.doe@example.com"},"bank":{"accountId":1895546,"name":"Chase Bank","accountLastFour":"1234","accountType":"Checking"}}},"providerResponse":{"providerTransactionId":"67b68945-aab8-4404-a474-4270a588491b","providerTransactionStatus":"live"}}},"key":"Transaction authorised (Aeropay)","summary":"Transaction authorised (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction authorised (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)":{"value":{"eventDate":"2026-07-10T09:00:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"merchant-1","site":"site-1"},"eventData":{"eventCode":"TXNAP_CPT","state":"Captured","merchant":"merchant-1","site":"site-1","merchantTransactionId":"merch-txn-001-cap","merchantTransactionDate":"2026-07-10T09:00:00Z","systemTransactionId":"6b0320d8-b24e-404c-9048-136d83e033f7","originalSystemTransactionId":"4f2f8f79-1fa6-4c88-9dee-3de55925498c","amounts":{"transaction":100,"currencyCode":"USD"},"transactionMethod":{"intent":"Capture","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Aeropay","apFee":"222","isRtp":false,"user":{"id":"761a3e91-4062-4fc2-80a4-dc12c8601522","name":"John Doe","email":"john.doe@example.com"},"bank":{"accountId":1895546,"name":"Chase Bank","accountLastFour":"1234","accountType":"Checking"}}},"providerResponse":{"providerTransactionId":"67b68945-aab8-4404-a474-4270a588491b","providerTransactionStatus":"live"}}},"key":"Transaction captured (Aeropay)","summary":"Transaction captured (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction captured (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)":{"value":{"eventDate":"2026-07-10T09:30:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"merchant-1","site":"site-1"},"eventData":{"eventCode":"TXNAP_CNC","state":"Cancelled","merchant":"merchant-1","site":"site-1","merchantTransactionId":"merch-txn-001-void","merchantTransactionDate":"2026-07-10T09:30:00Z","systemTransactionId":"a0132571-d4fc-46c5-9375-8bc354324fbb","originalSystemTransactionId":"6b0320d8-b24e-404c-9048-136d83e033f7","amounts":{"transaction":100,"currencyCode":"USD"},"transactionMethod":{"intent":"Void","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Aeropay","user":{"id":"761a3e91-4062-4fc2-80a4-dc12c8601522","name":"John Doe","email":"john.doe@example.com"},"bank":{"accountId":1895546,"name":"Chase Bank","accountLastFour":"1234","accountType":"Checking"}}}}},"key":"Transaction cancelled (Aeropay)","summary":"Transaction cancelled (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction cancelled (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)":{"value":{"eventDate":"2026-07-13T15:35:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"merchant-1","site":"site-1"},"eventData":{"eventCode":"TXNAP_RFD","state":"Refunded","merchant":"merchant-1","site":"site-1","merchantTransactionId":"merch-txn-001-rfd","merchantTransactionDate":"2026-07-13T15:30:00Z","systemTransactionId":"a0132571-d4fc-46c5-9375-8bc354324fbb","originalSystemTransactionId":"bf015bd2-80c3-49e9-8f37-3e1db108d2bb","amounts":{"transaction":3,"currencyCode":"USD"},"transactionMethod":{"intent":"Refund","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Aeropay","user":{"id":"ffbe50f7-ac6f-4cf6-8629-4e0e6b072f47","name":"John Hien","email":"hien.test003@gmail.com"},"bank":{"accountId":2054460,"name":"Aerosync Bank (oAuth)","accountLastFour":"4561","accountType":"Aerosync Checking"}}},"providerResponse":{"providerTransactionId":"aero-refund-partial-1","providerTransactionStatus":"pending","providerResponseMessage":"Refund transaction created"}}},"key":"Transaction refunded (Aeropay)","summary":"Transaction refunded (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)":{"value":{"eventDate":"2026-07-10T10:00:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"merchant-1","site":"site-1"},"eventData":{"eventCode":"TXNAP_USP","userId":"761a3e91-4062-4fc2-80a4-dc12c8601522"}},"key":"User suspended (Aeropay)","summary":"User suspended (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User suspended (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)":{"value":{"eventDate":"2026-07-10T10:05:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchant":"merchant-1"},"eventData":{"eventCode":"TXNAP_UAC","userId":"761a3e91-4062-4fc2-80a4-dc12c8601522"}},"key":"User activated (Aeropay)","summary":"User activated (Aeropay)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/User activated (Aeropay)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)":{"value":{"eventDate":"2026-08-13T10:00:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-executed","state":"Authorised","stateData":{"code":"APM001","message":"Payment executed"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Authorised","providerResponseCode":"EXECUTED","providerResponseMessage":"Payment executed"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Transaction executed (SPEI purchase)","summary":"Transaction executed (SPEI purchase)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI purchase)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)":{"value":{"eventDate":"2026-08-13T10:05:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-executed","state":"Authorised","stateData":{"code":"APM001","message":"Payment executed"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Authorised","providerResponseCode":"EXECUTED","providerResponseMessage":"Payment executed"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"2fe879cc-f99b-5747-a2bf-78a38ddcc13c"}},"key":"Transaction executed (SPEI payout)","summary":"Transaction executed (SPEI payout)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction executed (SPEI payout)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)":{"value":{"eventDate":"2026-08-13T10:10:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-declined","state":"Aborted","stateData":{"code":"APM004","message":"Payment declined"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Aborted","providerResponseCode":"DECLINED","providerResponseMessage":"Payment declined"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Transaction declined (SPEI purchase)","summary":"Transaction declined (SPEI purchase)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI purchase)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)":{"value":{"eventDate":"2026-08-13T10:15:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-declined","state":"Refused","stateData":{"code":"APM004","message":"Payment declined"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Refused","providerResponseCode":"DECLINED","providerResponseMessage":"Payment declined"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"2fe879cc-f99b-5747-a2bf-78a38ddcc13c"}},"key":"Transaction declined (SPEI payout)","summary":"Transaction declined (SPEI payout)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction declined (SPEI payout)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)":{"value":{"eventDate":"2026-08-13T10:20:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-expired","state":"Expired","stateData":{"code":"APM011","message":"Payment expired"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Expired","providerResponseCode":"EXPIRED","providerResponseMessage":"Payment expired"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Transaction expired (SPEI)","summary":"Transaction expired (SPEI)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction expired (SPEI)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)":{"value":{"eventDate":"2026-08-13T10:25:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-failed","state":"Refused","stateData":{"code":"APM012","message":"Payment failed"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Refused","providerResponseCode":"FAILED","providerResponseMessage":"Payment failed"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Transaction failed (SPEI)","summary":"Transaction failed (SPEI)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction failed (SPEI)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)":{"value":{"eventDate":"2026-08-13T10:30:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-refunded","state":"Refunded","stateData":{"code":"APM007","message":"Payment refunded"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Purchase","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Refunded","providerResponseCode":"REFUNDED","providerResponseMessage":"Payment refunded"},"merchantTransactionId":"<merchant-refund-reference>","systemTransactionId":"1ed768bb-e88a-4636-91ae-67927ccbb02b"}},"key":"Transaction refunded (SPEI)","summary":"Transaction refunded (SPEI)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction refunded (SPEI)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)":{"value":{"eventDate":"2026-08-13T10:35:00.0000000Z","eventCategory":"transaction","eventOwner":{"merchantGroup":"merchant-group-1","merchant":"MERCHANT-1","site":"SITE-1"},"eventData":{"eventCode":"spei-transaction-order-rejected","state":"Rejected","stateData":{"code":"APM013","message":"Payment rejected"},"amounts":{"transaction":100,"currencyCode":"MXN"},"merchant":"MERCHANT-1","site":"SITE-1","transactionMethod":{"intent":"Payout","entryType":"Ecom","fundingType":"PayByBank"},"fundingData":{"payByBank":{"apmProvider":"Spei"}},"providerResponse":{"provider":"Spei","providerTransactionStatus":"Rejected","providerResponseCode":"REJECTED","providerResponseMessage":"Payment rejected"},"merchantTransactionId":"<merchant-transaction-id>","systemTransactionId":"2fe879cc-f99b-5747-a2bf-78a38ddcc13c"}},"key":"Transaction rejected (SPEI payout)","summary":"Transaction rejected (SPEI payout)","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Transaction rejected (SPEI payout)"},"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated":{"value":{"eventDate":"2025-06-27T03:13:22.93Z","eventCategory":"reporting","eventData":{"url":"https://api-gateway-transactions.qa.kube.qa/api/v1/reporting/scheduled-report-executions/d1adbc0d-d931-4775-8613-c44853c5464f/content-download-url"}},"key":"Scheduled report generated","summary":"Scheduled report generated","id":"paths/~1merchant-webhooks/post/requestBody/content/application~1json/examples/Scheduled report generated"}},"securitySchemeStore":{"PXP-UST1":{"id":"PXP-UST1","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PXP-UST1 authentication with HMAC-SHA256 signature. Format: PXP-UST1 {tokenId}:{timestamp}:{hmac}"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/merchant-webhook","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/merchant-webhook.json?download"},{"url":"/_bundle/apis/merchant-webhook.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Merchant webhooks service API","description":"This is an API reference for the merchant webhooks service."}},"baseSlug":"/apis/merchant-webhook","routesMapping":{}}