{"items":[{"type":"link","label":"Events","link":"/products/events/openapi","routeSlug":"/products/events/openapi","content":{"contentType":"overview","meta":{"name":"Events"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/events/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/events/@v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Events (1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive status updates from Access Worldpay by setting up a webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact your Worldpay Implementation Manager to add your webhook URL and enable or disable the events based on your requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook destination (URL) must use an encrypted connection ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and have a certificate signed by a trusted certificate authority. Every certificate within the chain, including the root, must be using a certificate signing algorithm of SHA-256 or better."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for certificate chains involving any certs with the SHA-1 certificate signing algorithm ends March 2026."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"style","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  \n  [class*=\"tag-post\"] {  \n      display: none;\n  }\n"},"children":[]}]}]}],"sectionId":"/products/events/openapi"},{"nodeType":"external-docs","url":"https://developer.worldpay.com/products/events","description":"Developer documentation."}],"sectionId":"/products/events/openapi"}]}]}},{"type":"group","label":"Payment","link":"/products/events/openapi/payment","routeSlug":"/products/events/openapi/payment","items":[{"label":"sentForAuthorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforauthorizationpayment","routeSlug":"/products/events/openapi/payment/sentforauthorizationpayment","metadata":{"seo":{"title":"sentForAuthorization","description":"sentForAuthorization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sentForAuthorizationPayment","name":"sentForAuthorization","isWebhook":true,"pointer":"/paths/sentForAuthorization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sentForAuthorization","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForAuthorizationPayment"}},"schemaId":"components/schemas/sentForAuthorizationPayment","pointer":"/paths/sentForAuthorization/post/requestBody","description":"We've requested permission (from your customer's card issuer) to process your customer's payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"sentForAuthorization","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForAuthorizationPayment"}},"responseCodes":["200"],"pointer":"sentForAuthorization","href":"payment/sentforauthorizationpayment","openApiOperationId":"sentForAuthorizationPayment","summary":"sentForAuthorization"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/sentForAuthorizationPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForAuthorizationPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/sentForAuthorization/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/sentforauthorizationpayment"}],"panels":[]}]},"httpPath":"sentForAuthorization"},{"label":"authorized","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/authorizedpayment","routeSlug":"/products/events/openapi/payment/authorizedpayment","metadata":{"seo":{"title":"authorized","description":"authorized"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorizedPayment","name":"authorized","isWebhook":true,"pointer":"/paths/authorized/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"authorized","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_385"}},"schemaId":"schema_385","pointer":"/paths/authorized/post/requestBody","description":"The payment has been approved and the funds have been reserved in your customer's account."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"authorized","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_385"}},"responseCodes":["200"],"pointer":"authorized","href":"payment/authorizedpayment","openApiOperationId":"authorizedPayment","summary":"authorized"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"schema_385","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_385"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/authorized/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/authorizedpayment"}],"panels":[]}]},"httpPath":"authorized"},{"label":"sentForSettlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforsettlementpayment","routeSlug":"/products/events/openapi/payment/sentforsettlementpayment","metadata":{"seo":{"title":"sentForSettlement","description":"sentForSettlement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sentForSettlementPayment","name":"sentForSettlement","isWebhook":true,"pointer":"/paths/sentForSettlement/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sentForSettlement","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/sentForSettlement/post/requestBody","description":"You or Access Worldpay have requested to remove the reserved funds in your customer's account and transfer them to your Worldpay account."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"sentForSettlement","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_386"}},"responseCodes":["200"],"pointer":"sentForSettlement","href":"payment/sentforsettlementpayment","openApiOperationId":"sentForSettlementPayment","summary":"sentForSettlement"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"schema_386","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/sentForSettlement/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/sentforsettlementpayment"}],"panels":[]}]},"httpPath":"sentForSettlement"},{"label":"settled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settledpayment","routeSlug":"/products/events/openapi/payment/settledpayment","metadata":{"seo":{"title":"settled","description":"settled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settledPayment","name":"settled","isWebhook":true,"pointer":"/paths/settled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"settled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settledPayment"}},"schemaId":"components/schemas/settledPayment","pointer":"/paths/settled/post/requestBody","description":"We have received the funds and are preparing to transfer them to your bank account.\nThis event is only available in certain use cases. Please speak to your Worldpay Implementation Manager for more details.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"settled","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settledPayment"}},"responseCodes":["200"],"pointer":"settled","href":"payment/settledpayment","openApiOperationId":"settledPayment","summary":"settled"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/settledPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settledPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/settled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/settledpayment"}],"panels":[]}]},"httpPath":"settled"},{"label":"settlementFailed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementfailedpayment","routeSlug":"/products/events/openapi/payment/settlementfailedpayment","metadata":{"seo":{"title":"settlementFailed","description":"settlementFailed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settlementFailedPayment","name":"settlementFailed","isWebhook":true,"pointer":"/paths/settlementFailed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"settlementFailed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementFailedPayment"}},"schemaId":"components/schemas/settlementFailedPayment","pointer":"/paths/settlementFailed/post/requestBody","description":"The settlement couldn't be processed and funds have not been transferred to your Worldpay account.\nThis event is only available in certain use cases. Please speak to your Worldpay Implementation Manager for more details.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"settlementFailed","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementFailedPayment"}},"responseCodes":["200"],"pointer":"settlementFailed","href":"payment/settlementfailedpayment","openApiOperationId":"settlementFailedPayment","summary":"settlementFailed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/settlementFailedPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementFailedPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/settlementFailed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/settlementfailedpayment"}],"panels":[]}]},"httpPath":"settlementFailed"},{"label":"cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/cancelledpayment","routeSlug":"/products/events/openapi/payment/cancelledpayment","metadata":{"seo":{"title":"cancelled","description":"cancelled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelledPayment","name":"cancelled","isWebhook":true,"pointer":"/paths/cancelled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"cancelled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledPayment"}},"schemaId":"components/schemas/cancelledPayment","pointer":"/paths/cancelled/post/requestBody","description":"You have stopped the transaction before it has been sent for settlement.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cancelled","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledPayment"}},"responseCodes":["200"],"pointer":"cancelled","href":"payment/cancelledpayment","openApiOperationId":"cancelledPayment","summary":"cancelled"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/cancelledPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/cancelled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/cancelledpayment"}],"panels":[]}]},"httpPath":"cancelled"},{"label":"error","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/errorpayment","routeSlug":"/products/events/openapi/payment/errorpayment","metadata":{"seo":{"title":"error","description":"error"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"errorPayment","name":"error","isWebhook":true,"pointer":"/paths/error/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"error","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/errorPayment"}},"schemaId":"components/schemas/errorPayment","pointer":"/paths/error/post/requestBody","description":"The payment wasn't completed. Your customer may want to reattempt the payment.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"error","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/errorPayment"}},"responseCodes":["200"],"pointer":"error","href":"payment/errorpayment","openApiOperationId":"errorPayment","summary":"error"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/errorPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/errorPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/error/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/errorpayment"}],"panels":[]}]},"httpPath":"error"},{"label":"expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/expiredpayment","routeSlug":"/products/events/openapi/payment/expiredpayment","metadata":{"seo":{"title":"expired","description":"expired"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"expiredPayment","name":"expired","isWebhook":true,"pointer":"/paths/expired/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"expired","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/expiredPayment"}},"schemaId":"components/schemas/expiredPayment","pointer":"/paths/expired/post/requestBody","description":"The authorization period ended before a settlement or cancel request was made.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"expired","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/expiredPayment"}},"responseCodes":["200"],"pointer":"expired","href":"payment/expiredpayment","openApiOperationId":"expiredPayment","summary":"expired"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/expiredPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/expiredPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/expired/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/expiredpayment"}],"panels":[]}]},"httpPath":"expired"},{"label":"refused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refusedpayment","routeSlug":"/products/events/openapi/payment/refusedpayment","metadata":{"seo":{"title":"refused","description":"refused"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refusedPayment","name":"refused","isWebhook":true,"pointer":"/paths/refused/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"refused","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/refused/post/requestBody","description":"Your payment request has been declined by a third party.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"refused","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_387"}},"responseCodes":["200"],"pointer":"refused","href":"payment/refusedpayment","openApiOperationId":"refusedPayment","summary":"refused"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"schema_387","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/refused/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/refusedpayment"}],"panels":[]}]},"httpPath":"refused"},{"label":"sentForRefund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforrefundpayment","routeSlug":"/products/events/openapi/payment/sentforrefundpayment","metadata":{"seo":{"title":"sentForRefund","description":"sentForRefund"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sentForRefundPayment","name":"sentForRefund","isWebhook":true,"pointer":"/paths/sentForRefund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sentForRefund","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForRefundPayment"}},"schemaId":"components/schemas/sentForRefundPayment","pointer":"/paths/sentForRefund/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You've requested funds to be sent back to your customer's account. If online authorization was required, this will also contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund.onlineRefundAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts through basic disbursement triggers this event."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"sentForRefund","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForRefundPayment"}},"responseCodes":["200"],"pointer":"sentForRefund","href":"payment/sentforrefundpayment","openApiOperationId":"sentForRefundPayment","summary":"sentForRefund"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/sentForRefundPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/sentForRefundPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/sentForRefund/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/sentforrefundpayment"}],"panels":[]}]},"httpPath":"sentForRefund"},{"label":"refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refundedpayment","routeSlug":"/products/events/openapi/payment/refundedpayment","metadata":{"seo":{"title":"refunded","description":"refunded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refundedPayment","name":"refunded","isWebhook":true,"pointer":"/paths/refunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"refunded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundedPayment"}},"schemaId":"components/schemas/refundedPayment","pointer":"/paths/refunded/post/requestBody","description":"The card issuer has received the refund request and they will return the funds to your customer's account. This event is only available in certain use cases. Please speak to your Worldpay Implementation Manager for more details.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"refunded","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundedPayment"}},"responseCodes":["200"],"pointer":"refunded","href":"payment/refundedpayment","openApiOperationId":"refundedPayment","summary":"refunded"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/refundedPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundedPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/refunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/refundedpayment"}],"panels":[]}]},"httpPath":"refunded"},{"label":"refundFailed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refundfailedpayment","routeSlug":"/products/events/openapi/payment/refundfailedpayment","metadata":{"seo":{"title":"refundFailed","description":"refundFailed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refundFailedPayment","name":"refundFailed","isWebhook":true,"pointer":"/paths/refundFailed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"refundFailed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundFailedPayment"}},"schemaId":"components/schemas/refundFailedPayment","pointer":"/paths/refundFailed/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund couldn't be processed and the funds were returned to your account. If online authorization was required, this will also contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund.refusal.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund.refusal.description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"refundFailed","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundFailedPayment"}},"responseCodes":["200"],"pointer":"refundFailed","href":"payment/refundfailedpayment","openApiOperationId":"refundFailedPayment","summary":"refundFailed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/refundFailedPayment","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refundFailedPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/refundFailed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/refundfailedpayment"}],"panels":[]}]},"httpPath":"refundFailed"},{"label":"tokenCreated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/tokencreated","routeSlug":"/products/events/openapi/payment/tokencreated","metadata":{"seo":{"title":"tokenCreated","description":"tokenCreated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokenCreated","name":"tokenCreated","isWebhook":true,"pointer":"/paths/tokenCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"tokenCreated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_388"}},"schemaId":"schema_388","pointer":"/paths/tokenCreated/post/requestBody","description":"You have successfully created an APM token. For further information on the fields returned see our table.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"tokenCreated","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_388"}},"responseCodes":["200"],"pointer":"tokenCreated","href":"payment/tokencreated","openApiOperationId":"tokenCreated","summary":"tokenCreated"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"schema_388","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"schema_388"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/tokenCreated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/tokencreated"}],"panels":[]}]},"httpPath":"tokenCreated"},{"label":"settlementInstructed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementinstructedpayment","routeSlug":"/products/events/openapi/payment/settlementinstructedpayment","metadata":{"seo":{"title":"settlementInstructed","description":"settlementInstructed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settlementInstructedPayment","name":"settlementInstructed","isWebhook":true,"pointer":"/paths/settlementInstructed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"settlementInstructed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementInstructed"}},"schemaId":"components/schemas/settlementInstructed","pointer":"/paths/settlementInstructed/post/requestBody","description":"We've received instruction about your settlement. This event applies only to Pix APM payments.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"settlementInstructed","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementInstructed"}},"responseCodes":["200"],"pointer":"settlementInstructed","href":"payment/settlementinstructedpayment","openApiOperationId":"settlementInstructedPayment","summary":"settlementInstructed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/settlementInstructed","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementInstructed"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/settlementInstructed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/settlementinstructedpayment"}],"panels":[]}]},"httpPath":"settlementInstructed"},{"label":"settlementRejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementrejectedpayment","routeSlug":"/products/events/openapi/payment/settlementrejectedpayment","metadata":{"seo":{"title":"settlementRejected","description":"settlementRejected"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settlementRejectedPayment","name":"settlementRejected","isWebhook":true,"pointer":"/paths/settlementRejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"settlementRejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementRejected"}},"schemaId":"components/schemas/settlementRejected","pointer":"/paths/settlementRejected/post/requestBody","description":"We've received instruction about your settlement failure. This event applies only to Pix APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"settlementRejected","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementRejected"}},"responseCodes":["200"],"pointer":"settlementRejected","href":"payment/settlementrejectedpayment","openApiOperationId":"settlementRejectedPayment","summary":"settlementRejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/settlementRejected","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/settlementRejected"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/settlementRejected/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/settlementrejectedpayment"}],"panels":[]}]},"httpPath":"settlementRejected"},{"label":"topUpAccepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/topupacceptedpayment","routeSlug":"/products/events/openapi/payment/topupacceptedpayment","metadata":{"seo":{"title":"topUpAccepted","description":"topUpAccepted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"topUpAcceptedPayment","name":"topUpAccepted","isWebhook":true,"pointer":"/paths/topUpAccepted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"topUpAccepted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpAccepted"}},"schemaId":"components/schemas/topUpAccepted","pointer":"/paths/topUpAccepted/post/requestBody","description":"We've received instruction about your top-up request. This event applies only to Pix APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"topUpAccepted","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpAccepted"}},"responseCodes":["200"],"pointer":"topUpAccepted","href":"payment/topupacceptedpayment","openApiOperationId":"topUpAcceptedPayment","summary":"topUpAccepted"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/topUpAccepted","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpAccepted"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/topUpAccepted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/topupacceptedpayment"}],"panels":[]}]},"httpPath":"topUpAccepted"},{"label":"topUpRejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/topuprejectedpayment","routeSlug":"/products/events/openapi/payment/topuprejectedpayment","metadata":{"seo":{"title":"topUpRejected","description":"topUpRejected"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"topUpRejectedPayment","name":"topUpRejected","isWebhook":true,"pointer":"/paths/topUpRejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"topUpRejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpRejected"}},"schemaId":"components/schemas/topUpRejected","pointer":"/paths/topUpRejected/post/requestBody","description":"We've received instruction about your top-up failure. This event applies only to Pix APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"topUpRejected","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpRejected"}},"responseCodes":["200"],"pointer":"topUpRejected","href":"payment/topuprejectedpayment","openApiOperationId":"topUpRejectedPayment","summary":"topUpRejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/topUpRejected","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/topUpRejected"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/topUpRejected/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/topuprejectedpayment"}],"panels":[]}]},"httpPath":"topUpRejected"},{"label":"chargedBack","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/chargedbackpayment","routeSlug":"/products/events/openapi/payment/chargedbackpayment","metadata":{"seo":{"title":"chargedBack","description":"chargedBack"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chargedBackPayment","name":"chargedBack","isWebhook":true,"pointer":"/paths/chargedBack/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"chargedBack","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/chargedBack"}},"schemaId":"components/schemas/chargedBack","pointer":"/paths/chargedBack/post/requestBody","description":"We've received instruction about your charged back request. This event applies only to Klarna APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"chargedBack","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/chargedBack"}},"responseCodes":["200"],"pointer":"chargedBack","href":"payment/chargedbackpayment","openApiOperationId":"chargedBackPayment","summary":"chargedBack"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/chargedBack","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/chargedBack"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/chargedBack/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/chargedbackpayment"}],"panels":[]}]},"httpPath":"chargedBack"},{"label":"cancelledByCustomer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/cancelledbycustomerpayment","routeSlug":"/products/events/openapi/payment/cancelledbycustomerpayment","metadata":{"seo":{"title":"cancelledByCustomer","description":"cancelledByCustomer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelledByCustomerPayment","name":"cancelledByCustomer","isWebhook":true,"pointer":"/paths/cancelledByCustomer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"cancelledByCustomer","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledByCustomer"}},"schemaId":"components/schemas/cancelledByCustomer","pointer":"/paths/cancelledByCustomer/post/requestBody","description":"We've received instruction about customer's payment cancellation. This event applies only to Klarna APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cancelledByCustomer","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledByCustomer"}},"responseCodes":["200"],"pointer":"cancelledByCustomer","href":"payment/cancelledbycustomerpayment","openApiOperationId":"cancelledByCustomerPayment","summary":"cancelledByCustomer"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/cancelledByCustomer","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/cancelledByCustomer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/cancelledByCustomer/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/cancelledbycustomerpayment"}],"panels":[]}]},"httpPath":"cancelledByCustomer"},{"label":"requestExpired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/requestexpiredpayment","routeSlug":"/products/events/openapi/payment/requestexpiredpayment","metadata":{"seo":{"title":"requestExpired","description":"requestExpired"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestExpiredPayment","name":"requestExpired","isWebhook":true,"pointer":"/paths/requestExpired/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"requestExpired","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestExpired"}},"schemaId":"components/schemas/requestExpired","pointer":"/paths/requestExpired/post/requestBody","description":"Your request for payment has expired due to customer inactivity. This event applies only to APM payments."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"requestExpired","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestExpired"}},"responseCodes":["200"],"pointer":"requestExpired","href":"payment/requestexpiredpayment","openApiOperationId":"requestExpiredPayment","summary":"requestExpired"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/requestExpired","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestExpired"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/requestExpired/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/requestexpiredpayment"}],"panels":[]}]},"httpPath":"requestExpired"}],"content":{"contentType":"group","meta":{"name":"Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","showPageActions":true},{"nodeType":"markdoc","content":"Receive payment events/webhooks to a URL defined by you."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"sentForAuthorization","summary":"sentForAuthorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/sentforauthorizationpayment","deprecated":false},{"title":"authorized","summary":"authorized","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/authorizedpayment","deprecated":false},{"title":"sentForSettlement","summary":"sentForSettlement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/sentforsettlementpayment","deprecated":false},{"title":"settled","summary":"settled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/settledpayment","deprecated":false},{"title":"settlementFailed","summary":"settlementFailed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/settlementfailedpayment","deprecated":false},{"title":"cancelled","summary":"cancelled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/cancelledpayment","deprecated":false},{"title":"error","summary":"error","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/errorpayment","deprecated":false},{"title":"expired","summary":"expired","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/expiredpayment","deprecated":false},{"title":"refused","summary":"refused","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/refusedpayment","deprecated":false},{"title":"sentForRefund","summary":"sentForRefund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/sentforrefundpayment","deprecated":false},{"title":"refunded","summary":"refunded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/refundedpayment","deprecated":false},{"title":"refundFailed","summary":"refundFailed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/refundfailedpayment","deprecated":false},{"title":"tokenCreated","summary":"tokenCreated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/tokencreated","deprecated":false},{"title":"settlementInstructed","summary":"settlementInstructed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/settlementinstructedpayment","deprecated":false},{"title":"settlementRejected","summary":"settlementRejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/settlementrejectedpayment","deprecated":false},{"title":"topUpAccepted","summary":"topUpAccepted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/topupacceptedpayment","deprecated":false},{"title":"topUpRejected","summary":"topUpRejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/topuprejectedpayment","deprecated":false},{"title":"chargedBack","summary":"chargedBack","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/chargedbackpayment","deprecated":false},{"title":"cancelledByCustomer","summary":"cancelledByCustomer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/cancelledbycustomerpayment","deprecated":false},{"title":"requestExpired","summary":"requestExpired","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/requestexpiredpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Payout","link":"/products/events/openapi/payout","routeSlug":"/products/events/openapi/payout","items":[{"label":"disbursed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/disbursedpayout","routeSlug":"/products/events/openapi/payout/disbursedpayout","metadata":{"seo":{"title":"disbursed","description":"disbursed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disbursedPayout","name":"disbursed","isWebhook":true,"pointer":"/paths/disbursed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"disbursed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/disbursedPayout"}},"schemaId":"components/schemas/disbursedPayout","pointer":"/paths/disbursed/post/requestBody","description":"Your Fast Access disbursement request has been disbursed.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"disbursed","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/disbursedPayout"}},"responseCodes":["200"],"pointer":"disbursed","href":"payout/disbursedpayout","openApiOperationId":"disbursedPayout","summary":"disbursed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/disbursedPayout","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/disbursedPayout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/disbursed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout/disbursedpayout"}],"panels":[]}]},"httpPath":"disbursed"},{"label":"pending","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/pendingpayout","routeSlug":"/products/events/openapi/payout/pendingpayout","metadata":{"seo":{"title":"pending","description":"pending"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pendingPayout","name":"pending","isWebhook":true,"pointer":"/paths/pending/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"pending","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/pendingPayout"}},"schemaId":"components/schemas/pendingPayout","pointer":"/paths/pending/post/requestBody","description":"Your Fast Access disbursement request has been sent to Visa Direct, and a response is pending. Pending requests usually update to approved or refused within 45 minutes. If no response is received within 48 hours, an error is returned.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"pending","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/pendingPayout"}},"responseCodes":["200"],"pointer":"pending","href":"payout/pendingpayout","openApiOperationId":"pendingPayout","summary":"pending"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/pendingPayout","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/pendingPayout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/pending/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout/pendingpayout"}],"panels":[]}]},"httpPath":"pending"},{"label":"refused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/refusedpayout","routeSlug":"/products/events/openapi/payout/refusedpayout","metadata":{"seo":{"title":"refused","description":"refused"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refusedPayout","name":"refused","isWebhook":true,"pointer":"/paths/refusedPayout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"refused","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refusedPayout"}},"schemaId":"components/schemas/refusedPayout","pointer":"/paths/refusedPayout/post/requestBody","description":"Your Fast Access disbursement request was refused.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"refusedPayout","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refusedPayout"}},"responseCodes":["200"],"pointer":"refusedPayout","href":"payout/refusedpayout","openApiOperationId":"refusedPayout","summary":"refused"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/refusedPayout","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/refusedPayout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/refusedPayout/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout/refusedpayout"}],"panels":[]}]},"httpPath":"refusedPayout"},{"label":"requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/requestedpayout","routeSlug":"/products/events/openapi/payout/requestedpayout","metadata":{"seo":{"title":"requested","description":"requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestedPayout","name":"requested","isWebhook":true,"pointer":"/paths/requestedPayout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"requested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestedPayout"}},"schemaId":"components/schemas/requestedPayout","pointer":"/paths/requestedPayout/post/requestBody","description":"Access Payouts has received your Fast Access disbursement request.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"requestedPayout","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestedPayout"}},"responseCodes":["200"],"pointer":"requestedPayout","href":"payout/requestedpayout","openApiOperationId":"requestedPayout","summary":"requested"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/requestedPayout","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/requestedPayout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/requestedPayout/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout/requestedpayout"}],"panels":[]}]},"httpPath":"requestedPayout"},{"label":"approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/approvedpayout","routeSlug":"/products/events/openapi/payout/approvedpayout","metadata":{"seo":{"title":"approved","description":"approved"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"approvedPayout","name":"approved","isWebhook":true,"pointer":"/paths/approvedPayout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"approved","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/approvedPayout"}},"schemaId":"components/schemas/approvedPayout","pointer":"/paths/approvedPayout/post/requestBody","description":"Visa Direct has approved your Fast Access disbursement request. Your customer should receive the funds within 30 minutes if their issuer is Fast Access enabled, or 3-5 working days if they are not.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"approvedPayout","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/approvedPayout"}},"responseCodes":["200"],"pointer":"approvedPayout","href":"payout/approvedpayout","openApiOperationId":"approvedPayout","summary":"approved"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/approvedPayout","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/approvedPayout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/approvedPayout/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout/approvedpayout"}],"panels":[]}]},"httpPath":"approvedPayout"}],"content":{"contentType":"group","meta":{"name":"Payout"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card payout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events/webhooks to a URL defined by you."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events please see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/account-payouts/account-events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Payouts event webhook guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"disbursed","summary":"disbursed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/disbursedpayout","deprecated":false},{"title":"pending","summary":"pending","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/pendingpayout","deprecated":false},{"title":"refusedPayout","summary":"refused","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/refusedpayout","deprecated":false},{"title":"requestedPayout","summary":"requested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/requestedpayout","deprecated":false},{"title":"approvedPayout","summary":"approved","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout/approvedpayout","deprecated":false}]}]}]}]}},{"type":"group","label":"Chargeback","link":"/products/events/openapi/chargeback","routeSlug":"/products/events/openapi/chargeback","items":[{"label":"informationRequested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/chargeback/informationrequestedchargeback","routeSlug":"/products/events/openapi/chargeback/informationrequestedchargeback","metadata":{"seo":{"title":"informationRequested","description":"informationRequested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"informationRequestedChargeback","name":"informationRequested","isWebhook":true,"pointer":"/paths/informationRequested/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"informationRequested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/informationRequestedChargeback"}},"schemaId":"components/schemas/informationRequestedChargeback","pointer":"/paths/informationRequested/post/requestBody","description":"Your customer has disputed this payment with their card issuer. The card issuer has requested information about the payment and the disputed funds have been held until the outcome of the dispute. This event is only available in certain use cases. Please speak to your Worldpay Implementation Manager for more details.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"informationRequested","servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/informationRequestedChargeback"}},"responseCodes":["200"],"pointer":"informationRequested","href":"chargeback/informationrequestedchargeback","openApiOperationId":"informationRequestedChargeback","summary":"informationRequested"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"schemaId":"components/schemas/informationRequestedChargeback","mediaTypes":["application/vnd.worldpay.events-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.events-v1.hal+json":{"schemaId":"components/schemas/informationRequestedChargeback"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/informationRequested/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chargeback/informationrequestedchargeback"}],"panels":[]}]},"httpPath":"informationRequested"}],"content":{"contentType":"group","meta":{"name":"Chargeback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chargeback","showPageActions":true},{"nodeType":"markdoc","content":"Receive chargeback events/webhooks to a URL defined by you."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"informationRequested","summary":"informationRequested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chargeback/informationrequestedchargeback","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/eventId":{"id":"components/schemas/eventId","kind":"json-schema","title":"eventId","data":{"type":"string","description":"The unique identifier for the event.","example":"bb55ca5a-e05c-47e1-8e94-e88bac1a0a17"}},"components/schemas/eventTimestamp":{"id":"components/schemas/eventTimestamp","kind":"json-schema","title":"eventTimestamp","data":{"type":"string","description":"Date of event.","example":"2018-06-13T14:18:13.407"}},"components/schemas/amount":{"id":"components/schemas/amount","kind":"json-schema","title":"amount","data":{"type":"object","properties":{"value":{"type":"integer","format":"int32","description":"The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.","example":100},"currencyCode":{"type":"string","description":"The currency code.","example":"EUR"}}}},"components/schemas/riskFactors":{"id":"components/schemas/riskFactors","kind":"json-schema","title":"riskFactors","data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["cvc","avs","nameInquiry"],"example":"avs"},"risk":{"type":"string","enum":["notChecked","notMatched","notSupplied","partialMatched","notSupported"],"example":"notMatched"},"detail":{"type":"string","enum":["postcode","address","firstName","middleName","lastName"],"example":"postcode"}}}}},"components/schemas/downstreamReference":{"id":"components/schemas/downstreamReference","kind":"json-schema","title":"downstreamReference","data":{"type":"string","description":"A reference you can use for reconciliation purposes.","example":"3378792436"}},"components/schemas/orderReference":{"id":"components/schemas/orderReference","kind":"json-schema","title":"orderReference","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference, generated by you, that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:"},"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":"the total amount for a single order is split across multiple payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you use a single reference for each payment in a recurring agreement or split shipment scenario"},"children":[]}]}]}]}],"example":"my-order-ref"}},"components/schemas/transactionReference":{"id":"components/schemas/transactionReference","kind":"json-schema","title":"transactionReference","data":{"type":"string","description":"The transaction reference you supplied in the payment.","example":"Memory265-13/08/1876"}},"components/schemas/paymentId":{"id":"components/schemas/paymentId","kind":"json-schema","title":"paymentId","data":{"type":"string","description":"Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.","example":"payI-dUcet9fk4_X4qZU0hpU0"}},"components/schemas/commandId":{"id":"components/schemas/commandId","kind":"json-schema","title":"commandId","data":{"type":"string","description":"Unique identifier generated by us for a single instance of an interaction (command) with our API.","example":"cmd-Rjc4HJwnBdj3Ri9v10vT0"}},"components/schemas/date":{"id":"components/schemas/date","kind":"json-schema","title":"date","data":{"type":"string","format":"date","description":"The date you first submitted the payment.","example":"2017-11-03"}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"merchant","data":{"type":"object","description":"Merchant data.","properties":{"entity":{"type":"string","description":"A merchant entity reference.","example":"default"}}}},"components/schemas/issuer":{"id":"components/schemas/issuer","kind":"json-schema","title":"issuer","data":{"type":"object","description":"Issuer data.","properties":{"authorizationCode":{"type":"string","description":"An issuer authorization code.","example":"T75725"}}}},"components/schemas/scheme":{"id":"components/schemas/scheme","kind":"json-schema","title":"scheme","data":{"type":"object","description":"Scheme related data.","properties":{"reference":{"type":"string","description":"Scheme provided reference.","example":"MCCOLXT1C0104  "}}}},"components/schemas/updatedPaymentInstrument":{"id":"components/schemas/updatedPaymentInstrument","kind":"json-schema","title":"updatedPaymentInstrument","data":{"type":"object","description":"Payment instrument update, if any.","properties":{"appliedNetworkToken":{"type":"boolean","description":"Network token used.","example":true}}}},"components/schemas/paymentInstrument":{"id":"components/schemas/paymentInstrument","kind":"json-schema","title":"paymentInstrument","data":{"type":"object","description":"Payment instrument information.","properties":{"cardBin":{"type":"string","description":"The bank identification number that appears on the payment card.","example":"555555"},"lastFour":{"type":"string","description":"The last 4 digits from the card number.","example":"5555"},"category":{"type":"string","description":"The card category.","example":"consumer"},"countryCode":{"type":"string","description":"The alpha-2 ISO-3166 country code of the card.","example":"GB"},"expiryDate":{"type":"object","description":"The expiry date of the card.","properties":{"month":{"type":"string","description":"The expiry month of the card.","example":"9"},"year":{"type":"string","description":"The expiry year of the card.","example":"2029"}}},"cardBrand":{"type":"string","description":"The card scheme, e.g. visa or mastercard.","example":"visa"},"fundingType":{"type":"string","description":"Card funding type.","example":"credit"},"issuerName":{"type":"string","description":"Card issuer name.","example":"An Irish Bank"},"paymentAccountReference":{"type":"string","description":"The unique reference associated with the card PAN.","example":"321ABC"}}}},"components/schemas/reference":{"id":"components/schemas/reference","kind":"json-schema","title":"reference","data":{"type":"string","description":"A unique reference provided by you during payment actions.","example":"ABC123"}},"components/schemas/octReference":{"id":"components/schemas/octReference","kind":"json-schema","title":"octReference","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Transaction ID for single-message OCTs, to be used for reconciliation and reporting. Can be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForRefund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment events."},"children":[]}]}]}],"example":"12345"}},"components/schemas/refund":{"id":"components/schemas/refund","kind":"json-schema","title":"refund","data":{"type":"object","properties":{"onlineRefundAuthorization":{"type":"string","description":"Authorization code from the issuer for online refunds. Additional information returned as part of a Visa and Mastercard mandate to ensure that all purchase returns are submitted for online authorization. \n","example":"987654"}}}},"components/schemas/refundRefusal":{"id":"components/schemas/refundRefusal","kind":"json-schema","title":"refundRefusal","data":{"type":"object","properties":{"refusal":{"type":"object","properties":{"code":{"type":"string","description":"Refusal code for online refund authorization.","example":"5"},"description":{"type":"string","description":"Refusal description for online refund authorization.","example":"Do not honor"}}}}}},"components/schemas/_links":{"id":"components/schemas/_links","kind":"json-schema","title":"_links","data":{"type":"object","description":"Unused currently.","properties":{"payment":{"type":"object","properties":{"href":{"type":"string","example":""}}}}}},"components/schemas/sentForAuthorizationPayment":{"id":"components/schemas/sentForAuthorizationPayment","kind":"json-schema","title":"sentForAuthorizationPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForAuthorization"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedPayment":{"id":"components/schemas/authorizedPayment","kind":"json-schema","title":"authorizedPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"riskFactors":{"$ref":"#/components/schemas/riskFactors"},"issuer":{"$ref":"#/components/schemas/issuer"},"scheme":{"$ref":"#/components/schemas/scheme"},"updatedPaymentInstrument":{"$ref":"#/components/schemas/updatedPaymentInstrument"},"paymentInstrument":{"$ref":"#/components/schemas/paymentInstrument"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedAPMPayment":{"id":"components/schemas/authorizedAPMPayment","kind":"json-schema","title":"authorizedAPMPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedPaymentKlarna":{"id":"components/schemas/authorizedPaymentKlarna","kind":"json-schema","title":"authorizedPaymentKlarna","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"countryCode":{"type":"string","example":"GB"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedPaymentMyBank":{"id":"components/schemas/authorizedPaymentMyBank","kind":"json-schema","title":"authorizedPaymentMyBank","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"MyBank"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"},"countryCode":{"type":"string","example":"GB"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedPaymentIdeal":{"id":"components/schemas/authorizedPaymentIdeal","kind":"json-schema","title":"authorizedPaymentIdeal","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"ideal"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountNumber":{"type":"string","example":"123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/authorizedPaymentOpenBanking":{"id":"components/schemas/authorizedPaymentOpenBanking","kind":"json-schema","title":"authorizedPaymentOpenBanking","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"authorized"},"date":{"$ref":"#/components/schemas/date"},"merchant":{"$ref":"#/components/schemas/merchant"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"open_banking"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"},"countryCode":{"type":"string","example":"GB"},"accountNumber":{"type":"string","example":"04914552"},"bankCode":{"type":"string","example":"040004"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPayment":{"id":"components/schemas/sentForSettlementPayment","kind":"json-schema","title":"sentForSettlementPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPaymentPix":{"id":"components/schemas/sentForSettlementPaymentPix","kind":"json-schema","title":"sentForSettlementPaymentPix","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"providerReference":{"type":"string","description":"A reference generated by Celcoin allowing you to trace the payment throughout its lifecycle.","example":"E9040088820250731140043506446963"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPaymentKlarna":{"id":"components/schemas/sentForSettlementPaymentKlarna","kind":"json-schema","title":"sentForSettlementPaymentKlarna","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"countryCode":{"type":"string","example":"GB"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPaymentMyBank":{"id":"components/schemas/sentForSettlementPaymentMyBank","kind":"json-schema","title":"sentForSettlementPaymentMyBank","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"MyBank"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"},"countryCode":{"type":"string","example":"GB"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPaymentIdeal":{"id":"components/schemas/sentForSettlementPaymentIdeal","kind":"json-schema","title":"sentForSettlementPaymentIdeal","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"ideal"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountNumber":{"type":"string","example":"123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForSettlementPaymentOpenBanking":{"id":"components/schemas/sentForSettlementPaymentOpenBanking","kind":"json-schema","title":"sentForSettlementPaymentOpenBanking","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForSettlement"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"open_banking"},"iban":{"type":"string","example":"NL03RABO0123456789"},"accountHolderName":{"type":"string","example":"A Shopper"},"swiftBic":{"type":"string","example":"RABONL2U"},"countryCode":{"type":"string","example":"GB"},"accountNumber":{"type":"string","example":"04914552"},"bankCode":{"type":"string","example":"040004"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/settledPayment":{"id":"components/schemas/settledPayment","kind":"json-schema","title":"settledPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"settled"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/settlementFailedPayment":{"id":"components/schemas/settlementFailedPayment","kind":"json-schema","title":"settlementFailedPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"settlementFailed"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/cancelledPayment":{"id":"components/schemas/cancelledPayment","kind":"json-schema","title":"cancelledPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"cancelled"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/errorPayment":{"id":"components/schemas/errorPayment","kind":"json-schema","title":"errorPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"error"},"date":{"$ref":"#/components/schemas/date"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/expiredPayment":{"id":"components/schemas/expiredPayment","kind":"json-schema","title":"expiredPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"expired"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/refusedPayment":{"id":"components/schemas/refusedPayment","kind":"json-schema","title":"refusedPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"refused"},"riskFactors":{"$ref":"#/components/schemas/riskFactors"},"issuer":{"$ref":"#/components/schemas/issuer"},"scheme":{"$ref":"#/components/schemas/scheme"},"updatedPaymentInstrument":{"$ref":"#/components/schemas/updatedPaymentInstrument"},"paymentInstrument":{"$ref":"#/components/schemas/paymentInstrument"},"date":{"$ref":"#/components/schemas/date"},"octReference":{"$ref":"#/components/schemas/octReference"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/refusedAPMPayment":{"id":"components/schemas/refusedAPMPayment","kind":"json-schema","title":"refusedAPMPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"refused"},"date":{"$ref":"#/components/schemas/date"},"octReference":{"$ref":"#/components/schemas/octReference"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/sentForRefundPayment":{"id":"components/schemas/sentForRefundPayment","kind":"json-schema","title":"sentForRefundPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sentForRefund"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"refund":{"$ref":"#/components/schemas/refund"},"octReference":{"$ref":"#/components/schemas/octReference"},"fastRefund":{"type":"string","description":"Indicates the fast refund attempt.","example":"attempted"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/refundedPayment":{"id":"components/schemas/refundedPayment","kind":"json-schema","title":"refundedPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"refunded"},"date":{"$ref":"#/components/schemas/date"},"refund":{"$ref":"#/components/schemas/refund"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/refundFailedPayment":{"id":"components/schemas/refundFailedPayment","kind":"json-schema","title":"refundFailedPayment","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"downstreamReference":{"$ref":"#/components/schemas/downstreamReference"},"orderReference":{"$ref":"#/components/schemas/orderReference"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"paymentId":{"$ref":"#/components/schemas/paymentId"},"commandId":{"$ref":"#/components/schemas/commandId"},"merchant":{"$ref":"#/components/schemas/merchant"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"refundFailed"},"date":{"$ref":"#/components/schemas/date"},"reference":{"$ref":"#/components/schemas/reference"},"refund":{"$ref":"#/components/schemas/refundRefusal"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/tokenCreatedCard":{"id":"components/schemas/tokenCreatedCard","kind":"json-schema","title":"tokenCreatedCard","data":{"properties":{"eventType":{"type":"string","description":"The event Type of generated event.","example":"tokenCreated"},"notificationId":{"type":"string","description":"The unique identifier for the event notification.","example":"27e63cba-1f98-44d3-946d-afb6aca3d5e5"},"createdAt":{"type":"string","format":"date-time","example":"2024-05-07T18:20:12.111Z"},"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"tokenCreatedAt":{"type":"string","format":"date-time","example":"2024-04-23T18:51:28Z"},"tokenPaymentInstrument":{"type":"object","properties":{"type":{"type":"string","example":"card/tokenized"},"href":{"type":"string","example":"https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoibHdJNmQxN01QQ096Rm9QZzhBMS9TK3lqV21QdjBEUk9ORkRqMnRMeTMvUT0ifQ"}}},"tokenExpiryDateTime":{"type":"string","format":"date-time","example":"2024-04-30T18:51:27Z"},"description":{"type":"string","example":"Created token without payment on 2024-04-23"},"tokenId":{"type":"string","example":"9981080858023992994"},"paymentInstrument":{"type":"object","properties":{"type":{"type":"string","example":"card/masked"},"cardNumber":{"type":"string","example":"4622********0875"},"cardHolderName":{"type":"string","example":"Sherlock Holmes"},"cardExpiryDate":{"type":"object","properties":{"month":{"type":"string","example":"1"},"year":{"type":"string","example":"2025"}}},"bin":{"type":"string","example":"462294"},"brand":{"type":"string","example":"VISA"},"fundingType":{"type":"string","example":"credit"},"countryCode":{"type":"string","example":"GB"},"billingAddress":{"type":"object","properties":{"address1":{"type":"string","example":"221B Baker Street"},"address2":{"type":"string","example":"Marylebone"},"address3":{"type":"string","example":"Westminster"},"postalCode":{"type":"string","example":"NW1 6XE"},"city":{"type":"string","example":"London"},"state":{"type":"string","example":"Greater London"},"countryCode":{"type":"string","example":"GB"}}}}}}}}}},"components/schemas/tokenCreatedKlarna":{"id":"components/schemas/tokenCreatedKlarna","kind":"json-schema","title":"tokenCreatedKlarna","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"tokenCreatedAt":{"type":"string","format":"date-time","example":"2024-04-23T18:51:28Z"},"tokenPaymentInstrument":{"type":"object","properties":{"type":{"type":"string","example":"token"},"tokenId":{"type":"string","example":"9981080858023992994"}}},"tokenExpiryDateTime":{"type":"string","format":"date-time","example":"2024-04-30T18:51:27Z"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"},"countryCode":{"type":"string","example":"GB"},"billingAddress":{"type":"object","properties":{"address1":{"type":"string","example":"221B Baker Street"},"address2":{"type":"string","example":"Marylebone"},"address3":{"type":"string","example":"Westminster"}}}}},"productType":{"type":"string","enum":["payLater"],"example":"payLater"}}}}}},"components/schemas/tokenCreatedIdeal":{"id":"components/schemas/tokenCreatedIdeal","kind":"json-schema","title":"tokenCreatedIdeal","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"tokenCreatedAt":{"type":"string","format":"date-time","example":"2024-04-23T18:51:28Z"},"tokenPaymentInstrument":{"type":"object","properties":{"type":{"type":"string","example":"token"},"tokenId":{"type":"string","example":"9981080858023992994"}}},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"ideal"},"mandateId":{"type":"string","example":"M-100550741-20240619082311781"},"mandateSignatureDate":{"type":"string","example":"2024-06-19"},"email":{"type":"string","example":"moriarty@example.com"}}},"productType":{"type":"string","enum":["directDebit"],"example":"directDebit"}}}}}},"components/schemas/tokenCreatedSepa":{"id":"components/schemas/tokenCreatedSepa","kind":"json-schema","title":"tokenCreatedSepa","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"tokenCreatedAt":{"type":"string","format":"date-time","example":"2024-04-23T18:51:28Z"},"tokenPaymentInstrument":{"type":"object","properties":{"type":{"type":"string","example":"token"},"tokenId":{"type":"string","example":"9981080858023992994"}}},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"sepa"},"mandateId":{"type":"string","example":"M-100550741-20240619082311781"},"mandateSignatureDate":{"type":"string","example":"2024-06-19"},"iban":{"type":"string","example":"NL78RABO0133187896"},"accountHolderName":{"type":"string","example":"James Moriarty"},"email":{"type":"string","example":"moriarty@example.com"}}},"productType":{"type":"string","enum":["directDebit"],"example":"directDebit"}}}}}},"components/schemas/settlementInstructed":{"id":"components/schemas/settlementInstructed","kind":"json-schema","title":"settlementInstructed","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"providerReference":{"type":"string","description":"A reference generated by Celcoin allowing you to trace the payment throughout its lifecycle.","example":"E9040088820250731140043506446963"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"settlementInstructed"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"pix"},"bankCode":{"type":"string","example":"13935893"},"branchCode":{"type":"string","example":"0001"},"accountName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"30054759318"},"accountType":{"type":"string","example":"TRAN","description":"Type of account. Some examples 'Current Account(CACC)', 'Salary Account(SLRY)', 'Savings Account(SVGS)', 'Payment Account (TRAN)'."},"documentNumber":{"type":"string","example":"43394559000156","description":"Represents the Payer's Tax ID (CPF or CNPJ Number) in Brazil."},"bookingDate":{"type":"string","example":"2025-05-02"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/settlementRejected":{"id":"components/schemas/settlementRejected","kind":"json-schema","title":"settlementRejected","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"settlementRejected"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"pix"},"bankCode":{"type":"string","example":"13935893"},"branchCode":{"type":"string","example":"0001"},"accountName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"30054759318"},"accountType":{"type":"string","example":"TRAN","description":"Type of account. Some examples 'Current Account(CACC)', 'Salary Account(SLRY)', 'Savings Account(SVGS)', 'Payment Account (TRAN)'."},"documentNumber":{"type":"string","example":"43394559000156","description":"Represents the Payer's Tax ID (CPF or CNPJ Number) in Brazil."},"bookingDate":{"type":"string","example":"2025-05-02"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/topUpAccepted":{"id":"components/schemas/topUpAccepted","kind":"json-schema","title":"topUpAccepted","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"topUpAccepted"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"pix"},"bankCode":{"type":"string","example":"13935893"},"branchCode":{"type":"string","example":"0001"},"accountName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"30054759318"},"accountType":{"type":"string","example":"TRAN","description":"Type of account. Some examples 'Current Account(CACC)', 'Salary Account(SLRY)', 'Savings Account(SVGS)', 'Payment Account (TRAN)'."},"documentNumber":{"type":"string","example":"43394559000156","description":"Represents the Payer's Tax ID (CPF or CNPJ Number) in Brazil."},"bookingDate":{"type":"string","example":"2025-05-02"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/topUpRejected":{"id":"components/schemas/topUpRejected","kind":"json-schema","title":"topUpRejected","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"topUpRejected"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"pix"},"bankCode":{"type":"string","example":"13935893"},"branchCode":{"type":"string","example":"0001"},"accountName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"30054759318"},"accountType":{"type":"string","example":"TRAN","description":"Type of account. Some examples 'Current Account(CACC)', 'Salary Account(SLRY)', 'Savings Account(SVGS)', 'Payment Account (TRAN)'."},"documentNumber":{"type":"string","example":"43394559000156","description":"Represents the Payer's Tax ID (CPF or CNPJ Number) in Brazil."},"bookingDate":{"type":"string","example":"2025-05-02"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/chargedBack":{"id":"components/schemas/chargedBack","kind":"json-schema","title":"chargedBack","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":"Type of payment event.","example":"chargedBack"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/cancelledByCustomer":{"id":"components/schemas/cancelledByCustomer","kind":"json-schema","title":"cancelledByCustomer","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":"Type of payment event.","example":"cancelledByCustomer"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/requestExpired":{"id":"components/schemas/requestExpired","kind":"json-schema","title":"requestExpired","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payment"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":"Type of payment event.","example":"requestExpired"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"paymentInstrument":{"type":"object","properties":{"method":{"type":"string","example":"klarna"}}},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"components/schemas/disbursedPayout":{"id":"components/schemas/disbursedPayout","kind":"json-schema","title":"disbursedPayout","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payout"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"disbursed"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"}}}}}},"components/schemas/pendingPayout":{"id":"components/schemas/pendingPayout","kind":"json-schema","title":"pendingPayout","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payout"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"pending"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"}}}}}},"components/schemas/refusedPayout":{"id":"components/schemas/refusedPayout","kind":"json-schema","title":"refusedPayout","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payout"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"refused"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"}}}}}},"components/schemas/requestedPayout":{"id":"components/schemas/requestedPayout","kind":"json-schema","title":"requestedPayout","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payout"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"requested"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"}}}}}},"components/schemas/approvedPayout":{"id":"components/schemas/approvedPayout","kind":"json-schema","title":"approvedPayout","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"payout"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"approved"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"}}}}}},"components/schemas/informationRequestedChargeback":{"id":"components/schemas/informationRequestedChargeback","kind":"json-schema","title":"informationRequestedChargeback","data":{"properties":{"eventId":{"$ref":"#/components/schemas/eventId"},"eventTimestamp":{"$ref":"#/components/schemas/eventTimestamp"},"eventDetails":{"type":"object","properties":{"classification":{"type":"string","description":"The event category, this can either be payout, payment or chargeback.","example":"chargeback"},"transactionReference":{"$ref":"#/components/schemas/transactionReference"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event status. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sentForAuthorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"informationRequested"},"date":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/amount"},"_links":{"$ref":"#/components/schemas/_links"}}}}}},"schema_385":{"kind":"json-schema","data":{"oneOf":[{"title":"Card","type":"object","$ref":"#/components/schemas/authorizedPayment"},{"title":"APM - generic","type":"object","$ref":"#/components/schemas/authorizedAPMPayment"},{"title":"APM - Klarna (recurring)","type":"object","$ref":"#/components/schemas/authorizedPaymentKlarna"},{"title":"APM - MyBank","type":"object","$ref":"#/components/schemas/authorizedPaymentMyBank"},{"title":"APM - iDEAL","type":"object","$ref":"#/components/schemas/authorizedPaymentIdeal"},{"title":"APM - Open Banking","type":"object","$ref":"#/components/schemas/authorizedPaymentOpenBanking"}]},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"oneOf":[{"title":"Card","type":"object","$ref":"#/components/schemas/sentForSettlementPayment"},{"title":"APM - generic","type":"object","$ref":"#/components/schemas/sentForSettlementPayment"},{"title":"APM - Pix","type":"object","$ref":"#/components/schemas/sentForSettlementPaymentPix"},{"title":"APM - Klarna (recurring)","type":"object","$ref":"#/components/schemas/sentForSettlementPaymentKlarna"},{"title":"APM - MyBank","type":"object","$ref":"#/components/schemas/sentForSettlementPaymentMyBank"},{"title":"APM - iDEAL","type":"object","$ref":"#/components/schemas/sentForSettlementPaymentIdeal"},{"title":"APM - Open Banking","type":"object","$ref":"#/components/schemas/sentForSettlementPaymentOpenBanking"}]},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"oneOf":[{"title":"Card","type":"object","$ref":"#/components/schemas/refusedPayment"},{"title":"APM - generic","type":"object","$ref":"#/components/schemas/refusedAPMPayment"}]},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"oneOf":[{"title":"Card","type":"object","$ref":"#/components/schemas/tokenCreatedCard"},{"title":"Klarna (recurring)","type":"object","$ref":"#/components/schemas/tokenCreatedKlarna"},{"title":"iDEAL","type":"object","$ref":"#/components/schemas/tokenCreatedIdeal"},{"title":"SEPA","type":"object","$ref":"#/components/schemas/tokenCreatedSepa"}]},"id":"schema_388"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://merchant-defined-url.com","description":"Merchant Webhook Path"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":5,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"}]},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/events/@v1/openapi.json?download"},{"url":"/access/_bundle/products/events/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Events","description":"Receive status updates from Access Worldpay by setting up a webhook.\n\nContact your Worldpay Implementation Manager to add your webhook URL and enable or disable the events based on your requirement.\n\nThe webhook destination (URL) must use an encrypted connection (`https`) and have a certificate signed by a trusted certificate authority. Every certificate within the chain, including the root, must be using a certificate signing algorithm of SHA-256 or better.\n\nSupport for certificate chains involving any certs with the SHA-1 certificate signing algorithm ends March 2026.\n\n<style>  \n  [class*=\"tag-post\"] {  \n      display: none;\n  }\n</style>","category":["Webhooks"],"business":["Enterprise"],"catalog-list":true,"generated":false}},"baseSlug":"/products/events/openapi","routesMapping":{}}