You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Mode of capture for the payments involved in the execution. * Instant - Authorize and capture payments in one step. * Delayed - Authorize payments initially, capture the money after a delay configured with captureDelay. * Manual - Authorize payments initially, capture the money manually via Payrails' API or portal.
If captureMode is Delayed, this field can be used to configure the scheduled time when to capture the money. The format should be based on the ISO 8601 standard.
Mode of cancel for the payments involved in the execution. * Delayed - Authorize payments initially, cancel the authorization after a delay configured with cancelDelay. * Manual - Authorize payments initially, cancel the authorization manually via Payrails' API or portal.
If cancelMode is Delayed, this field can be used to configure the scheduled time when to cancel the authorization. The format should be based on the ISO 8601 standard.
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.
Additional meta fields to be sent to the payment providers which support metadata / tags.
For example, sent to Stripe as metadata.
Because these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.
Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.
See Meta.paymentMethods for every field.
Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.
See Meta.upi for every field.
Actions to execute after the creation of the execution. Initial actions are performed sequentially, and results reported in corresponding items of initialResults irrespective of errors in earlier actions.
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.
Additional meta fields to be sent to the payment providers which support metadata / tags.
For example, sent to Stripe as metadata.
Because these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.
Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.
See Meta.paymentMethods for every field.
Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.
See Meta.upi for every field.
Business-case dependent set of status tags of this execution. The order of statuses does not matter and should not be used for any logic. See CreateExecutionResponse.status for every field.
Amount of the execution.
Only present if an amount has been set on the execution via an action (lookup, authorize, etc.).
See CreateExecutionResponse.amount for every field.
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field. See CreateExecutionResponse.meta for every field.
Results of the initialActions specified during execution creation.
Indexes of this array correspond one to one with those from initialActions,
each initial action reports their result here.
See CreateExecutionResponse.initialResults for every field.
Specify what triggered the event. * api - Event was triggered through an API request. * action - Event was triggered as a result of another action. * external - Event was triggered outside of Payrails.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Payrails Docs","description":"Developer and operator documentation for Payrails, the payment operating system for global enterprises: payment orchestration across providers, PCI-compliant tokenization, analytics and reporting, Chargebacks, and the Payrails REST API.","colors":{"primary":"#D63D00","light":"#E4853A"},"logo":{"light":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/light.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=2692c29175ef45b637b4e2df6e2da330","dark":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/dark.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=651119b7fb40dda938e2f9a7a276ee1c"},"favicon":"https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/favicon.png?fit=max\u0026auto=format\u0026n=zqk7oWHZbW3YniA1\u0026q=85\u0026s=70b0991c3a7ad3c2faa4530e27040cf8","api":{"params":{"expanded":"all","post":["nullable","x-internal"]},"playground":{"display":"simple"},"examples":{"defaults":"required","prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://www.payrails.com","label":"Go to payrails.com"}],"primary":{"type":"button","label":"Book a demo","href":"https://www.payrails.com/contact"}},"footer":{"socials":{"x":"https://x.com/Payrails_com","github":"https://github.com/payrails","linkedin":"https://www.linkedin.com/company/payrails"},"links":[{"header":"Company","items":[{"label":"payrails.com","href":"https://www.payrails.com"}]}]},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@Payrails_com","msvalidate.01":"7723ABF900EAD08F0500790E9BFC62E7"},"organization":{"id":"https://www.payrails.com#organization","name":"Payrails","legalName":"Payrails GmbH","url":"https://www.payrails.com/","logo":"https://www.payrails.com/payrails-logo.svg","sameAs":["https://www.linkedin.com/company/payrails/","https://www.crunchbase.com/organization/payrails","https://www.wikidata.org/wiki/Q137211152","https://x.com/Payrails_com"]}},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"cookies":{"key":"mintlify_telemetry_enabled","value":"true"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/payrails-42074109/_AaiU-jGVknFpls9/images/common/og-thumbnail-bg-v5.png?fit=max\u0026auto=format\u0026n=_AaiU-jGVknFpls9\u0026q=85\u0026s=b08b137c9aa7638918675c41a07b33c6"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.","Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.","Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.","Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.","Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.","Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.","Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code."]},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"payrails-42074109","hasAudioNarration":false,"actualSubdomain":"payrails-42074109","customDomains":["docs.payrails.com"],"gitSource":{"type":"github","owner":"payrails","repo":"docs-payrails-com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae2386ab4c6607a2bf70483","collectionId":"70a0b0ec-fc3a-444b-8a2d-06bf231db004","liveDeploymentHistoryId":"6ae2386ab4c6607a2bf70483","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae2386ab4c6607a2bf70483","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Guides","count":362},{"language":"default","tag":"Payment Orchestration","count":278},{"language":"default","tag":"API Reference","count":176},{"language":"default","tag":"Payment Methods","count":143},{"language":"default","tag":"Integrations","count":63},{"language":"default","tag":"Dispute","count":47},{"language":"default","tag":"Disputes","count":47},{"language":"default","tag":"Payrails Checkout SDKs","count":39},{"language":"default","tag":"Getting Started","count":30},{"language":"default","tag":"Payment","count":28}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://www.payrails.com/contact"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"css/styles.css","content":"*,:after,:before{box-sizing:border-box}:after,:before{--tw-content:\"\"}:host,html{-webkit-text-size-adjust:100%;tab-size:4;font-feature-settings:normal;font-variation-settings:normal;-webkit-tap-highlight-color:transparent;font-family:ui-sans-serif,system-ui,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;line-height:1.5}body{line-height:inherit;margin:0}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}a{color:inherit}b,strong{font-weight:bolder}code,kbd,pre,samp{font-feature-settings:normal;font-variation-settings:normal;font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}button,select{text-transform:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}#page-context-menu-button{border-radius:var(--border-radius-sm) 0 0 var(--border-radius-sm)}#page-context-menu-button+*+button,#page-context-menu-button+button{border-left:none;border-radius:0 var(--border-radius-sm) var(--border-radius-sm) 0}.peer:not(.is-custom) [data-docs-theme] header+div,header#navbar>div.mx-auto{margin:0 auto;max-width:100rem}.mdx-content a,[data-active-nav-item=true]>a,[data-active-nav-item=true]>button{color:var(--accent)}#navbar>div.mx-auto div.h-16{height:calc(var(--spacing)*13)}#navbar>div.mx-auto button.h-9,#navbar>div.mx-auto div.h-12,#topbar-cta-button a>div{height:calc(var(--spacing)*8)}@media (min-width:1024px){#sidebar-content{margin-top:calc(var(--mintlify-slot-header-height, 7rem) - var(--spacing)*21)}}#topbar-cta-button a>div{padding:0 calc(var(--spacing)*3.5);border:1px solid rgb(var(--gray-400)/.3);border-radius:8px;background:rgb(var(--background-light));color:rgb(var(--gray-500))}#footer [data-testid=mode-switch-dark],#footer [data-testid=mode-switch-light],#footer [data-testid=mode-switch-system],#topbar-cta-button a svg{display:none}#topbar-cta-button a:hover>div{color:rgb(var(--gray-800))}html.dark #topbar-cta-button a>div{border-color:rgb(var(--gray-600)/.3);background:rgb(var(--background-dark));color:rgb(var(--gray-300))}html.dark #topbar-cta-button a:hover>div{color:rgb(var(--gray-100))}#navbar+div .page-content,#navbar.peer.is-not-custom.is-not-wide.is-not-center+div{max-width:100rem;margin:0 auto}#content-container>div.max-w-5xl{max-width:70rem}.mdx-content a{text-decoration:none}.mdx-content a.link:not(:has(div,img,picture)):not(.not-prose *){border-bottom:0;text-decoration-line:underline;text-decoration-thickness:max(1px,.0625rem);text-underline-offset:.2em;text-decoration-skip-ink:auto;text-decoration-color:color-mix(in srgb,currentColor 70%,transparent)}.callout .prose :where(h1, h2, h3, h4):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){margin-top:0}#content-area>#content{margin-bottom:calc(var(--spacing)*8)}#content-area>:is(#content, [id^=\"api-playground\"])+div:not([id]){padding-bottom:calc(var(--spacing)*6)}#footer.advanced-footer>div{padding-bottom:calc(var(--spacing)*8);padding-top:calc(var(--spacing)*8);gap:calc(var(--spacing)*4)}@media (min-width:1024px){[data-theme-preference-switch=pill]{width:fit-content;gap:2px;padding:1px}[data-theme-preference-switch=pill]>[data-theme-preference-value]{width:1.5rem;height:1.5rem}}html.dark #footer a.dark\\:text-white\\/50,html.dark :is(#content, #header > .prose, #table-of-contents),html.dark :is(#navbar, #sidebar-content, #content-area) .dark\\:text-gray-400{color:rgb(var(--gray-300))}html.dark #footer a.dark\\:text-white\\/50:hover,html.dark #table-of-contents .toc-item:not([data-active])>a:hover,html.dark :is(#navbar, #sidebar-content, #content-area) .dark\\:text-gray-400:hover{color:rgb(var(--gray-100))}html.dark #content-area a.dark\\:text-gray-50>svg,html.dark #search-bar-entry{color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600{background-color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600:hover{background-color:rgb(var(--gray-200))}html.dark .sidebar-group-icon[src*=\"/images/icons/nav/\"]{filter:invert(.9)}html:not(.dark) .nav-tag-pill-text{color:var(--button-primary-bg-active)}html:not(.dark) .text-green-700.bg-green-400\\/20{color:#166534}html:not(.dark) .text-yellow-700.bg-yellow-400\\/20{color:#854d0e}html:not(.dark) .text-orange-700.bg-orange-400\\/20{color:#9a3412}.text-\\[\\#FFFFFF\\].bg-\\[\\#2AB673\\]{background-color:#15803d}.text-\\[\\#FFFFFF\\].bg-\\[\\#C28C30\\]{background-color:#a16207}.text-\\[\\#FFFFFF\\].bg-\\[\\#DA622B\\]{background-color:#c2410c}html:not(.dark) [data-component-part=field-required-pill]{color:#b91c1c}html:not(.dark) [data-component-part=code-group-tab-bar] .text-gray-500:not(:hover){color:rgb(var(--gray-600))}html.dark :is(#navbar a.dark\\:text-gray-200, #content-area a.dark\\:text-gray-50){color:rgb(var(--gray-50))}#table-of-contents .toc-item[data-active]>a,html.dark #content-area a.dark\\:text-gray-50:hover{color:var(--accent)}@layer theme{.peer.is-custom~#footer.advanced-footer{display:flex!important;margin-top:auto!important}div:has(>.peer.is-custom~#footer.advanced-footer){display:flex!important;flex-direction:column;min-height:100vh}}#sidebar-content img[src*=\"/images/icons/letters/\"],#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"]{width:1.5rem;height:1.5rem;--tile-radius:0.375rem;border-radius:var(--tile-radius)}#sidebar-content img[src*=\"/images/icons/letters/\"],#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"],.payment-method-logo,.prose img.page-logo,.provider-card-logo{--tile:var(--tag-neutral-bg);--r:calc(var(--tile-radius) - 1px);background:radial-gradient(circle at 100% 100%,var(--tile) calc(var(--r) - .5px),transparent var(--r)) 1px 1px/var(--r) var(--r) no-repeat,radial-gradient(circle at 0 100%,var(--tile) calc(var(--r) - .5px),transparent var(--r)) calc(100% - 1px) 1px/var(--r) var(--r) no-repeat,radial-gradient(circle at 100% 0,var(--tile) calc(var(--r) - .5px),transparent var(--r)) 1px calc(100% - 1px)/var(--r) var(--r) no-repeat,radial-gradient(circle at 0 0,var(--tile) calc(var(--r) - .5px),transparent var(--r)) calc(100% - 1px) calc(100% - 1px)/var(--r) var(--r) no-repeat,linear-gradient(var(--tile),var(--tile)) center/calc(100% - 2px) calc(100% - 2*var(--r)) no-repeat,linear-gradient(var(--tile),var(--tile)) center/calc(100% - 2*var(--r)) calc(100% - 2px) no-repeat}@media (max-width:767px){.expandable-content{margin:0!important;padding-left:6px!important;padding-right:0!important}.expandable-content .expandable{border-right:0;border-top-right-radius:0;border-bottom-right-radius:0}.expandable-content .expandable-content{min-width:16rem}.expandable-content:not(.expandable-content *){overflow-x:auto}.expandable-content .prose{padding-right:12px}.param-head div{min-width:0}[data-component-part=field-info-pill]{display:inline-block!important;max-width:100%;vertical-align:bottom}[data-component-part=field-info-pill]>span{display:-webkit-box;-webkit-box-orient:vertical;-webkit-line-clamp:2;line-clamp:2;overflow:hidden}}html[data-current-path=\"/docs/connections\"] .nav-tabs-item[data-active=true]{text-shadow:none}html[data-current-path=\"/docs/connections\"] .nav-tabs-item[data-active=true]>div{background-color:transparent}html[data-current-path=\"/docs/connections\"] .nav-tabs-item[href=\"/docs/connections\"]{text-shadow:-.2px 0 0 currentColor,.2px 0 0 currentColor}html[data-current-path=\"/docs/connections\"] .nav-tabs-item[href=\"/docs/connections\"]>div{background-color:rgb(var(--primary))}html.dark[data-current-path=\"/docs/connections\"] .nav-tabs-item[href=\"/docs/connections\"]>div{background-color:rgb(var(--primary-light))}html.dark[data-current-path=\"/docs/connections\"] #navbar a.nav-tabs-item[data-active=true]:not(:hover){color:rgb(var(--gray-300))}html.dark[data-current-path=\"/docs/connections\"] #navbar a.nav-tabs-item[href=\"/docs/connections\"]{color:rgb(var(--gray-50))}.page-logos{display:flex;gap:.75rem;margin:-1rem 0 1.75rem}.prose .page-logos picture{margin:0}.prose img.page-logo{display:block;width:3.5rem;height:3.5rem;margin:0;--tile-radius:0.75rem;border-radius:var(--tile-radius);object-fit:contain}@media (prefers-reduced-motion:no-preference){html{scroll-behavior:smooth}}"},{"filePath":"css/vars.css","content":":root{--pr-orange:#d63d00;--pr-black:#000;--pr-white:#fff;--pr-heritage:#0a6cff;--pr-antalya-sea:#597991;--pr-dublin-ale:#e4853a;--pr-baku-brass:#8a725c;--pr-cairo-sand:#d6cbc1;--accent:rgb(var(--primary));--link-active:var(--button-primary-bg-active);--link-hover:var(--button-primary-bg-hover);--main-color:var(--pr-orange);--background:var(--pr-white);--badge-new-bg:#ffedd5;--badge-new-text:#ad3100;--bento-media-gradient-end:#100;--bento-media-gradient-start:#f34f12;--border-radius-sm:4px;--border-hover:#d1d1d1;--border-subtle:#e5e5e5;--button-focus-outline:#09090b;--button-ghost-bg-active:#e4e4e7;--button-ghost-bg-hover:#f4f4f5;--button-ghost-text:#18181b;--button-primary-bg:var(--main-color);--button-primary-bg-active:#a32e00;--button-primary-bg-hover:#be3600;--button-primary-text:#fff;--button-quaternary-bg:#fff;--button-quaternary-bg-active:#e4e4e7;--button-quaternary-bg-hover:#f4f4f5;--button-quaternary-text:#18181b;--button-secondary-bg:transparent;--button-secondary-bg-active:#fadcc0;--button-secondary-bg-hover:#ffedd5;--button-secondary-border:#ad3100;--button-secondary-text:#ad3100;--button-tertiary-bg:#fff2e1;--button-tertiary-bg-active:#fed7aa;--button-tertiary-bg-hover:#ffedd5;--button-tertiary-text:#ad3100;--capability-chip-bg:#f0f6ff;--capability-chip-border:#d8e6ff;--capability-chip-text:#002e99;--container-gutter-default:16px;--container-gutter-lg:32px;--container-max-2xl:1360px;--foreground:#000;--logo-fallback-0-bg:#eff6ff;--logo-fallback-0-text:#1d4ed8;--logo-fallback-1-bg:#f0fdf4;--logo-fallback-1-text:#15803d;--logo-fallback-2-bg:#fffbeb;--logo-fallback-2-text:#b45309;--logo-fallback-3-bg:#faf5ff;--logo-fallback-3-text:#7e22ce;--logo-fallback-4-bg:#fff1f2;--logo-fallback-4-text:#be123c;--logo-fallback-5-bg:#ecfeff;--logo-fallback-5-text:#0e7490;--status-in-progress:#f0b400;--status-in-progress-bg:#fff4d1;--status-in-progress-text:#7e6612;--status-live:#2ba027;--status-live-bg:#dbf6da;--status-live-text:#207c40;--surface-1:#fff;--surface-2:#f5f5f5;--surface-warm:#f1f0ec;--tag-neutral-bg:#f6f7fa;--tag-neutral-border:#f0f2f6;--tag-neutral-text:#3f4d67;--text-muted:#404040;--text-soft:#666c79;--text-strong:#171717;--text-subtle:#9ca3af}html.dark{--accent:rgb(var(--primary-light));--link-active:#c96f28;--link-hover:#f0a266}"},{"filePath":"snippets/general/card.css","content":".pr-card-group{container-type:inline-size;display:grid;gap:var(--space-4, 16px);margin:var(--space-4, 16px) 0}.pr-card-group--cols-1{grid-template-columns:1fr}.pr-card-group--cols-2{grid-template-columns:repeat(2,minmax(0,1fr))}.pr-card-group--cols-3{grid-template-columns:repeat(3,minmax(0,1fr))}.pr-card-group--cols-4{grid-template-columns:repeat(4,minmax(0,1fr))}@container (max-width: 620px){.pr-card-group--cols-3,.pr-card-group--cols-4{grid-template-columns:repeat(2,minmax(0,1fr))}}@container (max-width: 340px){.pr-card-group{grid-template-columns:1fr}}.pr-card{display:flex;flex-direction:column;height:100%;overflow:hidden;border:1px solid #e5e5e5;border-radius:1rem;background-color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0/.05);text-decoration:none;transition:transform .2s ease,background .2s ease,box-shadow .2s ease}.pr-card:hover{background-color:#f5f5f5;box-shadow:0 10px 15px -3px rgb(0 0 0/.1),0 4px 6px -4px rgb(0 0 0/.1)}.pr-card__image{display:block;background-size:cover;width:100%;height:auto;aspect-ratio:16/9;margin:0;object-fit:cover;background-color:#f3f4f6}.pr-card__body{display:flex;flex-direction:column;gap:.5rem;height:100%;padding:1.5rem}.pr-card__header{display:flex;align-items:center;gap:.5rem}.pr-card__icon{display:flex;flex-shrink:0;align-items:center;justify-content:center;width:2.5rem;height:2.5rem;border-radius:1rem;background-color:rgb(var(--primary)/.1);color:var(--accent)}.pr-card__body:not(:first-child){border-top:1px solid #e5e5e5}.pr-card__title{margin:0;font-size:1.25rem;font-weight:600;line-height:1.25rem;color:var(--foreground)}.pr-card__text{margin:0;font-size:.875rem;font-weight:400;line-height:1.5rem;color:var(--text-muted)}.dark .pr-card{border-color:#262626;background-color:#171717}.dark .pr-card:hover,.dark .pr-card__icon,.dark .pr-card__image{background-color:#262626}.dark .pr-card__body:not(:first-child){border-top-color:#404040}.dark .pr-card__title{color:#fff}.dark .pr-card__text{color:#f5f5f5}.pr-card.hover-zoom{transform:scale(1)}@media (prefers-reduced-motion:reduce){.pr-card.hover-zoom{transform:none}}.provider-card{display:flex;align-items:center;gap:.75rem;text-align:left}.provider-card-logo{display:block;width:2.5rem;height:2.5rem;flex-shrink:0;overflow:hidden;--tile-radius:0.5rem;border-radius:var(--tile-radius)}.provider-card-logo img{width:100%;height:100%;margin:0;object-fit:contain}.provider-card-logo-fallback{display:flex;align-items:center;justify-content:center;width:100%;height:100%;background:var(--tag-neutral-bg);color:var(--tag-neutral-text);font-size:1.25rem;font-weight:600;line-height:1}.provider-card-name,.provider-card-type{margin:0}.provider-card-name{font-weight:600}.provider-card-type{font-size:.875rem;line-height:1.25rem;color:rgb(var(--gray-500))}.dark .provider-card-type{color:rgb(var(--gray-400))}"},{"filePath":"snippets/payment-methods/explorer.css","content":".payment-methods-explorer:empty{min-height:3000px}.payment-method-logo{display:inline-flex;width:28px;height:28px;flex-shrink:0;overflow:hidden;--tile-radius:0.375rem;border-radius:var(--tile-radius)}.payment-method-logo img{width:100%;height:100%;margin:0;object-fit:contain}"},{"filePath":"snippets/integrations/filterable-list.css","content":".integrations-filter{container-type:inline-size}.integrations-filter:empty::before{content:\"\";display:block;height:184px}@container (min-width: 310px){.integrations-filter:empty::before{height:140px}}@container (min-width: 364px){.integrations-filter:empty::before{height:96px}}@container (min-width: 665px){.integrations-filter:empty::before{height:52px}}.integration-card{display:flex;flex-direction:column}.integration-card>.card{flex:1}.integration-card[hidden]{display:none!important}"}],"page":{"pagePath":"reference/getworkflowhistory","slug":"/reference/getworkflowhistory","pageMetadata":{"title":"Search \u0026 list events","description":"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/history","href":"/reference/getworkflowhistory","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Search \u0026 list events","description":"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/history","href":"/reference/getworkflowhistory","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/payrails-42074109/138fc948c6832630/consent.js","/_mintlify/custom/payrails-42074109/6a6f8c8ba4227cb9/same-tab-links.js"],"openApiReferenceData":{"operation":{"summary":"Search \u0026 list events","x-mint":{"metadata":{"description":"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.","sidebarTitle":"Search \u0026 list events"},"href":"/reference/getworkflowhistory"},"operationId":"getWorkflowHistory","description":"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.","tags":["Actions"],"security":["2de65aaa-db26-46d5-bc9e-921dcbeba789"],"parameters":["aa3656e4-8651-474e-8ca9-a8c6375b9218","c10c4cba-593f-45a7-82e8-a1a4476f6e5e","a6ec9a86-1b24-4acd-ae9a-313c514a2e5e","749b07b3-0813-4b0e-87ff-13a2ea9cd51c","a0e8a848-fc01-4ce2-bc5c-a6c7bd694f86","b13dcc43-98db-4c29-baf9-f80dc11b84fc","83093af8-a2e4-4b70-9a22-1f4782591ff1"],"responses":{"200":"5a17c297-e07f-4818-93f6-2f4db9db8cb0","401":"d4b9fae7-35ca-4683-a0b0-12028d8f6562","403":"efd92ce5-ab63-4876-8855-f5aa6b6c4d8a","404":"0e85fa03-4286-497b-a752-d54478219057","429":"709507c7-cf50-47e9-bdf6-b31daf00356f"},"method":"get","type":"path","servers":["e23a8acb-dc2c-48e6-bf08-5355ad9ca20e"],"path":"/merchant/workflows/{workflowCode}/executions/{executionId}/history","baseUrlOptions":["https://api.staging.payrails.io"],"title":"Search \u0026 list events","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"aa3656e4-8651-474e-8ca9-a8c6375b9218":{"name":"workflowCode","in":"path","description":"Path parameter to specify the workflow code.","required":true,"schema":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Path parameter to specify the workflow code.\nMachine-friendly code of Workflow.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"payment-acceptance"},"c10c4cba-593f-45a7-82e8-a1a4476f6e5e":{"name":"executionId","in":"path","description":"Identifier of the resource in Payrails.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Identifier of the resource in Payrails.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f"},"a6ec9a86-1b24-4acd-ae9a-313c514a2e5e":{"name":"filter[event]","in":"query","schema":{"type":"string","description":"Filter for the type of event.\nName of the event.","enum":["executionCreated","executionActionRequested","executionActionCompleted","ruleEngineExecuted","networkOffersEnrollmentCompleted","executionActionScheduled","executionActionUnscheduled","executionActionUpdated","executionActionPending","executionActionStepScheduled","executionActionStepUnscheduled","executionActionStepRequested","executionActionStepStarted","executionActionStepPaused","executionActionStepResumed","executionActionStepCompleted","executionActionStepUpdated","executionTriggerStepCalled","executionConditionStepEvaluated"],"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter for the type of event."},"749b07b3-0813-4b0e-87ff-13a2ea9cd51c":{"name":"filter[action]","in":"query","schema":{"type":"string","enum":["lookup","startPaymentSession","authorize","capture","confirm","cancel","refund"],"description":"Filter for the type of action.\nType of action.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter for the type of action."},"a0e8a848-fc01-4ce2-bc5c-a6c7bd694f86":{"name":"filter[actionId]","in":"query","schema":{"type":"string","format":"uuid","description":"Filter for the unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Filter for the unique action execution identifier originally returned in the synchronous action response."},"b13dcc43-98db-4c29-baf9-f80dc11b84fc":{"name":"filter[notificationStatus]","in":"query","schema":{"type":"string","description":"Filter for the status of the associated notification event.\nValue of Notification event status enumeration.","enum":["delivered","deliveryFailed","pending"],"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter for the status of the associated notification event."},"83093af8-a2e4-4b70-9a22-1f4782591ff1":{"name":"filter[errorCode]","in":"query","schema":{"type":"string","description":"Filter for the type of error code produced for execution event.","uniqueKey":"","typeLabel":"string"},"description":"Filter for the type of error code produced for execution event."}},"responses":{"5a17c297-e07f-4818-93f6-2f4db9db8cb0":{"description":"OK.","content":{"application/json":{"schema":{"type":"object","required":["events"],"properties":{"events":{"type":"array","items":{"type":"object","description":"Workflow event history record with related notifications.","required":["event","time","details","workspaceId","eventTrigger"],"properties":{"event":{"type":"string","description":"Name of the event.","enum":["executionCreated","executionActionRequested","executionActionCompleted","ruleEngineExecuted","networkOffersEnrollmentCompleted","executionActionScheduled","executionActionUnscheduled","executionActionUpdated","executionActionPending","executionActionStepScheduled","executionActionStepUnscheduled","executionActionStepRequested","executionActionStepStarted","executionActionStepPaused","executionActionStepResumed","executionActionStepCompleted","executionActionStepUpdated","executionTriggerStepCalled","executionConditionStepEvaluated"],"isRequired":true,"uniqueKey":"events.items.[INDEX].event","typeLabel":"enum\u003cstring>"},"time":{"type":"string","format":"date-time","description":"When this execution was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"details":{"oneOf":[{"type":"object","title":"executionCreated","description":"Details for an executionCreated event.","required":["request","response"],"properties":{"request":{"type":"object","title":"Create execution request","required":["merchantReference","holderReference"],"properties":{"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the execution counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.holderReference","typeLabel":"string"},"workspaceId":{"type":"string","description":"References in which workspace the execution will be created.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workspaceId","typeLabel":"string"},"workflowConfigOverride":{"description":"Merchant-provided configuration data for a particular execution, overriding values for the workflow.","type":"object","properties":{"captureMode":{"type":"string","description":"Mode of capture for the payments involved in the execution. * `Instant` - Authorize and capture payments in one step. * `Delayed` - Authorize payments initially, capture the money after a delay configured with `captureDelay`. * `Manual` - Authorize payments initially, capture the money manually via Payrails' API or portal.\n","enum":["Instant","Delayed","Manual"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowConfigOverride.captureMode","typeLabel":"enum\u003cstring>"},"captureDelay":{"type":"string","description":"If `captureMode` is `Delayed`, this field can be used to configure the scheduled time when to capture the money. The format should be based on the [ISO 8601 standard](https://tc39.es/proposal-temporal/docs/duration.html).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowConfigOverride.captureDelay","typeLabel":"string"},"cancelMode":{"type":"string","description":"Mode of cancel for the payments involved in the execution. * `Delayed` - Authorize payments initially, cancel the authorization after a delay configured with `cancelDelay`. * `Manual` - Authorize payments initially, cancel the authorization manually via Payrails' API or portal.\n","enum":["Delayed","Manual"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowConfigOverride.cancelMode","typeLabel":"enum\u003cstring>"},"cancelDelay":{"type":"string","description":"If `cancelMode` is `Delayed`, this field can be used to configure the scheduled time when to cancel the authorization. The format should be based on the [ISO 8601 standard](https://tc39.es/proposal-temporal/docs/duration.html).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowConfigOverride.cancelDelay","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowConfigOverride","typeLabel":"object"},"workflowVersion":{"type":"integer","description":"Version of a Workflow Configuration.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.workflowVersion","typeLabel":"integer"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.meta","typeLabel":"object"},"applePayConfigId":{"type":"string","description":"ID of the Apple Pay configuration to use for this request. When provided, Apple Pay will be enabled as a payment method.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.applePayConfigId","typeLabel":"string"},"initialActions":{"description":"Actions to execute after the creation of the execution. Initial actions are performed sequentially, and results reported in corresponding items of `initialResults` irrespective of errors in earlier actions.","type":"array","items":{"oneOf":[{"type":"object","title":"Initial Lookup action","required":["action"],"properties":{"action":{"type":"string","enum":["lookup"],"description":"Execute an initial lookup action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.action","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"body":{"type":"object","properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.amount.currency","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.amount","typeLabel":"object"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body.meta","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0.body","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.0","typeLabel":"Initial Lookup action · object"},{"type":"object","title":"Initial Start Payment Session action","required":["action","method","body"],"properties":{"action":{"type":"string","enum":["startPaymentSession"],"description":"Execute an initial start payment session action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.action","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.method","typeLabel":"enum\u003cstring>"},"body":{"type":"object","required":["integrationType","amount"],"properties":{"integrationType":{"type":"string","enum":["api","hpp","inperson"],"description":"Code of the integration type for using the payment method in the provider.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.integrationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.amount.currency","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.amount","typeLabel":"object"},"paymentMethodCode":{"type":"string","enum":["applePay"],"description":"Code of the payment method selected to start a payment session.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.paymentMethodCode","typeLabel":"enum\u003cstring>"},"returnInfo":{"type":"object","description":"URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL.\nThe 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time.\n","required":["success"],"properties":{"success":{"type":"string","description":"URL to redirect consumers to when the execution stops interacting with them due to progress.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.returnInfo.success","typeLabel":"string"},"cancel":{"type":"string","description":"URL to redirect consumers to when the execution is canceled.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.returnInfo.cancel","typeLabel":"string"},"error":{"type":"string","description":"URL to redirect consumers to when the execution encounters technical difficulties.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.returnInfo.error","typeLabel":"string"},"pending":{"type":"string","description":"URL to redirect consumers to when the execution stays in pending for some time.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.returnInfo.pending","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.returnInfo","typeLabel":"object"},"meta":{"oneOf":[{"type":"object","title":"General","description":"Any merchant-specific data that should be used and carried for context in the action execution.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0.upi","typeLabel":"any"}},"additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.0","typeLabel":"General · object"},{"type":"object","title":"Apple Pay","description":"Any merchant-specific data that should be used and carried for context in the action execution.","required":["sessionURL"],"properties":{"sessionURL":{"type":"string","description":"Validation URL provided by Apple Pay client.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.1.sessionURL","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta.oneOf.1","typeLabel":"Apple Pay · object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body.meta","typeLabel":"General · object | Apple Pay · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1.body","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.1","typeLabel":"Initial Start Payment Session action · object"},{"type":"object","title":"Initial Payment Authorize action","required":["action","method","body"],"properties":{"action":{"type":"string","enum":["authorize"],"description":"Execute an initial payment authorize action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.action","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.method","typeLabel":"enum\u003cstring>"},"body":{"type":"object","required":["amount","returnInfo","paymentComposition"],"properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.amount.currency","typeLabel":"string"}},"description":"The amount to authorize.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.amount","typeLabel":"object"},"returnInfo":{"type":"object","description":"URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL.\nThe 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time.\n","required":["success"],"properties":{"success":{"type":"string","description":"URL to redirect consumers to when the execution stops interacting with them due to progress.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.returnInfo.success","typeLabel":"string"},"cancel":{"type":"string","description":"URL to redirect consumers to when the execution is canceled.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.returnInfo.cancel","typeLabel":"string"},"error":{"type":"string","description":"URL to redirect consumers to when the execution encounters technical difficulties.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.returnInfo.error","typeLabel":"string"},"pending":{"type":"string","description":"URL to redirect consumers to when the execution stays in pending for some time.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.returnInfo.pending","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.returnInfo","typeLabel":"object"},"paymentComposition":{"description":"Selected composition of payments methods and instruments to execute the action. We support one payment for each Workflow for now. Split payments and multiple payments in a Workflow will be supported very soon.","type":"array","items":{"type":"object","minItems":1,"maxItems":1,"required":["integrationType","amount"],"properties":{"integrationType":{"type":"string","enum":["api","hpp","inperson"],"description":"Code of the integration type for using the payment method in the provider.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].integrationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].amount.currency","typeLabel":"string"}},"description":"The amount to pay with this payment instrument or method.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].amount","typeLabel":"object"},"paymentMethodCode":{"type":"string","enum":["alexBankMa7fazty","amazonPay","applePay","audi2pay","alfa","alipay","bankTransfer","card","2c2p","capitecPay","cibSmartWallet","easypaisa","etisalatCash","fawryMobileWallet","fawryPay","googlePay","jazzCash","mercadoPago","monoDirectDebit","nbePhoneCash","orangeCash","oPayWallet","pagaWallet","payflex","payjustnow","payPal","pix","konnect","qnbEWallet","wafaCashWallet","weCash","genericRedirect","eftPro","upi","upiDirect","cashFreeWallet","paytmMWallet","netBanking","meezaWallet","vodafoneCash","alipayQRCode","sepaDirectDebit","sepaDirectDebitDirect","dcb","bankAccount","modo","ach","payzoneCash","revolutPay","lean","tabby","boleto","oxxo","spei","promptPay","qris","momoVN","vietQR","konbini","touchNGo","gCash","maya","pse","pagoEfectivo","napas","duitNowQR","grabPay","shopeePay","nequi","picPay","ovo","trueMoney","iDeal","iDealDirect","bancontact","mbWay","mbWayDirect","khipu","razerGold","webPay","smartPix","venmo","klarnaPayLater","klarnaPayNow","klarnaPayOverTime","knet","scalapay","bizum","payNow","atome","fpx","swish","bcp","kiosk"],"description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"enum\u003cstring>"},"paymentInstrumentId":{"type":"string","format":"uuid","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string\u003cuuid>"},"paymentInstrumentData":{"type":"object","description":"Map containing extra information collected in the client-side about the payment instrument, needed for processing the payment on backend.","additionalProperties":true,"properties":{"payerFields":{"type":"object","description":"Values the payer supplied against the payment method's `clientConfig.instrumentDataSchema` from the lookup response, keyed and typed exactly as published there. Unknown keys and values of another type are rejected. Omit when the payment method is used through its redirect flow.","additionalProperties":true,"example":{"phoneCountryCode":"351","phoneNumber":"912345678"},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.payerFields","typeLabel":"object"},"paymentToken":{"type":"string","description":"One-time payment token generated on client-side needed for execution of payment on backend (e.g. Google/Apple Pay).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.paymentToken","typeLabel":"string"},"providerData":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.providerData.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.providerData.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.providerData","typeLabel":"object | null"},"vaultToken":{"type":"string","description":"Vault token generated on client-side needed for execution of payment on backend (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.vaultToken","typeLabel":"string"},"vaultProviderConfigId":{"oneOf":[{"type":"string","format":"uuid","description":"Vault provider configuration ID originally used to generate the vaultToken.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Vault provider configuration ID originally used to generate the vaultToken.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId","typeLabel":"string\u003cuuid> | null"},"card":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Card-specific data needed by to use the vault tokens (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.card.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Card-specific data needed by to use the vault tokens (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.card.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.card","typeLabel":"object | null"},"encryptedData":{"oneOf":[{"type":"string","description":"Encrypted instrument details.\nIf `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument.\nIf `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization.\nThe instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Encrypted instrument details.\nIf `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument.\nIf `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization.\nThe instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData","typeLabel":"string | null"},"encryptedDataType":{"oneOf":[{"type":"string","enum":["card","networkToken"],"description":"Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["card","networkToken"],"description":"Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType","typeLabel":"enum\u003cstring> | null"},"futureUsage":{"oneOf":[{"description":"Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it.","type":"string","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it.","type":"null","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage","typeLabel":"enum\u003cstring> | null"},"merchantReference":{"oneOf":[{"description":"Merchant-provided reference for the instrument. Only used if `encryptedData` is passed.","type":"string","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference.oneOf.0","typeLabel":"string"},{"description":"Merchant-provided reference for the instrument. Only used if `encryptedData` is passed.","type":"null","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference","typeLabel":"string | null"},"billingAddress":{"oneOf":[{"description":"Merchant-provided billing address for the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0","typeLabel":"object"},{"description":"Merchant-provided billing address for the instrument.","type":"null","properties":{"street":{"type":"string","description":"The name of the street of a postal address."},"doorNumber":{"type":"string","description":"The number on the door, building, or room."},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address."},"area":{"type":"string","description":"The name of the suburb or area within a city."},"city":{"type":"string","description":"The name of the city of a postal address."},"postalCode":{"type":"string","description":"The postal code."},"state":{"type":"string","description":"The name of the state a postal address is in."},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests."}}},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system."},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system."},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately."},"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed."}}},"alias":{"type":"string","description":"Name of the address, e.g. home, work."},"name":{"type":"string","description":"Name of the person to whom the address belongs to."},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to."},"email":{"type":"string","description":"Email of the person to whom the address belongs to."}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress","typeLabel":"object | null"},"qrCode":{"oneOf":[{"type":"string","description":"QR Code provided on client-side and used to process a payment initiated by scanning a QR Code.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"QR Code provided on client-side and used to process a payment initiated by scanning a QR Code.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode","typeLabel":"string | null"},"eci":{"type":"string","description":"The code indicating the result of the attempt to authenticate the cardholder.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.eci","typeLabel":"string"},"network":{"description":"The card network of the encrypted instrument, e.g. Visa, Mastercard, American Express.","type":"string","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.network","typeLabel":"enum\u003cstring>"},"preferredScheme":{"description":"Selected card scheme to prefer when authorizing a co-badged card.","type":"string","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.preferredScheme","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Instrument name suitable for display.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.displayName","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","description":"Used to mark the new instrument as default.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Used to mark the new instrument as default.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.default","typeLabel":"boolean | null"},"taxId":{"type":"string","description":"Payer-provided tax identification number (e.g. CPF in Brazil) to store on the instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData.taxId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].paymentInstrumentData","typeLabel":"object"},"storeInstrument":{"type":"boolean","description":"Flag indicating if the customer wants to store the Payment Instrument for using it in future executions.","default":false,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"enrollInstrumentToNetworkOffers":{"type":"boolean","description":"Flag indicating if the customer wants to enroll a card to network offers program. If set to true, requires 'storeInstrument' to be true.","default":false,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].enrollInstrumentToNetworkOffers","typeLabel":"boolean"},"installments":{"oneOf":[{"type":"object","description":"Indicates the payment needs to be made in installments.\nShould only be set if installments are supported in the region by the PSP and the payment method.\nDuring the validation of the request, if it is determined that installments is not supported, the request would fail with an error.\n","additionalProperties":true,"properties":{"count":{"type":"integer","description":"Number of installments in which the payment should be made.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0.count","typeLabel":"integer"},"planReference":{"type":"string","description":"Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0.planReference","typeLabel":"string"},"totalAmount":{"type":"number","description":"Total of the selected plan, echoed from the payment options response.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0.totalAmount","typeLabel":"number"},"requires":{"type":"array","description":"Conditions the selected plan imposes, echoed from the payment options response.","items":{"type":"string","enum":["threeDSecure","cardVerificationCode"],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0.requires.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0.requires","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Indicates the payment needs to be made in installments.\nShould only be set if installments are supported in the region by the PSP and the payment method.\nDuring the validation of the request, if it is determined that installments is not supported, the request would fail with an error.\n","additionalProperties":true,"properties":{"count":{"type":"integer","description":"Number of installments in which the payment should be made."},"planReference":{"type":"string","description":"Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one."},"totalAmount":{"type":"number","description":"Total of the selected plan, echoed from the payment options response."},"requires":{"type":"array","description":"Conditions the selected plan imposes, echoed from the payment options response.","items":{"type":"string","enum":["threeDSecure","cardVerificationCode"]}}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX].installments","typeLabel":"object | null"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.paymentComposition","typeLabel":"object[]"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2.body","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX].oneOf.2","typeLabel":"Initial Payment Authorize action · object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions.items.[INDEX]","typeLabel":"Initial Lookup action · object | Initial Start Payment Session action · object | Initial Payment Authorize action · object"},"uniqueKey":"events.items.[INDEX].details.oneOf.0.request.initialActions","typeLabel":"(Initial Lookup action · object | Initial Start Payment Session action · object | Initial Payment Authorize action · object)[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.request","typeLabel":"Create execution request · object"},"response":{"title":"Create execution response","type":"object","description":"See [CreateExecutionResponse](/reference/createexecutionresponse) for every field.","properties":{"id":{"type":"string","description":"ID of this execution.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.id","typeLabel":"string"},"status":{"type":"array","description":"Business-case dependent set of status tags of this execution. The order of statuses does not matter and should not be used for any logic. See [CreateExecutionResponse.status](/reference/createexecutionresponse#schema-status) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.status","typeLabel":"array"},"createdAt":{"type":"string","description":"When this execution was started.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.createdAt","typeLabel":"string"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.holderReference","typeLabel":"string"},"holderId":{"type":"string","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.holderId","typeLabel":"string"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created. See [CreateExecutionResponse.workflow](/reference/createexecutionresponse#schema-workflow) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.workflow","typeLabel":"object"},"amount":{"type":"object","description":"Amount of the execution.\nOnly present if an amount has been set on the execution via an action (lookup, authorize, etc.).\n See [CreateExecutionResponse.amount](/reference/createexecutionresponse#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.amount","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field. See [CreateExecutionResponse.meta](/reference/createexecutionresponse#schema-meta) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.meta","typeLabel":"object"},"initialResults":{"type":"array","description":"Results of the `initialActions` specified during execution creation.\nIndexes of this array correspond one to one with those from `initialActions`,\neach initial action reports their result here.\n See [CreateExecutionResponse.initialResults](/reference/createexecutionresponse#schema-initial-results) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.initialResults","typeLabel":"array"},"workspaceId":{"type":"string","description":"Workspace ID that that this execution belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.workspaceId","typeLabel":"string"},"links":{"type":"object","description":"Links to the next possible actions that can be taken. See [CreateExecutionResponse.links](/reference/createexecutionresponse#schema-links) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.links","typeLabel":"object"},"requiredAction":{"type":"object","description":"Details of the next possible actions that can be taken. See [CreateExecutionResponse.requiredAction](/reference/createexecutionresponse#schema-required-action) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.requiredAction","typeLabel":"object"},"actionRequired":{"type":"string","description":"Action the customer needs to take to move the Execution state. A link with the same name should be used to continue.","uniqueKey":"events.items.[INDEX].details.oneOf.0.response.actionRequired","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0.response","typeLabel":"Create execution response · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.0","typeLabel":"executionCreated · object"},{"type":"object","title":"executionActionRequested","description":"Details for an executionActionRequested event.","required":["action","request","response"],"properties":{"action":{"type":"string","enum":["lookup","startPaymentSession","authorize","capture","confirm","cancel","refund"],"description":"Type of action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.action","typeLabel":"enum\u003cstring>"},"request":{"oneOf":[{"type":"object","title":"Authorize","required":["amount","returnInfo","paymentComposition"],"properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.amount.currency","typeLabel":"string"}},"description":"The amount to authorize.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.amount","typeLabel":"object"},"returnInfo":{"type":"object","description":"URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL.\nThe 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time.\n","required":["success"],"properties":{"success":{"type":"string","description":"URL to redirect consumers to when the execution stops interacting with them due to progress.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.returnInfo.success","typeLabel":"string"},"cancel":{"type":"string","description":"URL to redirect consumers to when the execution is canceled.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.returnInfo.cancel","typeLabel":"string"},"error":{"type":"string","description":"URL to redirect consumers to when the execution encounters technical difficulties.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.returnInfo.error","typeLabel":"string"},"pending":{"type":"string","description":"URL to redirect consumers to when the execution stays in pending for some time.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.returnInfo.pending","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.returnInfo","typeLabel":"object"},"paymentComposition":{"description":"Selected composition of payments methods and instruments to execute the action. We support one payment for each Workflow for now. Split payments and multiple payments in a Workflow will be supported very soon.","type":"array","items":{"type":"object","minItems":1,"maxItems":1,"required":["integrationType","amount"],"properties":{"integrationType":{"type":"string","enum":["api","hpp","inperson"],"description":"Code of the integration type for using the payment method in the provider.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].integrationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].amount.currency","typeLabel":"string"}},"description":"The amount to pay with this payment instrument or method.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].amount","typeLabel":"object"},"paymentMethodCode":{"type":"string","enum":["alexBankMa7fazty","amazonPay","applePay","audi2pay","alfa","alipay","bankTransfer","card","2c2p","capitecPay","cibSmartWallet","easypaisa","etisalatCash","fawryMobileWallet","fawryPay","googlePay","jazzCash","mercadoPago","monoDirectDebit","nbePhoneCash","orangeCash","oPayWallet","pagaWallet","payflex","payjustnow","payPal","pix","konnect","qnbEWallet","wafaCashWallet","weCash","genericRedirect","eftPro","upi","upiDirect","cashFreeWallet","paytmMWallet","netBanking","meezaWallet","vodafoneCash","alipayQRCode","sepaDirectDebit","sepaDirectDebitDirect","dcb","bankAccount","modo","ach","payzoneCash","revolutPay","lean","tabby","boleto","oxxo","spei","promptPay","qris","momoVN","vietQR","konbini","touchNGo","gCash","maya","pse","pagoEfectivo","napas","duitNowQR","grabPay","shopeePay","nequi","picPay","ovo","trueMoney","iDeal","iDealDirect","bancontact","mbWay","mbWayDirect","khipu","razerGold","webPay","smartPix","venmo","klarnaPayLater","klarnaPayNow","klarnaPayOverTime","knet","scalapay","bizum","payNow","atome","fpx","swish","bcp","kiosk"],"description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"enum\u003cstring>"},"paymentInstrumentId":{"type":"string","format":"uuid","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string\u003cuuid>"},"paymentInstrumentData":{"type":"object","description":"Map containing extra information collected in the client-side about the payment instrument, needed for processing the payment on backend.","additionalProperties":true,"properties":{"payerFields":{"type":"object","description":"Values the payer supplied against the payment method's `clientConfig.instrumentDataSchema` from the lookup response, keyed and typed exactly as published there. Unknown keys and values of another type are rejected. Omit when the payment method is used through its redirect flow.","additionalProperties":true,"example":{"phoneCountryCode":"351","phoneNumber":"912345678"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.payerFields","typeLabel":"object"},"paymentToken":{"type":"string","description":"One-time payment token generated on client-side needed for execution of payment on backend (e.g. Google/Apple Pay).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.paymentToken","typeLabel":"string"},"providerData":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.providerData.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.providerData.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.providerData","typeLabel":"object | null"},"vaultToken":{"type":"string","description":"Vault token generated on client-side needed for execution of payment on backend (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.vaultToken","typeLabel":"string"},"vaultProviderConfigId":{"oneOf":[{"type":"string","format":"uuid","description":"Vault provider configuration ID originally used to generate the vaultToken.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Vault provider configuration ID originally used to generate the vaultToken.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.vaultProviderConfigId","typeLabel":"string\u003cuuid> | null"},"card":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Card-specific data needed by to use the vault tokens (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.card.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Card-specific data needed by to use the vault tokens (e.g. Card).","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.card.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.card","typeLabel":"object | null"},"encryptedData":{"oneOf":[{"type":"string","description":"Encrypted instrument details.\nIf `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument.\nIf `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization.\nThe instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData.oneOf.0","typeLabel":"string"},{"type":"null","description":"Encrypted instrument details.\nIf `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument.\nIf `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization.\nThe instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedData","typeLabel":"string | null"},"encryptedDataType":{"oneOf":[{"type":"string","enum":["card","networkToken"],"description":"Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["card","networkToken"],"description":"Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.encryptedDataType","typeLabel":"enum\u003cstring> | null"},"futureUsage":{"oneOf":[{"description":"Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it.","type":"string","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it.","type":"null","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.futureUsage","typeLabel":"enum\u003cstring> | null"},"merchantReference":{"oneOf":[{"description":"Merchant-provided reference for the instrument. Only used if `encryptedData` is passed.","type":"string","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference.oneOf.0","typeLabel":"string"},{"description":"Merchant-provided reference for the instrument. Only used if `encryptedData` is passed.","type":"null","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.merchantReference","typeLabel":"string | null"},"billingAddress":{"oneOf":[{"description":"Merchant-provided billing address for the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.0","typeLabel":"object"},{"description":"Merchant-provided billing address for the instrument.","type":"null","properties":{"street":{"type":"string","description":"The name of the street of a postal address."},"doorNumber":{"type":"string","description":"The number on the door, building, or room."},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address."},"area":{"type":"string","description":"The name of the suburb or area within a city."},"city":{"type":"string","description":"The name of the city of a postal address."},"postalCode":{"type":"string","description":"The postal code."},"state":{"type":"string","description":"The name of the state a postal address is in."},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests."}}},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system."},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system."},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately."},"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed."}}},"alias":{"type":"string","description":"Name of the address, e.g. home, work."},"name":{"type":"string","description":"Name of the person to whom the address belongs to."},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to."},"email":{"type":"string","description":"Email of the person to whom the address belongs to."}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.billingAddress","typeLabel":"object | null"},"qrCode":{"oneOf":[{"type":"string","description":"QR Code provided on client-side and used to process a payment initiated by scanning a QR Code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"QR Code provided on client-side and used to process a payment initiated by scanning a QR Code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.qrCode","typeLabel":"string | null"},"eci":{"type":"string","description":"The code indicating the result of the attempt to authenticate the cardholder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.eci","typeLabel":"string"},"network":{"description":"The card network of the encrypted instrument, e.g. Visa, Mastercard, American Express.","type":"string","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.network","typeLabel":"enum\u003cstring>"},"preferredScheme":{"description":"Selected card scheme to prefer when authorizing a co-badged card.","type":"string","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.preferredScheme","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Instrument name suitable for display.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.displayName","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","description":"Used to mark the new instrument as default.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Used to mark the new instrument as default.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.default","typeLabel":"boolean | null"},"taxId":{"type":"string","description":"Payer-provided tax identification number (e.g. CPF in Brazil) to store on the instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData.taxId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].paymentInstrumentData","typeLabel":"object"},"storeInstrument":{"type":"boolean","description":"Flag indicating if the customer wants to store the Payment Instrument for using it in future executions.","default":false,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"enrollInstrumentToNetworkOffers":{"type":"boolean","description":"Flag indicating if the customer wants to enroll a card to network offers program. If set to true, requires 'storeInstrument' to be true.","default":false,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].enrollInstrumentToNetworkOffers","typeLabel":"boolean"},"installments":{"oneOf":[{"type":"object","description":"Indicates the payment needs to be made in installments.\nShould only be set if installments are supported in the region by the PSP and the payment method.\nDuring the validation of the request, if it is determined that installments is not supported, the request would fail with an error.\n","additionalProperties":true,"properties":{"count":{"type":"integer","description":"Number of installments in which the payment should be made.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0.count","typeLabel":"integer"},"planReference":{"type":"string","description":"Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0.planReference","typeLabel":"string"},"totalAmount":{"type":"number","description":"Total of the selected plan, echoed from the payment options response.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0.totalAmount","typeLabel":"number"},"requires":{"type":"array","description":"Conditions the selected plan imposes, echoed from the payment options response.","items":{"type":"string","enum":["threeDSecure","cardVerificationCode"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0.requires.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0.requires","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.0","typeLabel":"object"},{"type":"null","description":"Indicates the payment needs to be made in installments.\nShould only be set if installments are supported in the region by the PSP and the payment method.\nDuring the validation of the request, if it is determined that installments is not supported, the request would fail with an error.\n","additionalProperties":true,"properties":{"count":{"type":"integer","description":"Number of installments in which the payment should be made."},"planReference":{"type":"string","description":"Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one."},"totalAmount":{"type":"number","description":"Total of the selected plan, echoed from the payment options response."},"requires":{"type":"array","description":"Conditions the selected plan imposes, echoed from the payment options response.","items":{"type":"string","enum":["threeDSecure","cardVerificationCode"]}}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX].installments","typeLabel":"object | null"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.paymentComposition","typeLabel":"object[]"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.0","typeLabel":"Authorize · object"},{"type":"object","title":"Capture","properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.amount.currency","typeLabel":"string"}},"description":"The amount to capture, including currency. Full amount will be captured if not specified.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.amount","typeLabel":"object"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","example":"Customer's automatic subscription.","description":"An optional field to include any necessary information for the capture action.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.reasonDescription","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.meta","typeLabel":"object"},"final":{"type":"boolean","description":"The final parameter indicates if multiple partial captures are expected, if the value is false and the captured amount is less than the authorized amount then multiple partial captures can be applied until reaching the original authorized amount, if the value is true or the parameter is not sent the capture will be treated as a final capture and no further capture request will be accepted for it.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1.final","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.1","typeLabel":"Capture · object"},{"type":"object","title":"Cancel","properties":{"paymentId":{"description":"Optionally the ID of the payment to cancel. Used for payment links where an execution can have multiple successful payments. If not specified, the most recent payment done using the payment link will be cancelled.","type":"string","format":"uuid","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.2.paymentId","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.2.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","example":"Customer's automatic subscription.","description":"An optional field to include any necessary information for the capture action.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.2.reasonDescription","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.2","typeLabel":"Cancel · object"},{"type":"object","title":"Refund","properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.amount.currency","typeLabel":"string"}},"description":"The amount to refund, including currency. Full amount will be refunded if not specified.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.amount","typeLabel":"object"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","maxLength":255,"example":"Customer was charged twice for the same order.","description":"Any necessary information for the refund action, at most 255 characters. Required when `reason` is `Other`: at least 3 characters after trimming whitespace. A violation returns 400 with `reason.field` set to `reasonDescription`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.reasonDescription","typeLabel":"string"},"paymentId":{"description":"Optionally the ID of the payment to refund. Used for payment links where an execution can have multiple successful payments. If not specified, the most recent payment done using the payment link will be refunded.","type":"string","format":"uuid","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.paymentId","typeLabel":"string\u003cuuid>"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.3","typeLabel":"Refund · object"},{"type":"object","title":"Confirm","required":["data"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Any merchant-specific data that should be sent to confirm the payment.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.data","typeLabel":"object"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.actionId","typeLabel":"string\u003cuuid>"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.4","typeLabel":"Confirm · object"},{"type":"object","title":"Lookup","properties":{"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.amount.currency","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.amount","typeLabel":"object"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.5","typeLabel":"Lookup · object"},{"type":"object","title":"Start payment session","required":["integrationType","amount"],"properties":{"integrationType":{"type":"string","enum":["api","hpp","inperson"],"description":"Code of the integration type for using the payment method in the provider.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.integrationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.amount.currency","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.amount","typeLabel":"object"},"paymentMethodCode":{"type":"string","enum":["applePay"],"description":"Code of the payment method selected to start a payment session.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.paymentMethodCode","typeLabel":"enum\u003cstring>"},"returnInfo":{"type":"object","description":"URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL.\nThe 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time.\n","required":["success"],"properties":{"success":{"type":"string","description":"URL to redirect consumers to when the execution stops interacting with them due to progress.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.returnInfo.success","typeLabel":"string"},"cancel":{"type":"string","description":"URL to redirect consumers to when the execution is canceled.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.returnInfo.cancel","typeLabel":"string"},"error":{"type":"string","description":"URL to redirect consumers to when the execution encounters technical difficulties.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.returnInfo.error","typeLabel":"string"},"pending":{"type":"string","description":"URL to redirect consumers to when the execution stays in pending for some time.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.returnInfo.pending","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.returnInfo","typeLabel":"object"},"meta":{"oneOf":[{"type":"object","title":"General","description":"Any merchant-specific data that should be used and carried for context in the action execution.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0.upi","typeLabel":"any"}},"additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.0","typeLabel":"General · object"},{"type":"object","title":"Apple Pay","description":"Any merchant-specific data that should be used and carried for context in the action execution.","required":["sessionURL"],"properties":{"sessionURL":{"type":"string","description":"Validation URL provided by Apple Pay client.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.1.sessionURL","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta.oneOf.1","typeLabel":"Apple Pay · object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6.meta","typeLabel":"General · object | Apple Pay · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request.oneOf.6","typeLabel":"Start payment session · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.request","typeLabel":"Authorize · object | Capture · object | Cancel · object | Refund · object | Confirm · object | Lookup · object | Start payment session · object"},"response":{"oneOf":[{"type":"object","title":"Authorize","description":"Not present in case of error.","required":["name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Triggers the selected payments on PSP.","enum":["authorize"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution","consumerWait","cancel"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.execution","typeLabel":"string | object"},"consumerWait":{"oneOf":[{"type":"string","description":"URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.consumerWait.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.consumerWait.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.consumerWait.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.consumerWait.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.consumerWait","typeLabel":"string | object"},"cancel":{"oneOf":[{"type":"string","description":"URL to cancel the current execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.cancel.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to cancel the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.cancel.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.cancel.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.cancel.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.cancel","typeLabel":"string | object"},"capture":{"oneOf":[{"type":"string","description":"URL to capture the current execution.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.capture.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to capture the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.capture.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.capture.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.capture.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.capture","typeLabel":"string | object"},"refund":{"oneOf":[{"type":"string","description":"URL to refund the current execution.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.refund.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to refund the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.refund.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.refund.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.refund.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links.refund","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.links","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0.workspaceId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.0","typeLabel":"Authorize · object"},{"type":"object","title":"Capture","description":"Not present in case of error.","required":["name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Triggers the selected payments on PSP.","enum":["capture"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution","refund"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.execution","typeLabel":"string | object"},"refund":{"oneOf":[{"type":"string","description":"URL to refund the current execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.refund.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to refund the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.refund.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.refund.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.refund.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links.refund","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.links","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.workspaceId","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"An optional field to include any necessary information for the capture action.","example":"Monthly subscription.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1.reasonDescription","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.1","typeLabel":"Capture · object"},{"type":"object","title":"Cancel","description":"Not present in case of error.","required":["name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Performed action name.","enum":["cancel"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links.execution","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.links","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.workspaceId","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"An optional field to include any necessary information for the cancel action.","example":"Customer's order expired.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2.reasonDescription","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.2","typeLabel":"Cancel · object"},{"type":"object","title":"Refund","description":"Not present in case of error.","required":["name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Performed action name.","enum":["refund"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links.execution","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.links","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.workspaceId","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"An optional field to include any necessary information for the refund action.","example":"Accidentally charged the customer twice.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3.reasonDescription","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.3","typeLabel":"Refund · object"},{"type":"object","title":"Confirm","description":"Not present in case of error.","required":["name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Confirms the selected payments on PSP.","enum":["confirm"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution","consumerWait","cancel"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.execution","typeLabel":"string | object"},"consumerWait":{"oneOf":[{"type":"string","description":"URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.consumerWait.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.consumerWait.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.consumerWait.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.consumerWait.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.consumerWait","typeLabel":"string | object"},"cancel":{"oneOf":[{"type":"string","description":"URL to cancel the current execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.cancel.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to cancel the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.cancel.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.cancel.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.cancel.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.cancel","typeLabel":"string | object"},"capture":{"oneOf":[{"type":"string","description":"URL to capture the current execution.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.capture.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to capture the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.capture.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.capture.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.capture.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.capture","typeLabel":"string | object"},"refund":{"oneOf":[{"type":"string","description":"URL to refund the current execution.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.refund.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to refund the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.refund.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.refund.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.refund.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links.refund","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.links","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4.workspaceId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.4","typeLabel":"Confirm · object"},{"type":"object","title":"Lookup","description":"Not present in case of error.","required":["data","name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Lookup the available payment methods and instruments.","enum":["lookup"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.execution","typeLabel":"string | object"},"authorize":{"oneOf":[{"type":"string","description":"URL to authorize the current execution.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.authorize.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to authorize the current execution.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.authorize.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.authorize.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.authorize.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.authorize","typeLabel":"string | object"},"startPaymentSession":{"oneOf":[{"type":"string","description":"URL to start a payment session.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.startPaymentSession.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to start a payment session.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.startPaymentSession.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.startPaymentSession.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.startPaymentSession.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links.startPaymentSession","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.links","typeLabel":"object"},"data":{"type":"object","description":"Lookup action results.","required":["paymentCompositionOptions"],"properties":{"paymentCompositionOptions":{"type":"array","description":"List of Payment Methods and Payment Instruments that can be used to complete the execution.","items":{"type":"object","required":["integrationType","description"],"properties":{"integrationType":{"type":"string","enum":["api","hpp","inperson"],"description":"Code of the integration type for using the payment method in the provider.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].integrationType","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Description of the Payment Method.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].description","typeLabel":"string"},"paymentMethodCode":{"type":"string","enum":["alexBankMa7fazty","amazonPay","applePay","audi2pay","alfa","alipay","bankTransfer","card","2c2p","capitecPay","cibSmartWallet","easypaisa","etisalatCash","fawryMobileWallet","fawryPay","googlePay","jazzCash","mercadoPago","monoDirectDebit","nbePhoneCash","orangeCash","oPayWallet","pagaWallet","payflex","payjustnow","payPal","pix","konnect","qnbEWallet","wafaCashWallet","weCash","genericRedirect","eftPro","upi","upiDirect","cashFreeWallet","paytmMWallet","netBanking","meezaWallet","vodafoneCash","alipayQRCode","sepaDirectDebit","sepaDirectDebitDirect","dcb","bankAccount","modo","ach","payzoneCash","revolutPay","lean","tabby","boleto","oxxo","spei","promptPay","qris","momoVN","vietQR","konbini","touchNGo","gCash","maya","pse","pagoEfectivo","napas","duitNowQR","grabPay","shopeePay","nequi","picPay","ovo","trueMoney","iDeal","iDealDirect","bancontact","mbWay","mbWayDirect","khipu","razerGold","webPay","smartPix","venmo","klarnaPayLater","klarnaPayNow","klarnaPayOverTime","knet","scalapay","bizum","payNow","atome","fpx","swish","bcp","kiosk"],"description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentMethodCode","typeLabel":"enum\u003cstring>"},"providerCode":{"type":"string","description":"Provider code for which the payment composition option is available.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].providerCode","typeLabel":"string"},"providerData":{"type":"object","additionalProperties":true,"description":"Provider-specific data needed by to use the payment method for a payment.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].providerData","typeLabel":"object"},"paymentInstruments":{"type":"array","description":"List of stored Payment Instruments for this Method that belong to the specified holder. By default, only includes the ones with status `Created` or `Enabled`.","items":{"type":"object","required":["id","holderId","paymentMethod","status","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Id of the instrument.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the Instrument was created in Payrails.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the Instrument was last updated.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].holderId","typeLabel":"string\u003cuuid>"},"paymentMethod":{"type":"string","description":"Represents the payment method type.","enum":["alexBankMa7fazty","applePay","audi2pay","bankAccount","card","2c2p","vietQR","cibSmartWallet","easypaisa","etisalatCash","fawryMobileWallet","fawryPay","googlePay","jazzCash","nbePhoneCash","orangeCash","payPal","qnbEWallet","weCash","genericRedirect","alfa","konnect","eftPro","netBanking","upi","upiDirect","cashFreeWallet","paytmWallet","phonePe","iDeal","iDealDirect","bancontact","mbWay","mbWayDirect","sepaDirectDebit","sepaDirectDebitDirect","klarnaPayLater","klarnaPayNow","klarnaPayOverTime","scalapay","payNow","atome","fpx","swish"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].paymentMethod","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of the instrument.","enum":["created","deleted","enabled","disabled","transient"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Instrument name suitable for display.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].displayName","typeLabel":"string"},"description":{"type":"string","description":"Description of the instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].description","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","description":"True if this instrument is set as default for the holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True if this instrument is set as default for the holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].default.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].default","typeLabel":"boolean | null"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].merchantReference","typeLabel":"string"},"fingerprint":{"type":"string","description":"System-wide unique identifier of the Instrument. If two Holders have the same instrument stored, this value will be the same for both, but the instrument and token IDs will be different. Cannot be used for payments, should only be used for analytics and fraud prevention.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].fingerprint","typeLabel":"string"},"futureUsage":{"type":"string","description":"Represents the future usage to define the payment flows that the stored instrument will be used for.","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].futureUsage","typeLabel":"enum\u003cstring>"},"networkTransactionReference":{"type":"string","description":"Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].networkTransactionReference","typeLabel":"string"},"transactionLinkId":{"type":"string","description":"Mastercard Transaction Link Identifier (TLID) of the transaction series this instrument belongs to. Returned by the card network on the initial cardholder-initiated transaction and required on economically related merchant-initiated transactions, such as recurring payments and installments, when the series spans payment providers.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].transactionLinkId","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"Card","description":"Type-specific information about the instrument.","required":["network","bin","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.network","typeLabel":"enum\u003cstring>"},"bin":{"type":"string","minLength":6,"maxLength":8,"description":"First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).","example":"416598","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.bin","typeLabel":"string"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.suffix","typeLabel":"string"},"preferredScheme":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.preferredScheme","typeLabel":"enum\u003cstring>"},"binLookup":{"description":"Information about an issuer by the given BIN (or IIN).","type":"object","required":["bin"],"properties":{"bin":{"type":"string","minLength":6,"maxLength":8,"description":"First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).","example":"416598","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.bin","typeLabel":"string"},"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.billingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.expiryYear","typeLabel":"string"},"holderName":{"type":"string","description":"Name of the owner of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.holderName","typeLabel":"string"},"taxId":{"type":"string","description":"Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0.taxId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.0","typeLabel":"Card · object"},{"type":"object","title":"BankAccount","description":"Type-specific information about the instrument.","properties":{"holder":{"type":"object","description":"The data structure for a holder's personal information.","properties":{"firstName":{"type":"string","description":"The first name of the account holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"The last name of the account holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.lastName","typeLabel":"string"},"companyName":{"type":"string","description":"The company name for business holders.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.companyName","typeLabel":"string"},"address":{"description":"The address of the account holder.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.address","typeLabel":"object"},"email":{"type":"string","format":"email","description":"The email address of the account holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.email","typeLabel":"string\u003cemail>"},"dob":{"type":"string","format":"date","description":"The date of birth of the account holder (YYYY-MM-DD).","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.dob","typeLabel":"string\u003cdate>"},"country":{"description":"The country of the account holder.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.country","typeLabel":"object"},"city":{"type":"string","description":"The city of the account holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.city","typeLabel":"string"},"type":{"type":"string","enum":["individual","corporate"],"description":"The type of account holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.holder","typeLabel":"object"},"bank":{"type":"object","description":"The data structure for a bank's information.","properties":{"name":{"type":"string","description":"The name of the bank.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.name","typeLabel":"string"},"branchCode":{"type":"string","description":"The branch code of the bank.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.branchCode","typeLabel":"string"},"code":{"type":"string","description":"The bank code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.code","typeLabel":"string"},"address":{"description":"The address of the bank.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.address","typeLabel":"object"},"swiftCode":{"type":"string","description":"The SWIFT/BIC code of the bank.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank.swiftCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.bank","typeLabel":"object"},"account":{"type":"object","description":"The data structure for an account's information.","properties":{"number":{"type":"string","description":"The bank account number.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.number","typeLabel":"string"},"iban":{"type":"string","description":"The International Bank Account Number (IBAN).","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.iban","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"USD","description":"ISO 3-letter currency code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.currency","typeLabel":"string"},"country":{"description":"The country of the account.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.country","typeLabel":"object"},"type":{"type":"string","enum":["savings","current"],"description":"The type of bank account.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1.account","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.1","typeLabel":"BankAccount · object"},{"type":"object","title":"PayPal","description":"Type-specific information about the instrument.","properties":{"email":{"type":"string","description":"Email of the PayPal account.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.email","typeLabel":"string"},"payerId":{"type":"string","description":"ID of the PayPal payer account.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.payerId","typeLabel":"string"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2.billingAddress","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.2","typeLabel":"PayPal · object"},{"type":"object","title":"GooglePay","description":"Type-specific information about the instrument.","required":["network","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.network","typeLabel":"enum\u003cstring>"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.networkDisplayName","typeLabel":"string"},"binLookup":{"description":"Information about an issuer.","type":"object","properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.billingAddress","typeLabel":"object"},"shippingAddress":{"description":"Shipping Address provided by the wallet.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.expiryYear","typeLabel":"string"},"paymentToken":{"type":"string","description":"One-time payment token sent by client-side for execution of payment on backend.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.paymentToken","typeLabel":"string"},"eci":{"type":"string","description":"Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.eci","typeLabel":"string"},"cardHolderAuthenticated":{"type":"boolean","description":"Indicates that identification and verifications (ID\u0026V) was performed on the returned payment credential.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.cardHolderAuthenticated","typeLabel":"boolean"},"googleMessageId":{"type":"string","description":"Unique identifier for the Google Pay message.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.googleMessageId","typeLabel":"string"},"googleMessageExpirationId":{"type":"string","description":"Expiration time for the Google Pay message.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3.googleMessageExpirationId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.3","typeLabel":"GooglePay · object"},{"type":"object","title":"ApplePay","description":"Type-specific information about the instrument.","required":["network","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.network","typeLabel":"enum\u003cstring>"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.networkDisplayName","typeLabel":"string"},"binLookup":{"description":"Information about an issuer.","type":"object","properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["unspecified","visa","visadankort","mastercard","amex","diners","discover","unionpay","unionpayuzcard","maestro","maestrobancontact","hipercard","jcb","jcblankapay","argencard","aura","belkart","bpfuelcard","cabal","carnet","cirrus","chjonesfuelcard","uzcard","codensa","dankort","dinacard","duet","ebt","eftpos","elo","euroshellfuelcard","gecapital","bc","hrgstore","humo","lankapay","lukoilfuelcard","bancontact","meeza","newday","mir","ourocard","pagobancomat","paypak","paypal","phhfuelcard","prostir","rupay","sbercard","sodexo","starrewards","cencosud","naranja","troy","uatp","ukfuelcard","verve","voyager","vpay","wex","cmi","atm","bankcard","localbrand","loyalty","privatelabel","fuelcard","redfuelcard","redliquidfuelcard"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.\n","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.billingAddress","typeLabel":"object"},"shippingAddress":{"description":"Shipping Address provided by the wallet.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.expiryYear","typeLabel":"string"},"paymentToken":{"type":"string","description":"One-time payment token sent by client-side for execution of payment on backend.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.paymentToken","typeLabel":"string"},"eci":{"type":"string","description":"Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.eci","typeLabel":"string"},"cardHolderAuthenticated":{"type":"boolean","description":"Indicates that identification and verifications (ID\u0026V) was performed on the returned payment credential.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4.cardHolderAuthenticated","typeLabel":"boolean"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.4","typeLabel":"ApplePay · object"},{"type":"object","title":"DCB","description":"Type-specific information about the instrument.","properties":{"msisdn":{"type":"string","description":"Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.msisdn","typeLabel":"string"},"msisdnTail":{"type":"string","description":"Last 4 digits of the mobile number of the holder.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.msisdnTail","typeLabel":"string"},"country":{"description":"Country of the holder.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.country.name","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.country","typeLabel":"object"},"carrierNetwork":{"type":"string","description":"Carrier network of the msisdn.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5.carrierNetwork","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.5","typeLabel":"DCB · object"},{"type":"object","title":"MBWayDirect","description":"Type-specific information about the instrument.","properties":{"phone":{"type":"object","description":"Mobile number the payer confirms MB WAY payments with.","properties":{"countryCode":{"type":"string","description":"International dialling code, digits only.","example":"351","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.6.phone.countryCode","typeLabel":"string"},"number":{"type":"string","description":"National number, digits only.","example":"912345678","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.6.phone.number","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.6.phone","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data.oneOf.6","typeLabel":"MBWayDirect · object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].data","typeLabel":"Card · object | BankAccount · object | PayPal · object | GooglePay · object | ApplePay · object | DCB · object | MBWayDirect · object"},"tokens":{"description":"List of tokens inside the instrument. Not included by default, `includeTokens` query parameter must be used.","type":"array","items":{"type":"object","required":["id","instrumentId","providerId","reference","status","type","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Id of the token in Payrails.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the Token was created in Payrails.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the Token was last updated.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"instrumentId":{"type":"string","format":"uuid","description":"Id of the payment instrument the token belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].instrumentId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Status of the token.","enum":["created","enabled","disabled","deleted"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Type of the token.","enum":["network","vault","psp","networkOffers","networkGateway"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"providerId":{"type":"string","format":"uuid","description":"Id of the provider the token belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].providerId","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Unique identifier of the token in the provider's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].reference","typeLabel":"string"},"providerConfigId":{"type":"string","format":"uuid","description":"Id of the configuration in the provider the token belongs to.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].providerConfigId","typeLabel":"string\u003cuuid>"},"meta":{"description":"Any merchant or provider-specific data that should be stored for context in the token.","type":"object","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX].tokens","typeLabel":"object[]"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].paymentInstruments","typeLabel":"object[]"},"clientConfig":{"type":"object","description":"Contains information related to the payment method and integration type.","properties":{"displayName":{"type":"string","description":"The payment method name.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.displayName","typeLabel":"string"},"supportsSaveInstrument":{"type":"boolean","description":"Returns true if the payment method supports storing a payment instrument.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.supportsSaveInstrument","typeLabel":"boolean"},"supportsBillingInfo":{"type":"boolean","description":"Returns true if the merchant wants to collect billing information during checkout and if this information is supported by the payment methods.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.supportsBillingInfo","typeLabel":"boolean"},"flow":{"type":"string","description":"Enum with values direct and redirect, direct is set only when a payment method does not require redirecting the end user to a provider page to proceed with authorization.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.flow","typeLabel":"string"},"additionalConfig":{"type":"object","description":"Specific configuration needed for the payment method.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.additionalConfig","typeLabel":"object"},"instrumentDataSchema":{"type":"object","description":"Schema for the payment method.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.instrumentDataSchema","typeLabel":"object"},"supportsInstallments":{"type":"boolean","description":"Returns true if the payment method supports paying in installments.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.supportsInstallments","typeLabel":"boolean"},"installments":{"type":"object","description":"Installment plans keyed by ISO 3166-1 alpha-2 country. Empty when no plans are available for this card and amount.","additionalProperties":{"type":"array","items":{"type":"object","description":"Installment plan offered for the card and amount. Statically configured providers return only `count` and `amount`.","required":["count","amount"],"properties":{"count":{"type":"integer","description":"Number of installments. Sent back as `installments.count` at authorize.","example":6,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].count","typeLabel":"integer"},"amount":{"type":"number","description":"Amount paid per installment.","example":20,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].amount","typeLabel":"number"},"totalAmount":{"type":"number","description":"Total paid across all installments, including financing cost. May exceed the transaction amount.","example":120,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].totalAmount","typeLabel":"number"},"displayMessage":{"type":"string","description":"Ready-to-render description of the plan. Always present for live plans.","example":"6 cuotas de S/ 20.000,00 (S/ 120.000,00)","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].displayMessage","typeLabel":"string"},"installmentRate":{"type":"number","description":"Financing rate as a percentage. `0` is a genuine interest-free offer; absent means no rate was supplied.","example":32.14,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].installmentRate","typeLabel":"number"},"discountRate":{"type":"number","description":"Discount as a percentage. Absent and `0` differ, as for `installmentRate`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].discountRate","typeLabel":"number"},"recommended":{"type":"boolean","description":"Marks the plan the provider suggests emphasising.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].recommended","typeLabel":"boolean"},"totalAmountIsEstimate":{"type":"boolean","description":"The card issuer applies the financing cost, so `totalAmount` is indicative.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].totalAmountIsEstimate","typeLabel":"boolean"},"disclosures":{"type":"array","description":"Financing rates a market requires be displayed, e.g. CFT and TEA. Values keep the provider's formatting.","items":{"type":"object","required":["code","value"],"properties":{"code":{"type":"string","description":"Name of the rate.","example":"CFT","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].disclosures.items.[INDEX].code","typeLabel":"string"},"value":{"type":"string","description":"Rate as the provider expressed it.","example":"169,00%","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].disclosures.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].disclosures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].disclosures","typeLabel":"object[]"},"requires":{"type":"array","description":"Conditions the plan imposes beyond the normal card flow. Ignore unrecognised values and hide the plan.","items":{"type":"string","enum":["threeDSecure","cardVerificationCode"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].requires.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].requires","typeLabel":"enum\u003cstring>[]"},"planReference":{"type":"string","description":"Opaque plan handle. Echo it back at authorize when present; never parse or display it.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX].planReference","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments.additionalProperties","typeLabel":"object[]"},"example":{"BR":[{"count":2,"amount":60},{"count":6,"amount":20}]},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig.installments","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX].clientConfig","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data.paymentCompositionOptions","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.data","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5.workspaceId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.5","typeLabel":"Lookup · object"},{"type":"object","title":"Start payment session","description":"Not present in case of error.","required":["data","name","actionId","executedAt","links"],"properties":{"name":{"type":"string","description":"Starts a payment session on a specific Provider.","enum":["startPaymentSession"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.name","typeLabel":"enum\u003cstring>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.actionId","typeLabel":"string\u003cuuid>"},"executedAt":{"type":"string","format":"date-time","description":"Date and time when execution of the Action was started.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.executedAt","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","description":"Links to the next possible actions that can be taken.","required":["execution"],"properties":{"execution":{"oneOf":[{"type":"string","description":"URL to fetch the current execution state.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links.execution.oneOf.0","typeLabel":"string"},{"type":"object","description":"URL to fetch the current execution state.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links.execution.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links.execution.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links.execution.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links.execution","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.links","typeLabel":"object"},"data":{"type":"object","description":"Provider-specific data needed to continue the payment session.","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.data","typeLabel":"object"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of a workspace in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6.workspaceId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.6","typeLabel":"Start payment session · object"},{"type":"object","title":"Errors","description":"Not present in case of error.","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response.oneOf.7","typeLabel":"Errors · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1.response","typeLabel":"Authorize · object | Capture · object | Cancel · object | Refund · object | Confirm · object | Lookup · object | Start payment session · object | Errors · object"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","uniqueKey":"events.items.[INDEX].details.oneOf.1.actionId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.1","typeLabel":"executionActionRequested · object"},{"type":"object","title":"executionActionCompleted","description":"Execution action completed.","required":["execution","action","success"],"properties":{"action":{"type":"string","description":"The type of completed action.","enum":["authorize","payout","confirm","capture","cancel","refund","dispute"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.action","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","description":"The Workflow execution for which action was completed.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.2.execution.holderId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.execution","typeLabel":"object"},"success":{"type":"boolean","description":"Action outcome. If `true`, then the action was finished successfully, and `false` otherwise.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.success","typeLabel":"boolean"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.2.actionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.amount.currency","typeLabel":"string"}},"description":"The total amount used during execution of the action.","uniqueKey":"events.items.[INDEX].details.oneOf.2.amount","typeLabel":"object"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.2.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"Reason description specified when the action was initiated.","example":"Customer's order expired.","uniqueKey":"events.items.[INDEX].details.oneOf.2.reasonDescription","typeLabel":"string"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.2.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.2.errors","typeLabel":"object[]"},"paymentComposition":{"type":"array","description":"List of Payment Methods that were affected by the action. See [PaymentComposition](/reference/paymentcomposition) for every field.","items":{"type":"object","description":"See [PaymentComposition](/reference/paymentcomposition) for every field.","properties":{"operationType":{"type":"string","description":"Operation Type that was executed in the Provider.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].operationType","typeLabel":"string"},"integrationType":{"type":"string","description":"Code of the integration type for using the payment method in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on payout.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"amount":{"type":"object","description":"The amount used to execute the operation. See [PaymentComposition.amount](/reference/paymentcomposition#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].amount","typeLabel":"object"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].providerId","typeLabel":"string"},"provider":{"type":"object","description":"Provider used to execute the operation. See [PaymentComposition.provider](/reference/paymentcomposition#schema-provider) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].provider","typeLabel":"object"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [PaymentComposition.errors](/reference/paymentcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].errors","typeLabel":"array"},"accountFundingTransaction":{"type":"boolean","description":"Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].accountFundingTransaction","typeLabel":"boolean"},"authorizationCode":{"type":"string","description":"The acquirer authorization code if the payment was authorized.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].authorizationCode","typeLabel":"string"},"acquirerMID":{"type":"string","description":"Merchant Identifier (MID) on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].acquirerMID","typeLabel":"string"},"acquirerAccountCode":{"type":"string","description":"Account Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].acquirerAccountCode","typeLabel":"string"},"acquirerCountryCode":{"type":"string","description":"Country Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].acquirerCountryCode","typeLabel":"string"},"avsResultCode":{"type":"string","description":"Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `Y`: address and postal code both match.\n- `A`: address matches, postal code does not.\n- `Z`: postal code matches, address does not.\n- `N`: neither address nor postal code match.\n- `U`: the issuer could not perform the check.\n","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].avsResultCode","typeLabel":"string"},"cvvResultCode":{"type":"string","description":"Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `M`: security code matched.\n- `N`: security code did not match.\n- `U`: the issuer could not perform the check.\n- `P`: the check was expected but not processed.\n","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].cvvResultCode","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].acquirerReference","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].providerReference","typeLabel":"string"},"retrievalReference":{"type":"string","description":"Retrieval Reference Number (RRN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].retrievalReference","typeLabel":"string"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens used to execute the authorize operation. See [PaymentComposition.paymentInstrument](/reference/paymentcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].paymentInstrument","typeLabel":"object"},"providerResponseAdditionalFields":{"type":"object","description":"Any provider-specific response data requested by merchant on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].providerResponseAdditionalFields","typeLabel":"object"},"providerConfig":{"type":"object","description":"Provider configuration details associated with this operation. See [PaymentComposition.providerConfig](/reference/paymentcomposition#schema-provider-config) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].providerConfig","typeLabel":"object"},"dispute":{"type":"object","description":"Dispute related to the Workflow execution. See [PaymentComposition.dispute](/reference/paymentcomposition#schema-dispute) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].dispute","typeLabel":"object"},"retries":{"type":"object","description":"Information about an action retry. Present if the action failed, and a retry is scheduled. See [PaymentComposition.retries](/reference/paymentcomposition#schema-retries) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].retries","typeLabel":"object"},"captureMode":{"type":"string","description":"Capture mode used for the payment operation.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].captureMode","typeLabel":"string"},"paymentId":{"type":"string","description":"Unique identifier of the Payment affected during execution of the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX].paymentId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.2.paymentComposition","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.2","typeLabel":"executionActionCompleted · object"},{"type":"object","title":"executionActionCompleted","description":"Execution action completed.","required":["execution","action","success"],"properties":{"action":{"type":"string","description":"The type of completed action.","enum":["authorize","payout","confirm","capture","cancel","refund","dispute"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.action","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","description":"The Workflow execution for which action was completed.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.3.execution.holderId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.execution","typeLabel":"object"},"success":{"type":"boolean","description":"Action outcome. If `true`, then the action was finished successfully, and `false` otherwise.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.success","typeLabel":"boolean"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.3.actionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.amount.currency","typeLabel":"string"}},"description":"The total amount used during execution of the action.","uniqueKey":"events.items.[INDEX].details.oneOf.3.amount","typeLabel":"object"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.3.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"Reason description specified when the action was initiated.","example":"Customer's order expired.","uniqueKey":"events.items.[INDEX].details.oneOf.3.reasonDescription","typeLabel":"string"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.3.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.3.errors","typeLabel":"object[]"},"payoutComposition":{"type":"array","description":"List of Payout Methods that were affected by the action. See [PayoutComposition](/reference/payoutcomposition) for every field.","items":{"type":"object","description":"See [PayoutComposition](/reference/payoutcomposition) for every field.","properties":{"operationType":{"type":"string","description":"Operation Type that was executed in the Provider.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].operationType","typeLabel":"string"},"integrationType":{"type":"string","description":"Code of the integration type for using the payment method in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on payout.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"amount":{"type":"object","description":"The amount used to execute the operation. See [PayoutComposition.amount](/reference/payoutcomposition#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].amount","typeLabel":"object"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].providerId","typeLabel":"string"},"provider":{"type":"object","description":"Provider used to execute the operation. See [PayoutComposition.provider](/reference/payoutcomposition#schema-provider) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].provider","typeLabel":"object"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [PayoutComposition.errors](/reference/payoutcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].errors","typeLabel":"array"},"accountFundingTransaction":{"type":"boolean","description":"Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].accountFundingTransaction","typeLabel":"boolean"},"authorizationCode":{"type":"string","description":"The acquirer authorization code if the payment was authorized.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].authorizationCode","typeLabel":"string"},"acquirerMID":{"type":"string","description":"Merchant Identifier (MID) on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].acquirerMID","typeLabel":"string"},"acquirerAccountCode":{"type":"string","description":"Account Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].acquirerAccountCode","typeLabel":"string"},"acquirerCountryCode":{"type":"string","description":"Country Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].acquirerCountryCode","typeLabel":"string"},"avsResultCode":{"type":"string","description":"Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `Y`: address and postal code both match.\n- `A`: address matches, postal code does not.\n- `Z`: postal code matches, address does not.\n- `N`: neither address nor postal code match.\n- `U`: the issuer could not perform the check.\n","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].avsResultCode","typeLabel":"string"},"cvvResultCode":{"type":"string","description":"Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `M`: security code matched.\n- `N`: security code did not match.\n- `U`: the issuer could not perform the check.\n- `P`: the check was expected but not processed.\n","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].cvvResultCode","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].acquirerReference","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].providerReference","typeLabel":"string"},"retrievalReference":{"type":"string","description":"Retrieval Reference Number (RRN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].retrievalReference","typeLabel":"string"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens used to execute the authorize operation. See [PayoutComposition.paymentInstrument](/reference/payoutcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].paymentInstrument","typeLabel":"object"},"providerResponseAdditionalFields":{"type":"object","description":"Any provider-specific response data requested by merchant on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].providerResponseAdditionalFields","typeLabel":"object"},"providerConfig":{"type":"object","description":"Provider configuration details associated with this operation. See [PayoutComposition.providerConfig](/reference/payoutcomposition#schema-provider-config) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].providerConfig","typeLabel":"object"},"dispute":{"type":"object","description":"Dispute related to the Workflow execution. See [PayoutComposition.dispute](/reference/payoutcomposition#schema-dispute) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].dispute","typeLabel":"object"},"retries":{"type":"object","description":"Information about an action retry. Present if the action failed, and a retry is scheduled. See [PayoutComposition.retries](/reference/payoutcomposition#schema-retries) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].retries","typeLabel":"object"},"captureMode":{"type":"string","description":"Capture mode used for the payment operation.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].captureMode","typeLabel":"string"},"payoutId":{"type":"string","description":"Unique identifier of the Payout affected during execution of the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX].payoutId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.3.payoutComposition","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.3","typeLabel":"executionActionCompleted · object"},{"type":"object","title":"ruleEngineExecuted","description":"Details for a ruleEngineExecuted event.","required":["action","context"],"properties":{"action":{"type":"string","enum":["determinePaymentOptions","determineProviderOptions","repeat"],"description":"Action name.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.action","typeLabel":"enum\u003cstring>"},"context":{"type":"object","title":"Execution context","description":"The execution context used to execute the rule engine.","properties":{"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.context.meta","typeLabel":"object"},"dynamic":{"type":"object","description":"Additional computed metadata.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.context.dynamic","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.context","typeLabel":"Execution context · object"},"rulesets":{"type":"array","description":"The rulesets that were executed.","items":{"type":"object","title":"Ruleset","required":["id","version","workspaceId","trigger","defaultAction"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of Ruleset.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"version":{"type":"number","description":"Ruleset version.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].version","typeLabel":"number"},"trigger":{"type":"object","description":"An action that determines when the rules should be evaluated.","required":["on"],"properties":{"on":{"type":"string","enum":["determinePaymentOptions","determineProviderOptions","repeat"],"description":"Action name.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.on","typeLabel":"enum\u003cstring>"},"filter":{"oneOf":[{"type":"object","title":"Action `determinePaymentOptions` filter","description":"A map of fields from the execution context and their expected values, which allows to trigger rules evaluation when all context field values match the expected ones.","properties":{"paymentMethodCode":{"type":"string","enum":["alexBankMa7fazty","amazonPay","applePay","audi2pay","alfa","alipay","bankTransfer","card","2c2p","capitecPay","cibSmartWallet","easypaisa","etisalatCash","fawryMobileWallet","fawryPay","googlePay","jazzCash","mercadoPago","monoDirectDebit","nbePhoneCash","orangeCash","oPayWallet","pagaWallet","payflex","payjustnow","payPal","pix","konnect","qnbEWallet","wafaCashWallet","weCash","genericRedirect","eftPro","upi","upiDirect","cashFreeWallet","paytmMWallet","netBanking","meezaWallet","vodafoneCash","alipayQRCode","sepaDirectDebit","sepaDirectDebitDirect","dcb","bankAccount","modo","ach","payzoneCash","revolutPay","lean","tabby","boleto","oxxo","spei","promptPay","qris","momoVN","vietQR","konbini","touchNGo","gCash","maya","pse","pagoEfectivo","napas","duitNowQR","grabPay","shopeePay","nequi","picPay","ovo","trueMoney","iDeal","iDealDirect","bancontact","mbWay","mbWayDirect","khipu","razerGold","webPay","smartPix","venmo","klarnaPayLater","klarnaPayNow","klarnaPayOverTime","knet","scalapay","bizum","payNow","atome","fpx","swish","bcp","kiosk"],"description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.0.paymentMethodCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.0","typeLabel":"Action `determinePaymentOptions` filter · object"},{"type":"object","title":"Action `determineProviderOptions` filter","description":"A map of fields from the execution context and their expected values, which allows to trigger rules evaluation when all context field values match the expected ones.","properties":{"workflowNode":{"type":"string","enum":["authorize","startPaymentSession"],"description":"Workflow node.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.1.workflowNode","typeLabel":"enum\u003cstring>"},"providerConfigId":{"type":"string","format":"uuid","description":"Unique identifier of the provider config.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.1.providerConfigId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.1","typeLabel":"Action `determineProviderOptions` filter · object"},{"type":"object","title":"Action `repeat` filter","description":"A map of fields from the execution context and their expected values, which allows to trigger rules evaluation when all context field values match the expected ones.","properties":{"workflowNode":{"type":"string","enum":["authorize"],"description":"Workflow node.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.2.workflowNode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter.oneOf.2","typeLabel":"Action `repeat` filter · object"}],"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger.filter","typeLabel":"Action `determinePaymentOptions` filter · object | Action `determineProviderOptions` filter · object | Action `repeat` filter · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].trigger","typeLabel":"object"},"defaultAction":{"oneOf":[{"type":"object","title":"Set capture mode","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the capture mode.","enum":["setCaptureMode"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.0.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","description":"Capture mode to define if money is captured instantly, with delay or manually.","enum":["Instant","Delayed","Manual"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.0.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.0.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.0","typeLabel":"Set capture mode · object"},{"type":"object","title":"Set cancel mode","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the cancel mode.","enum":["setCancelMode"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.1.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","description":"Cancel mode to define if authorization is canceled manually or with delay.","enum":["Delayed","Manual"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.1.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.1.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.1","typeLabel":"Set cancel mode · object"},{"type":"object","title":"Set delay","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel).","enum":["setDelay"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.2.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","properties":{"delay":{"type":"string","format":"ISO 8601","description":"Delay.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.2.params.delay","typeLabel":"string\u003cISO 8601>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.2.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.2","typeLabel":"Set delay · object"},{"type":"object","title":"Set priority","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set a priority for a target element (e.g. for a payment method in the payment options).","enum":["setPriority"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.3.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["priority"],"properties":{"priority":{"type":"number","description":"Priority number. Lower number is higher priority.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.3.params.priority","typeLabel":"number"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.3.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.3","typeLabel":"Set priority · object"},{"type":"object","title":"Skip","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type"],"properties":{"type":{"type":"string","description":"Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options).","enum":["skip"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.4","typeLabel":"Skip · object"},{"type":"object","title":"Stop","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type"],"properties":{"type":{"type":"string","description":"Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt).","enum":["stop"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.5","typeLabel":"Stop · object"},{"type":"object","title":"Set instrument future usage","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the future usage.","enum":["setFutureUsage"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.6.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["futureUsage"],"properties":{"futureUsage":{"type":"string","description":"Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules.","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.6.params.futureUsage","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.6.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.6","typeLabel":"Set instrument future usage · object"},{"type":"object","title":"Add next step","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","enum":["addNextStep"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","title":"Add next step parameters","description":"Parameters for adding a next step to the workflow queue.","required":["code"],"properties":{"code":{"type":"string","description":"Code of the next workflow step to execute.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.code","typeLabel":"string"},"mapping":{"type":"array","description":"Mapping allows to add a field to the next workflow step input from the previous step output or set static values.","items":{"type":"object","title":"Field mapping","description":"Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed.","required":["to"],"properties":{"to":{"type":"string","description":"Destination field path in the next step input.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX].to","typeLabel":"string"},"from":{"type":"string","description":"Source field path in the trigger request (optional if using static value).","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX].from","typeLabel":"string"},"value":{"description":"Static value to set in the destination field instead of mapping from source.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX]","typeLabel":"Field mapping · object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params.mapping","typeLabel":"Field mapping · object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7.params","typeLabel":"Add next step parameters · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.7","typeLabel":"Add next step · object"},{"type":"object","title":"Add workflow execution status","description":"Default action to execute if none of rule conditions are fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","enum":["addWorkflowExecutionStatus"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.8.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","title":"Add workflow execution status parameters","description":"Parameters for adding a workflow execution status.","required":["status"],"properties":{"status":{"type":"string","description":"Workflow execution status to add.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.8.params.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.8.params","typeLabel":"Add workflow execution status parameters · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction.oneOf.8","typeLabel":"Add workflow execution status · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].defaultAction","typeLabel":"Set capture mode · object | Set cancel mode · object | Set delay · object | Set priority · object | Skip · object | Stop · object | Set instrument future usage · object | Add next step · object | Add workflow execution status · object"},"createdAt":{"type":"string","format":"date-time","description":"Creation date of the ruleset.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"rules":{"type":"array","description":"Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled.","items":{"type":"object","title":"Rule","required":["condition","action"],"properties":{"condition":{"oneOf":[{"type":"object","title":"Empty condition","description":"A condition that checks whether a field is empty.","required":["field","empty"],"properties":{"field":{"type":"string","description":"An execution context field name.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.0.field","typeLabel":"string"},"empty":{"type":"boolean","description":"Whether the field must be empty (`true`) or not empty (`false`).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.0.empty","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.0","typeLabel":"Empty condition · object"},{"type":"object","title":"Simple condition","description":"A simple condition.","required":["field","operator","value"],"properties":{"field":{"type":"string","description":"An execution context field name.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.field","typeLabel":"string"},"operator":{"type":"string","description":"An operator.","enum":["=",">",">=","\u003c","\u003c=","IN","IS ONE OF","CONTAINS","STARTS WITH","ENDS WITH"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"An expected value of the execution context field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"An expected value of the execution context field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"An expected value of the execution context field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3.items.[INDEX]","typeLabel":"string | number"},"description":"An expected value of the execution context field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3","typeLabel":"(string | number)[]"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value","typeLabel":"string | number | boolean | (string | number)[]"},"referenceField":{"type":"string","description":"Another execution context field name to compare with `field`.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.referenceField","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.1","typeLabel":"Simple condition · object"},{"type":"object","title":"Simple condition","description":"A simple condition.","required":["field","operator","referenceField"],"properties":{"field":{"type":"string","description":"An execution context field name.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.field","typeLabel":"string"},"operator":{"type":"string","description":"An operator.","enum":["=",">",">=","\u003c","\u003c=","IN","IS ONE OF","CONTAINS","STARTS WITH","ENDS WITH"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.operator","typeLabel":"enum\u003cstring>"},"referenceField":{"type":"string","description":"Another execution context field name to compare with `field`.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.referenceField","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"An expected value of the execution context field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"An expected value of the execution context field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"An expected value of the execution context field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3.items.[INDEX]","typeLabel":"string | number"},"description":"An expected value of the execution context field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3","typeLabel":"(string | number)[]"}],"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value","typeLabel":"string | number | boolean | (string | number)[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.2","typeLabel":"Simple condition · object"},{"type":"object","title":"Combination of conditions","description":"A combination of other condition types.","required":["left","operator","right"],"properties":{"left":{"type":"object","description":"A condition, format of which is the same as `condition` field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.3.left","typeLabel":"object"},"operator":{"type":"string","description":"A logical operator to combine 2 conditions.","enum":["AND","OR"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.3.operator","typeLabel":"enum\u003cstring>"},"right":{"type":"object","description":"A condition, format of which is the same as `condition` field.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.3.right","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.3","typeLabel":"Combination of conditions · object"},{"type":"object","title":"Condition negation","description":"A combination of a condition with NOT operator.","required":["operator","right"],"properties":{"operator":{"type":"string","description":"A logical operator to negate a condition.","enum":["NOT"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.4.operator","typeLabel":"enum\u003cstring>"},"condition":{"type":"object","description":"A condition, format of which is the same as `condition` field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.4.condition","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition.oneOf.4","typeLabel":"Condition negation · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].condition","typeLabel":"Empty condition · object · Simple condition · object · Simple condition · object · Combination of conditions · object · Condition negation · object"},"action":{"oneOf":[{"type":"object","title":"Set capture mode","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the capture mode.","enum":["setCaptureMode"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","description":"Capture mode to define if money is captured instantly, with delay or manually.","enum":["Instant","Delayed","Manual"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.0.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.0.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.0","typeLabel":"Set capture mode · object"},{"type":"object","title":"Set cancel mode","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the cancel mode.","enum":["setCancelMode"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","description":"Cancel mode to define if authorization is canceled manually or with delay.","enum":["Delayed","Manual"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.1.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.1.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.1","typeLabel":"Set cancel mode · object"},{"type":"object","title":"Set delay","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel).","enum":["setDelay"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.2.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","properties":{"delay":{"type":"string","format":"ISO 8601","description":"Delay.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.2.params.delay","typeLabel":"string\u003cISO 8601>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.2.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.2","typeLabel":"Set delay · object"},{"type":"object","title":"Set priority","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set a priority for a target element (e.g. for a payment method in the payment options).","enum":["setPriority"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.3.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["priority"],"properties":{"priority":{"type":"number","description":"Priority number. Lower number is higher priority.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.3.params.priority","typeLabel":"number"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.3.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.3","typeLabel":"Set priority · object"},{"type":"object","title":"Skip","description":"Action to execute if the rule condition is fulfilled.","required":["type"],"properties":{"type":{"type":"string","description":"Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options).","enum":["skip"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.4","typeLabel":"Skip · object"},{"type":"object","title":"Stop","description":"Action to execute if the rule condition is fulfilled.","required":["type"],"properties":{"type":{"type":"string","description":"Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt).","enum":["stop"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.5","typeLabel":"Stop · object"},{"type":"object","title":"Set instrument future usage","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","description":"Set the future usage.","enum":["setFutureUsage"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.6.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","required":["futureUsage"],"properties":{"futureUsage":{"type":"string","description":"Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules.","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.6.params.futureUsage","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.6.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.6","typeLabel":"Set instrument future usage · object"},{"type":"object","title":"Add next step","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","enum":["addNextStep"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","title":"Add next step parameters","description":"Parameters for adding a next step to the workflow queue.","required":["code"],"properties":{"code":{"type":"string","description":"Code of the next workflow step to execute.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.code","typeLabel":"string"},"mapping":{"type":"array","description":"Mapping allows to add a field to the next workflow step input from the previous step output or set static values.","items":{"type":"object","title":"Field mapping","description":"Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed.","required":["to"],"properties":{"to":{"type":"string","description":"Destination field path in the next step input.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX].to","typeLabel":"string"},"from":{"type":"string","description":"Source field path in the trigger request (optional if using static value).","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX].from","typeLabel":"string"},"value":{"description":"Static value to set in the destination field instead of mapping from source.","uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX]","typeLabel":"Field mapping · object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping","typeLabel":"Field mapping · object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params","typeLabel":"Add next step parameters · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.7","typeLabel":"Add next step · object"},{"type":"object","title":"Add workflow execution status","description":"Action to execute if the rule condition is fulfilled.","required":["type","params"],"properties":{"type":{"type":"string","enum":["addWorkflowExecutionStatus"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.8.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","title":"Add workflow execution status parameters","description":"Parameters for adding a workflow execution status.","required":["status"],"properties":{"status":{"type":"string","description":"Workflow execution status to add.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.8.params.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.8.params","typeLabel":"Add workflow execution status parameters · object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action.oneOf.8","typeLabel":"Add workflow execution status · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX].action","typeLabel":"Set capture mode · object | Set cancel mode · object | Set delay · object | Set priority · object | Skip · object | Stop · object | Set instrument future usage · object | Add next step · object | Add workflow execution status · object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules.items.[INDEX]","typeLabel":"Rule · object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX].rules","typeLabel":"Rule · object[]"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets.items.[INDEX]","typeLabel":"Ruleset · object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.rulesets","typeLabel":"Ruleset · object[]"},"evaluations":{"type":"array","description":"The evaluations of the rule engine. See [RuleEvaluation](/reference/ruleevaluation) for every field.","items":{"type":"object","description":"See [RuleEvaluation](/reference/ruleevaluation) for every field.","properties":{"chosenRule":{"type":"object","description":"See [RuleEvaluation.chosenRule](/reference/ruleevaluation#schema-chosen-rule) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations.items.[INDEX].chosenRule","typeLabel":"object"},"action":{"type":"object","description":"See [RuleEvaluation.action](/reference/ruleevaluation#schema-action) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations.items.[INDEX].action","typeLabel":"object"},"entity":{"description":"See [RuleEvaluation.entity](/reference/ruleevaluation) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations.items.[INDEX].entity","typeLabel":"any"},"ruleEvaluationResults":{"type":"array","description":"See [RuleEvaluation.ruleEvaluationResults](/reference/ruleevaluation#schema-rule-evaluation-results) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations.items.[INDEX].ruleEvaluationResults","typeLabel":"array"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.evaluations","typeLabel":"object[]"},"errors":{"type":"array","title":"Rule engine errors","description":"Errors that occurred during the execution of the rule engine.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.4.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.4.errors","typeLabel":"Rule engine errors · object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.4","typeLabel":"ruleEngineExecuted · object"},{"type":"object","title":"networkOffersEnrollmentCompleted","description":"Network offers enrollment completed.","required":["execution","success"],"properties":{"execution":{"type":"object","description":"The Workflow execution for which action was completed.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.5.execution.holderId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.execution","typeLabel":"object"},"success":{"type":"boolean","description":"Outcome. If `true`, then the action was finished successfully, and `false` otherwise.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.success","typeLabel":"boolean"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.5.actionId","typeLabel":"string\u003cuuid>"},"paymentComposition":{"type":"array","description":"List of Payment Methods that were affected by the action. See [EnrollmentPaymentComposition](/reference/enrollmentpaymentcomposition) for every field.","items":{"type":"object","description":"See [EnrollmentPaymentComposition](/reference/enrollmentpaymentcomposition) for every field.","properties":{"integrationType":{"type":"string","description":"Integration type used to execute the enrollment.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method used to execute the enrollment in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the enrollment was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the enrollment.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].providerId","typeLabel":"string"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the enrollment.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [EnrollmentPaymentComposition.errors](/reference/enrollmentpaymentcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].errors","typeLabel":"array"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens what was enrolled to network offers. See [EnrollmentPaymentComposition.paymentInstrument](/reference/enrollmentpaymentcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX].paymentInstrument","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.5.paymentComposition","typeLabel":"object[]"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.5.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.5.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.5","typeLabel":"networkOffersEnrollmentCompleted · object"},{"type":"object","title":"executionActionScheduled","description":"Details for an executionActionScheduled event.","required":["action","reason","scheduledAt"],"properties":{"action":{"type":"string","enum":["authorizeRetry"],"description":"Type of action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.6.action","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Reason for scheduling of the action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.6.reason","typeLabel":"string"},"scheduledAt":{"type":"string","format":"date-time","description":"Time for the execution of the action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.6.scheduledAt","typeLabel":"string\u003cdate-time>"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","uniqueKey":"events.items.[INDEX].details.oneOf.6.actionId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.6","typeLabel":"executionActionScheduled · object"},{"type":"object","title":"executionActionUnscheduled","description":"Details for an executionActionUnscheduled event.","required":["action","reason"],"properties":{"action":{"type":"string","enum":["authorizeRetry"],"description":"Type of action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.7.action","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Reason for unscheduling of the action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.7.reason","typeLabel":"string"},"actionId":{"type":"string","format":"uuid","description":"Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`.","uniqueKey":"events.items.[INDEX].details.oneOf.7.actionId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.7","typeLabel":"executionActionUnscheduled · object"},{"type":"object","title":"executionActionUpdated","description":"Execution action updated.","required":["execution","action","success"],"properties":{"action":{"type":"string","description":"The type of updated action.","enum":["authorize","capture","cancel","refund","dispute"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.action","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","description":"The Workflow execution for which action was updated.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.8.execution.holderId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.execution","typeLabel":"object"},"success":{"type":"boolean","description":"Action outcome. If `true`, then the action was finished successfully, and `false` otherwise.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.success","typeLabel":"boolean"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.8.actionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.amount.currency","typeLabel":"string"}},"description":"The total amount used during execution of the action.","uniqueKey":"events.items.[INDEX].details.oneOf.8.amount","typeLabel":"object"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.8.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.8.errors","typeLabel":"object[]"},"paymentComposition":{"type":"array","description":"List of Payment Methods that were affected by the action. See [PaymentComposition](/reference/paymentcomposition) for every field.","items":{"type":"object","description":"See [PaymentComposition](/reference/paymentcomposition) for every field.","properties":{"operationType":{"type":"string","description":"Operation Type that was executed in the Provider.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].operationType","typeLabel":"string"},"integrationType":{"type":"string","description":"Code of the integration type for using the payment method in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on payout.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"amount":{"type":"object","description":"The amount used to execute the operation. See [PaymentComposition.amount](/reference/paymentcomposition#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].amount","typeLabel":"object"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].providerId","typeLabel":"string"},"provider":{"type":"object","description":"Provider used to execute the operation. See [PaymentComposition.provider](/reference/paymentcomposition#schema-provider) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].provider","typeLabel":"object"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [PaymentComposition.errors](/reference/paymentcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].errors","typeLabel":"array"},"accountFundingTransaction":{"type":"boolean","description":"Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].accountFundingTransaction","typeLabel":"boolean"},"authorizationCode":{"type":"string","description":"The acquirer authorization code if the payment was authorized.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].authorizationCode","typeLabel":"string"},"acquirerMID":{"type":"string","description":"Merchant Identifier (MID) on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].acquirerMID","typeLabel":"string"},"acquirerAccountCode":{"type":"string","description":"Account Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].acquirerAccountCode","typeLabel":"string"},"acquirerCountryCode":{"type":"string","description":"Country Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].acquirerCountryCode","typeLabel":"string"},"avsResultCode":{"type":"string","description":"Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `Y`: address and postal code both match.\n- `A`: address matches, postal code does not.\n- `Z`: postal code matches, address does not.\n- `N`: neither address nor postal code match.\n- `U`: the issuer could not perform the check.\n","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].avsResultCode","typeLabel":"string"},"cvvResultCode":{"type":"string","description":"Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `M`: security code matched.\n- `N`: security code did not match.\n- `U`: the issuer could not perform the check.\n- `P`: the check was expected but not processed.\n","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].cvvResultCode","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].acquirerReference","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].providerReference","typeLabel":"string"},"retrievalReference":{"type":"string","description":"Retrieval Reference Number (RRN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].retrievalReference","typeLabel":"string"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens used to execute the authorize operation. See [PaymentComposition.paymentInstrument](/reference/paymentcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].paymentInstrument","typeLabel":"object"},"providerResponseAdditionalFields":{"type":"object","description":"Any provider-specific response data requested by merchant on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].providerResponseAdditionalFields","typeLabel":"object"},"providerConfig":{"type":"object","description":"Provider configuration details associated with this operation. See [PaymentComposition.providerConfig](/reference/paymentcomposition#schema-provider-config) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].providerConfig","typeLabel":"object"},"dispute":{"type":"object","description":"Dispute related to the Workflow execution. See [PaymentComposition.dispute](/reference/paymentcomposition#schema-dispute) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].dispute","typeLabel":"object"},"retries":{"type":"object","description":"Information about an action retry. Present if the action failed, and a retry is scheduled. See [PaymentComposition.retries](/reference/paymentcomposition#schema-retries) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].retries","typeLabel":"object"},"captureMode":{"type":"string","description":"Capture mode used for the payment operation.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].captureMode","typeLabel":"string"},"paymentId":{"type":"string","description":"Unique identifier of the Payment affected during execution of the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX].paymentId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.8.paymentComposition","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.8","typeLabel":"executionActionUpdated · object"},{"type":"object","title":"executionActionUpdated","description":"Execution action updated.","required":["execution","action","success"],"properties":{"action":{"type":"string","description":"The type of updated action.","enum":["authorize","capture","cancel","refund","dispute"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.action","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","description":"The Workflow execution for which action was updated.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.9.execution.holderId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.execution","typeLabel":"object"},"success":{"type":"boolean","description":"Action outcome. If `true`, then the action was finished successfully, and `false` otherwise.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.success","typeLabel":"boolean"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.9.actionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.amount.currency","typeLabel":"string"}},"description":"The total amount used during execution of the action.","uniqueKey":"events.items.[INDEX].details.oneOf.9.amount","typeLabel":"object"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.9.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.9.errors","typeLabel":"object[]"},"payoutComposition":{"type":"array","description":"List of Payout Methods that were affected by the action. See [PayoutComposition](/reference/payoutcomposition) for every field.","items":{"type":"object","description":"See [PayoutComposition](/reference/payoutcomposition) for every field.","properties":{"operationType":{"type":"string","description":"Operation Type that was executed in the Provider.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].operationType","typeLabel":"string"},"integrationType":{"type":"string","description":"Code of the integration type for using the payment method in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on payout.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"amount":{"type":"object","description":"The amount used to execute the operation. See [PayoutComposition.amount](/reference/payoutcomposition#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].amount","typeLabel":"object"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].providerId","typeLabel":"string"},"provider":{"type":"object","description":"Provider used to execute the operation. See [PayoutComposition.provider](/reference/payoutcomposition#schema-provider) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].provider","typeLabel":"object"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [PayoutComposition.errors](/reference/payoutcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].errors","typeLabel":"array"},"accountFundingTransaction":{"type":"boolean","description":"Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].accountFundingTransaction","typeLabel":"boolean"},"authorizationCode":{"type":"string","description":"The acquirer authorization code if the payment was authorized.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].authorizationCode","typeLabel":"string"},"acquirerMID":{"type":"string","description":"Merchant Identifier (MID) on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].acquirerMID","typeLabel":"string"},"acquirerAccountCode":{"type":"string","description":"Account Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].acquirerAccountCode","typeLabel":"string"},"acquirerCountryCode":{"type":"string","description":"Country Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].acquirerCountryCode","typeLabel":"string"},"avsResultCode":{"type":"string","description":"Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `Y`: address and postal code both match.\n- `A`: address matches, postal code does not.\n- `Z`: postal code matches, address does not.\n- `N`: neither address nor postal code match.\n- `U`: the issuer could not perform the check.\n","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].avsResultCode","typeLabel":"string"},"cvvResultCode":{"type":"string","description":"Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `M`: security code matched.\n- `N`: security code did not match.\n- `U`: the issuer could not perform the check.\n- `P`: the check was expected but not processed.\n","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].cvvResultCode","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].acquirerReference","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].providerReference","typeLabel":"string"},"retrievalReference":{"type":"string","description":"Retrieval Reference Number (RRN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].retrievalReference","typeLabel":"string"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens used to execute the authorize operation. See [PayoutComposition.paymentInstrument](/reference/payoutcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].paymentInstrument","typeLabel":"object"},"providerResponseAdditionalFields":{"type":"object","description":"Any provider-specific response data requested by merchant on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].providerResponseAdditionalFields","typeLabel":"object"},"providerConfig":{"type":"object","description":"Provider configuration details associated with this operation. See [PayoutComposition.providerConfig](/reference/payoutcomposition#schema-provider-config) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].providerConfig","typeLabel":"object"},"dispute":{"type":"object","description":"Dispute related to the Workflow execution. See [PayoutComposition.dispute](/reference/payoutcomposition#schema-dispute) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].dispute","typeLabel":"object"},"retries":{"type":"object","description":"Information about an action retry. Present if the action failed, and a retry is scheduled. See [PayoutComposition.retries](/reference/payoutcomposition#schema-retries) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].retries","typeLabel":"object"},"captureMode":{"type":"string","description":"Capture mode used for the payment operation.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].captureMode","typeLabel":"string"},"payoutId":{"type":"string","description":"Unique identifier of the Payout affected during execution of the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX].payoutId","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.9.payoutComposition","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.9","typeLabel":"executionActionUpdated · object"},{"type":"object","title":"executionActionPending","description":"Execution action pending.","required":["execution","action"],"properties":{"action":{"type":"string","description":"The type of pending action.","enum":["authorize","confirm","capture","cancel","refund"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.action","typeLabel":"enum\u003cstring>"},"execution":{"type":"object","description":"The Workflow execution for which action is pending.","required":["workflowCode","id","merchantReference","holderReference","meta"],"properties":{"workflowCode":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.workflowCode","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"ID of Workflow execution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.id","typeLabel":"string\u003cuuid>"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.merchantReference","typeLabel":"string"},"holderReference":{"type":"string","description":"Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.holderReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta.upi","typeLabel":"any"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.meta","typeLabel":"object"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.holderId","typeLabel":"string\u003cuuid>"},"requiredAction":{"type":"object","description":"Details of the next possible actions that can be taken.","required":["type"],"properties":{"type":{"type":"string","enum":["redirect","confirm","review","wait"],"description":"Type of the required action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["merchant","client","internal"],"description":"Sub type of the required action.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.subType","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Details of the required action.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.description","typeLabel":"string"},"href":{"type":"string","description":"URL to complete the required action.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.method","typeLabel":"enum\u003cstring>"},"clientConfig":{"type":"object","description":"Details for the client to indicate how an action needs to be performed.","properties":{"renderMode":{"type":"string","enum":["hidden"],"description":"Indicates the visibility of the action when being performed on the client.","uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.clientConfig.renderMode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.clientConfig","typeLabel":"object"},"action":{"type":"object","description":"Details of a prerequisite action, which needs to be executed prior calling the provided link.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction.action","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution.requiredAction","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.execution","typeLabel":"object"},"actionId":{"type":"string","format":"uuid","description":"The unique action execution identifier originally returned in the synchronous action response.","uniqueKey":"events.items.[INDEX].details.oneOf.10.actionId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.amount.currency","typeLabel":"string"}},"description":"The total amount used during execution of the action.","uniqueKey":"events.items.[INDEX].details.oneOf.10.amount","typeLabel":"object"},"paymentComposition":{"type":"array","description":"List of Payment Methods that were affected by the action. See [PendingPaymentComposition](/reference/pendingpaymentcomposition) for every field.","items":{"type":"object","description":"See [PendingPaymentComposition](/reference/pendingpaymentcomposition) for every field.","properties":{"operationType":{"type":"string","description":"Operation Type that was executed in the Provider.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].operationType","typeLabel":"string"},"integrationType":{"type":"string","description":"Code of the integration type for using the payment method in the provider.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].integrationType","typeLabel":"string"},"paymentMethodCode":{"type":"string","description":"Code of the payment method selected to perform the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].paymentMethodCode","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the Payment Instrument that the customer selected for the Payment.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].paymentInstrumentId","typeLabel":"string"},"storeInstrument":{"type":"boolean","description":"Holder intention to store the payment instrument on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].storeInstrument","typeLabel":"boolean"},"paymentId":{"type":"string","description":"Unique identifier of the Payment affected during execution of the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].paymentId","typeLabel":"string"},"amount":{"type":"object","description":"The amount used to execute the operation. See [PendingPaymentComposition.amount](/reference/pendingpaymentcomposition#schema-amount) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].amount","typeLabel":"object"},"success":{"type":"boolean","description":"Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].success","typeLabel":"boolean"},"operationResult":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].operationResult","typeLabel":"string"},"providerId":{"type":"string","description":"Unique identifier of the provider used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].providerId","typeLabel":"string"},"provider":{"type":"object","description":"Provider used to execute the operation. See [PendingPaymentComposition.provider](/reference/pendingpaymentcomposition#schema-provider) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].provider","typeLabel":"object"},"providerConfigId":{"type":"string","description":"Unique identifier of the provider configuration used to execute the operation.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].providerConfigId","typeLabel":"string"},"operationProviderReference":{"type":"string","description":"Reference of the operation in the provider's system.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].operationProviderReference","typeLabel":"string"},"errors":{"type":"array","description":"The reason why the operation was not successful, set if `success = false`. See [PendingPaymentComposition.errors](/reference/pendingpaymentcomposition#schema-errors) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].errors","typeLabel":"array"},"accountFundingTransaction":{"type":"boolean","description":"Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].accountFundingTransaction","typeLabel":"boolean"},"authorizationCode":{"type":"string","description":"The acquirer authorization code if the payment was authorized.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].authorizationCode","typeLabel":"string"},"acquirerMID":{"type":"string","description":"Merchant Identifier (MID) on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].acquirerMID","typeLabel":"string"},"acquirerAccountCode":{"type":"string","description":"Account Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].acquirerAccountCode","typeLabel":"string"},"acquirerCountryCode":{"type":"string","description":"Country Code on the acquirer that processed the payment.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].acquirerCountryCode","typeLabel":"string"},"avsResultCode":{"type":"string","description":"Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `Y`: address and postal code both match.\n- `A`: address matches, postal code does not.\n- `Z`: postal code matches, address does not.\n- `N`: neither address nor postal code match.\n- `U`: the issuer could not perform the check.\n","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].avsResultCode","typeLabel":"string"},"cvvResultCode":{"type":"string","description":"Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.\n- `M`: security code matched.\n- `N`: security code did not match.\n- `U`: the issuer could not perform the check.\n- `P`: the check was expected but not processed.\n","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].cvvResultCode","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].acquirerReference","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].providerReference","typeLabel":"string"},"retrievalReference":{"type":"string","description":"Retrieval Reference Number (RRN) assigned to the payment by the issuer.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].retrievalReference","typeLabel":"string"},"paymentInstrument":{"type":"object","description":"Payment Instrument and tokens used to execute the authorize operation. See [PendingPaymentComposition.paymentInstrument](/reference/pendingpaymentcomposition#schema-payment-instrument) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].paymentInstrument","typeLabel":"object"},"providerResponseAdditionalFields":{"type":"object","description":"Any provider-specific response data requested by merchant on authorize.","uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX].providerResponseAdditionalFields","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.10.paymentComposition","typeLabel":"object[]"},"reason":{"type":"string","enum":["BetterPrice","CustomerDoesNotNeed","CustomerDontNeed","DamagedProduct","Duplicate","FraudulentProduct","LateDelivery","NoReason","Other","ProductMismatchDescription","WrongProduct","WrongProductSpecification"],"description":"Reason for invoking the operation or action. `CustomerDontNeed` is deprecated, use `CustomerDoesNotNeed` instead. With `Other`, `reasonDescription` is required for refunds: at least 3 characters after trimming. On refunds, `reasonDescription` is at most 255 characters for any reason.","uniqueKey":"events.items.[INDEX].details.oneOf.10.reason","typeLabel":"enum\u003cstring>"},"reasonDescription":{"type":"string","description":"Reason description specified when the action was initiated.","example":"Customer's order expired.","uniqueKey":"events.items.[INDEX].details.oneOf.10.reasonDescription","typeLabel":"string"},"errors":{"type":"array","description":"The main reason why the action was not successful, set if `success = false`.","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.10.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].details.oneOf.10.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.10","typeLabel":"executionActionPending · object"},{"type":"object","title":"executionActionStepScheduled","description":"Details for an executionActionStepScheduled event. Emitted when a workflow action step is scheduled for future execution.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.11.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.workflow","typeLabel":"object"},"output":{"type":"object","description":"Additional information about why the step was scheduled and when it will be executed (e.g. retry scheduling details).","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.11","typeLabel":"executionActionStepScheduled · object"},{"type":"object","title":"executionActionStepUnscheduled","description":"Details for an executionActionStepUnscheduled event. Emitted when a previously scheduled workflow action step is removed from the execution schedule.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.12.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.workflow","typeLabel":"object"},"output":{"type":"object","description":"Additional information about why the step was unscheduled.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.12","typeLabel":"executionActionStepUnscheduled · object"},{"type":"object","title":"executionActionStepRequested","description":"Details for an executionActionStepRequested event. Emitted when a workflow action step is requested and about to begin processing.","required":["input","action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.13.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.workflow","typeLabel":"object"},"input":{"type":"object","description":"The input data provided to the step at the time of the request.","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13.input","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.13","typeLabel":"executionActionStepRequested · object"},{"type":"object","title":"executionActionStepStarted","description":"Details for an executionActionStepStarted event. Emitted when a workflow action step begins active execution.","required":["input","action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.14.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.workflow","typeLabel":"object"},"input":{"type":"object","description":"The input data provided to the step at the time of execution start.","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14.input","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.14","typeLabel":"executionActionStepStarted · object"},{"type":"object","title":"executionActionStepPaused","description":"Details for an executionActionStepPaused event. Emitted when a workflow action step is paused mid-execution, for example while waiting for a notification or a required action completion.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.15.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.workflow","typeLabel":"object"},"output":{"type":"object","description":"Additional information about why the step was paused (e.g. awaiting notification or required action result).","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.15","typeLabel":"executionActionStepPaused · object"},{"type":"object","title":"executionActionStepResumed","description":"Details for an executionActionStepResumed event. Emitted when a previously paused workflow action step resumes execution, for example after receiving a notification or a required action result.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.16.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.workflow","typeLabel":"object"},"output":{"type":"object","description":"Additional information about why the step was resumed (e.g. notification received or required action result is available).","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.16","typeLabel":"executionActionStepResumed · object"},{"type":"object","title":"executionActionStepCompleted","description":"Details for an executionActionStepCompleted event. Emitted when a workflow action step finishes execution, either successfully or with an error.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.17.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.workflow","typeLabel":"object"},"output":{"type":"object","description":"The output data produced by the step upon completion.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.output","typeLabel":"object"},"error":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.error.id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.error.code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17.error.detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.17.error.docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.17.error.reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.17.error","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.17","typeLabel":"executionActionStepCompleted · object"},{"type":"object","title":"executionActionStepUpdated","description":"Details for an executionActionStepUpdated event. Emitted when a workflow action step is updated with intermediate output during execution.","required":["action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.18.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.workflow","typeLabel":"object"},"output":{"type":"object","description":"The intermediate output data produced by the step update.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.output","typeLabel":"object"},"error":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.error.id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.error.code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18.error.detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.18.error.docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"events.items.[INDEX].details.oneOf.18.error.reason","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].details.oneOf.18.error","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.18","typeLabel":"executionActionStepUpdated · object"},{"type":"object","title":"executionTriggerStepCalled","description":"Details for an executionTriggerStepCalled event. Emitted when a workflow trigger step is called, capturing both the input that initiated the trigger and the resulting output.","required":["input","output","action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.19.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.workflow","typeLabel":"object"},"input":{"type":"object","description":"The input data that triggered the workflow step.","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.input","typeLabel":"object"},"output":{"type":"object","description":"The output data produced by the trigger step call.","additionalProperties":true,"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19.output","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.19","typeLabel":"executionTriggerStepCalled · object"},{"type":"object","title":"executionConditionStepEvaluated","description":"Details for an executionConditionStepEvaluated event. Emitted when a workflow condition step is evaluated, containing the evaluation context and the resulting decision.","required":["context","result","action","step","workflow"],"properties":{"action":{"type":"object","description":"Parent workflow action that invoked the step execution.","required":["type","id","triggerType"],"properties":{"type":{"type":"string","description":"Type of workflow action.","enum":["lookup","authorize","capture","refund","cancel","payout","orderUpdate"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.action.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow action.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.action.id","typeLabel":"string\u003cuuid>"},"triggerType":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.action.triggerType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.action","typeLabel":"object"},"step":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.code","typeLabel":"string"},"previousStep":{"type":"object","description":"Summary of a workflow step.","required":["id","type","name","code"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow step.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.previousStep.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Defines the type of operation to be executed. Each type has a different set of parameters.","enum":["trigger","action","condition"],"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.previousStep.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Human-readable name of the workflow step.","example":"Authorize with 3DS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.previousStep.name","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable code of the workflow step.","example":"authorizeWithThreeDS","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.previousStep.code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.previousStep","typeLabel":"object"},"actionStepType":{"type":"string","description":"Type of workflow action step executed within a workflow.","enum":["authorize","capture","refund","cancel","payout","fraudScore","lookup","fraudUpdate","notify","createInstrument","provisionNetworkToken","threeDS","tagDispute","assignDispute","scoreDispute","defendDispute"],"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.actionStepType","typeLabel":"enum\u003cstring>"},"triggerStepType":{"type":"string","description":"Specifies the API type for the trigger.","enum":["clientAPI","merchantAPI","event"],"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.triggerStepType","typeLabel":"enum\u003cstring>"},"triggerStepEventName":{"type":"string","description":"The name of the event that triggers the workflow.","enum":["DisputeUpdated","PaymentStatusUpdated"],"uniqueKey":"events.items.[INDEX].details.oneOf.20.step.triggerStepEventName","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.step","typeLabel":"object"},"workflow":{"type":"object","description":"Workflow template from which the Executions are created.","required":["code","version"],"properties":{"code":{"type":"string","pattern":"^[a-z][-A-Za-z0-9]*$","description":"Machine-friendly code of Workflow.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.workflow.code","typeLabel":"string"},"version":{"type":"integer","description":"Version of a Workflow Configuration.","isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.workflow.version","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.workflow","typeLabel":"object"},"context":{"type":"object","description":"The execution context used when evaluating the condition.","properties":{"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta.upi","typeLabel":"any"}},"uniqueKey":"events.items.[INDEX].details.oneOf.20.context.meta","typeLabel":"object"},"dynamic":{"type":"object","description":"Additional computed metadata available during evaluation.","additionalProperties":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.context.dynamic","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.context","typeLabel":"object"},"result":{"type":"object","description":"The outcome of the condition evaluation.","properties":{"matched":{"type":"boolean","description":"Whether the condition was matched.","uniqueKey":"events.items.[INDEX].details.oneOf.20.result.matched","typeLabel":"boolean"},"ruleId":{"type":"string","format":"uuid","description":"The identifier of the rule that was matched, if any.","uniqueKey":"events.items.[INDEX].details.oneOf.20.result.ruleId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20.result","typeLabel":"object"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].details.oneOf.20","typeLabel":"executionConditionStepEvaluated · object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].details","typeLabel":"executionCreated · object · executionActionRequested · object · executionActionCompleted · object · executionActionCompleted · object · ruleEngineExecuted · object · networkOffersEnrollmentCompleted · object · executionActionScheduled · object · executionActionUnscheduled · object · executionActionUpdated · object · executionActionUpdated · object · executionActionPending · object · executionActionStepScheduled · object · executionActionStepUnscheduled · object · executionActionStepRequested · object · executionActionStepStarted · object · executionActionStepPaused · object · executionActionStepResumed · object · executionActionStepCompleted · object · executionActionStepUpdated · object · executionTriggerStepCalled · object · executionConditionStepEvaluated · object"},"workspaceId":{"type":"string","format":"uuid","description":"Workspace ID that the event belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"eventTrigger":{"type":"string","description":"Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails.\n","enum":["api","action","external"],"isRequired":true,"uniqueKey":"events.items.[INDEX].eventTrigger","typeLabel":"enum\u003cstring>"},"notificationEvent":{"type":"object","title":"Notification event","required":["workflowCode","workflowExecutionId","workflowExecutionEventId","workspaceId","status","createdAt","updatedAt"],"properties":{"workflowExecutionId":{"type":"string","description":"Unique identifier of the Workflow Execution that this notification event belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.workflowExecutionId","typeLabel":"string"},"workflowCode":{"type":"string","description":"Workflow code.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.workflowCode","typeLabel":"string"},"workflowExecutionEventId":{"type":"string","format":"uuid","description":"Unique identifier of the Workflow Execution Event that this notification event belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.workflowExecutionEventId","typeLabel":"string\u003cuuid>"},"workspaceId":{"type":"string","format":"uuid","description":"Unique identifier of the Workspace that this notification event belongs to.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.workspaceId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Value of Notification event status enumeration.","enum":["delivered","deliveryFailed","pending"],"isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the Notification.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last update of the Notification.","isRequired":true,"uniqueKey":"events.items.[INDEX].notificationEvent.updatedAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","description":"Unique identifier of the Notification event.","format":"uuid","uniqueKey":"events.items.[INDEX].notificationEvent.id","typeLabel":"string\u003cuuid>"},"body":{"type":"string","description":"Original body request object sent.","uniqueKey":"events.items.[INDEX].notificationEvent.body","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].notificationEvent","typeLabel":"Notification event · object"}},"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"events":[{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionCompleted","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"operationType":"Authorize","amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","accountFundingTransaction":true,"authorizationCode":"X055258","acquirerReference":"1233524535345","providerReference":"1027724325777","retrievalReference":"8657867867867","acquirerAccountCode":"MI21","acquirerCountryCode":"NL","acquirerMID":"50TP","avsResultCode":"Y","cvvResultCode":"M","success":true,"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","paymentInstrument":{"tokens":[{"type":"psp","reference":"provider-token","meta":{"holderReference":"provider-customer-reference"}}],"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}},"captureMode":"Instant"}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:44.857Z","details":{"action":"determineProviderOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determineProviderOptions","filter":{"providerConfigID":"5eb08624-ecce-4cbc-9a8a-61d484172815"}},"rules":[{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}}],"defaultAction":{"type":"skip"},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a"}],"evaluations":[{"chosenRule":{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}},"result":true}],"entity":{"id":"d9479775-3926-44af-9fcc-1c83ff4dcad6","providerId":"01039f19-d151-48b4-86aa-b36e68323e4e","createdAt":"2022-04-22T17:53:36.814Z","config":{"accountDetails":{"processingChannelId":"pc_0a70d769-9c20-416e-a436-4a323ce7eabf"},"credentials":{"clientId":"ack_3b2105ac-0190-4e18-a46c-d79ff97a39bc","clientSecret":"secret://**********************************************************************************XYZA","hmacKeys":["secret://********************************67X9"]}},"accountName":"TestAccountName","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","accountDisplayName":"TestAccountDisplayName","workspaces":["7f9f1882-a103-408d-ac96-46a7021e537a","70025496-f2a8-4211-b852-32261cbd8cde"],"notificationUrl":"https://yourcompany-api-pub.staging.payrails.io/public/notification/provider/testpsp/accountName/TestPSP"}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:43.557Z","details":{"action":"determinePaymentOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determinePaymentOptions","filter":{"paymentMethodCode":"card"}},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","rules":[{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}}],"defaultAction":{"type":"skip"}}],"evaluations":[{"chosenRule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"result":true},{"rule":{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}},"result":false}],"entity":{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"event":"executionActionRequested","time":"2022-02-03T14:34:42.557Z","details":{"action":"authorize","actionId":"9fce7f2c-faac-4b10-8a24-c146687f9e97","request":{"amount":{"value":"12.50","currency":"EUR"},"returnInfo":{"success":"https://mysuccessurl.com","error":"https://myerrorurl.com","pending":"https://mypendingurl.com"},"paymentComposition":[{"paymentInstrumentId":"384279fe-fee4-441d-9836-d2ef663551ad","paymentMethodCode":"card","integrationType":"api","amount":{"value":"12.50","currency":"EUR"}}],"meta":{"customer":{"reference":"******"}}},"response":{"name":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-04-22T17:53:36.814Z","links":{"execution":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","consumerWait":"https://api.staging.payrails.io/public/redirect/merchant/example-merchant/100ade99-ef8d-43de-8a35-4d31dbdb37d0/99e2f33a-2d17-4c98-8242-6bf5a4a08016/dGVtcG9yYXJ5LWF1dGgK","capture":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/capture"},"cancel":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/cancel"}}}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionActionRequested","time":"2022-02-03T14:34:41.557Z","details":{"action":"authorize","actionId":"54c05fd4-c054-4b59-a829-4eb76f33f4ea","request":{"amount":{"value":"12.50","currency":"EUR"},"returnInfo":{"success":"https://mysuccessurl.com","error":"https://myerrorurl.com","pending":"https://mypendingurl.com"},"paymentComposition":[{"paymentInstrumentId":"384279fe-fee4-441d-9836-d2ef663551ad","paymentMethodCode":"card","integrationType":"api","amount":{"value":"12.50","currency":"EUR"}}],"meta":{"customer":{"reference":"******"}}},"response":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"Service Not Available","detail":"The requested operation is unavailable at the moment."}]}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionCreated","time":"2022-02-03T14:34:39.557Z","details":{"request":{"merchantReference":"order_3573894940903","holderReference":"customer_836361394","meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}},"initialActions":[{"action":"lookup","method":"POST","body":{"amount":{"value":"12.50","currency":"EUR"},"meta":{"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}}}]},"response":{"id":"5d0e7a85-c982-499f-bb7f-296b75bcbe10","status":[{"code":"created","time":"2022-02-03T14:38:41.557Z"}],"createdAt":"2022-02-03T14:38:40.557Z","merchantReference":"order_3573894940903","holderId":"9d113e2a-35a0-40e1-828b-35a18ac35b41","holderReference":"customer123","workflow":{"version":3,"code":"payment-acceptance"},"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}},"links":{"self":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","lookup":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/lookup"}},"initialResults":[{"httpCode":200,"body":{"name":"lookup","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-02-03T14:38:40.557Z","data":{"paymentCompositionOptions":[{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}]},"links":{"execution":{"href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016"},"authorize":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize"},"startPaymentSession":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/startPaymentSession"}}}}],"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a"}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionActionRequested","time":"2022-02-03T14:34:42.557Z","details":{"action":"lookup","request":{"amount":{"value":"12.50","currency":"EUR"},"meta":{"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"response":{"name":"lookup","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-02-03T14:38:40.557Z","data":{"paymentCompositionOptions":[{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}],"clientConfig":{"displayName":"Card","supportsSaveInstrument":true,"flow":"direct"}},{"paymentMethodCode":"bankAccount","integrationType":"api","description":"Bank Account.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"bankAccount","description":"Personal bank account.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","data":{"holder":{"firstName":"John","lastName":"Doe","companyName":"ABC Corp","address":{"streetName":"Example St","streetNumber":"123","postalCode":"12345","city":"Anytown","stateOrProvince":"CA","country":"US"},"email":"john.doe@example.com","dob":"1990-01-15","country":{"code":"US","name":"United States"},"city":"New York","type":"personal"},"bank":{"name":"Example Bank","branchCode":"1234","code":"56789","address":{"streetName":"Bank St","streetNumber":"5","postalCode":"98765","city":"Banktown","stateOrProvince":"NY","country":"US"},"swiftCode":"EXABUS33XXX","country":{"code":"US","name":"United States"}},"account":{"number":"1234567890","iban":"US123456789012345678901234567890","currency":"USD","type":"savings"}}}],"clientConfig":{"displayName":"Bank Account","supportsSaveInstrument":true,"flow":"direct","instrumentDataSchema":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"bankAccount","description":"Personal bank account.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","data":{"holder":{"firstName":"John","lastName":"Doe","companyName":"ABC Corp","address":{"streetName":"Example St","streetNumber":"123","postalCode":"12345","city":"Anytown","stateOrProvince":"CA","country":"US"},"email":"john.doe@example.com","dob":"1990-01-15","country":{"code":"US","name":"United States"},"city":"New York","type":"personal"},"bank":{"name":"Example Bank","branchCode":"1234","code":"56789","address":{"streetName":"Bank St","streetNumber":"5","postalCode":"98765","city":"Banktown","stateOrProvince":"NY","country":"US"},"swiftCode":"EXABUS33XXX","country":{"code":"US","name":"United States"}},"account":{"number":"1234567890","iban":"US123456789012345678901234567890","currency":"USD","type":"savings"}}}}}]},"links":{"execution":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","authorize":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize"}}}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:43.557Z","details":{"action":"determinePaymentOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determinePaymentOptions","filter":{"paymentMethodCode":"card"}},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","rules":[{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}}],"defaultAction":{"type":"skip"}}],"evaluations":[{"chosenRule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"result":true},{"rule":{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}},"result":false}],"entity":{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"networkOffersEnrollmentCompleted","time":"2022-04-22T17:53:36.814Z","details":{"actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"paymentComposition":[{"integrationType":"api","paymentMethodCode":"card","success":true,"operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08656-ecce-4c3c-9a8a-61d484172322","providerConfigId":"5eb08656-ecce-4c3c-9a8a-61d484172322","paymentInstrumentId":"a3a7e52d-bdcc-46a3-a9f2-702b5d7925b0","storeInstrument":true,"paymentInstrument":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}},"tokens":[{"type":"networkOffers","reference":"network-offers-token","meta":{"holderReference":"network-offers-customer-reference"}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionUpdated","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"operationType":"Authorize","amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","accountFundingTransaction":true,"authorizationCode":"X055258","acquirerReference":"1233524535345","providerReference":"1027724325777","retrievalReference":"8657867867867","acquirerAccountCode":"MI21","acquirerCountryCode":"NL","acquirerMID":"50TP","avsResultCode":"Y","cvvResultCode":"M","success":true,"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","paymentInstrument":{"tokens":[{"type":"psp","reference":"provider-token","meta":{"holderReference":"provider-customer-reference"}}],"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}},"captureMode":"Instant"}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionPending","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","requiredAction":{"type":"redirect","subType":"client","href":"https://api.sandbox.checkout.com","method":"GET"},"meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationType":"Authorize","operationResult":"Pending","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","providerReference":"1027724325777","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","success":true,"paymentInstrument":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"}]},"examples":{"Example":{"title":"Example","value":{"events":[{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionCompleted","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"operationType":"Authorize","amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","accountFundingTransaction":true,"authorizationCode":"X055258","acquirerReference":"1233524535345","providerReference":"1027724325777","retrievalReference":"8657867867867","acquirerAccountCode":"MI21","acquirerCountryCode":"NL","acquirerMID":"50TP","avsResultCode":"Y","cvvResultCode":"M","success":true,"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","paymentInstrument":{"tokens":[{"type":"psp","reference":"provider-token","meta":{"holderReference":"provider-customer-reference"}}],"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}},"captureMode":"Instant"}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:44.857Z","details":{"action":"determineProviderOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determineProviderOptions","filter":{"providerConfigID":"5eb08624-ecce-4cbc-9a8a-61d484172815"}},"rules":[{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}}],"defaultAction":{"type":"skip"},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a"}],"evaluations":[{"chosenRule":{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":1}}},"result":true}],"entity":{"id":"d9479775-3926-44af-9fcc-1c83ff4dcad6","providerId":"01039f19-d151-48b4-86aa-b36e68323e4e","createdAt":"2022-04-22T17:53:36.814Z","config":{"accountDetails":{"processingChannelId":"pc_0a70d769-9c20-416e-a436-4a323ce7eabf"},"credentials":{"clientId":"ack_3b2105ac-0190-4e18-a46c-d79ff97a39bc","clientSecret":"secret://**********************************************************************************XYZA","hmacKeys":["secret://********************************67X9"]}},"accountName":"TestAccountName","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","accountDisplayName":"TestAccountDisplayName","workspaces":["7f9f1882-a103-408d-ac96-46a7021e537a","70025496-f2a8-4211-b852-32261cbd8cde"],"notificationUrl":"https://yourcompany-api-pub.staging.payrails.io/public/notification/provider/testpsp/accountName/TestPSP"}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:43.557Z","details":{"action":"determinePaymentOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determinePaymentOptions","filter":{"paymentMethodCode":"card"}},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","rules":[{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}}],"defaultAction":{"type":"skip"}}],"evaluations":[{"chosenRule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"result":true},{"rule":{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}},"result":false}],"entity":{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"event":"executionActionRequested","time":"2022-02-03T14:34:42.557Z","details":{"action":"authorize","actionId":"9fce7f2c-faac-4b10-8a24-c146687f9e97","request":{"amount":{"value":"12.50","currency":"EUR"},"returnInfo":{"success":"https://mysuccessurl.com","error":"https://myerrorurl.com","pending":"https://mypendingurl.com"},"paymentComposition":[{"paymentInstrumentId":"384279fe-fee4-441d-9836-d2ef663551ad","paymentMethodCode":"card","integrationType":"api","amount":{"value":"12.50","currency":"EUR"}}],"meta":{"customer":{"reference":"******"}}},"response":{"name":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-04-22T17:53:36.814Z","links":{"execution":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","consumerWait":"https://api.staging.payrails.io/public/redirect/merchant/example-merchant/100ade99-ef8d-43de-8a35-4d31dbdb37d0/99e2f33a-2d17-4c98-8242-6bf5a4a08016/dGVtcG9yYXJ5LWF1dGgK","capture":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/capture"},"cancel":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/cancel"}}}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionActionRequested","time":"2022-02-03T14:34:41.557Z","details":{"action":"authorize","actionId":"54c05fd4-c054-4b59-a829-4eb76f33f4ea","request":{"amount":{"value":"12.50","currency":"EUR"},"returnInfo":{"success":"https://mysuccessurl.com","error":"https://myerrorurl.com","pending":"https://mypendingurl.com"},"paymentComposition":[{"paymentInstrumentId":"384279fe-fee4-441d-9836-d2ef663551ad","paymentMethodCode":"card","integrationType":"api","amount":{"value":"12.50","currency":"EUR"}}],"meta":{"customer":{"reference":"******"}}},"response":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"Service Not Available","detail":"The requested operation is unavailable at the moment."}]}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionCreated","time":"2022-02-03T14:34:39.557Z","details":{"request":{"merchantReference":"order_3573894940903","holderReference":"customer_836361394","meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}},"initialActions":[{"action":"lookup","method":"POST","body":{"amount":{"value":"12.50","currency":"EUR"},"meta":{"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}}}]},"response":{"id":"5d0e7a85-c982-499f-bb7f-296b75bcbe10","status":[{"code":"created","time":"2022-02-03T14:38:41.557Z"}],"createdAt":"2022-02-03T14:38:40.557Z","merchantReference":"order_3573894940903","holderId":"9d113e2a-35a0-40e1-828b-35a18ac35b41","holderReference":"customer123","workflow":{"version":3,"code":"payment-acceptance"},"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}},"links":{"self":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","lookup":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/lookup"}},"initialResults":[{"httpCode":200,"body":{"name":"lookup","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-02-03T14:38:40.557Z","data":{"paymentCompositionOptions":[{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}]},"links":{"execution":{"href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016"},"authorize":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize"},"startPaymentSession":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/startPaymentSession"}}}}],"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a"}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"executionActionRequested","time":"2022-02-03T14:34:42.557Z","details":{"action":"lookup","request":{"amount":{"value":"12.50","currency":"EUR"},"meta":{"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"response":{"name":"lookup","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","executedAt":"2022-02-03T14:38:40.557Z","data":{"paymentCompositionOptions":[{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}],"clientConfig":{"displayName":"Card","supportsSaveInstrument":true,"flow":"direct"}},{"paymentMethodCode":"bankAccount","integrationType":"api","description":"Bank Account.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"bankAccount","description":"Personal bank account.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","data":{"holder":{"firstName":"John","lastName":"Doe","companyName":"ABC Corp","address":{"streetName":"Example St","streetNumber":"123","postalCode":"12345","city":"Anytown","stateOrProvince":"CA","country":"US"},"email":"john.doe@example.com","dob":"1990-01-15","country":{"code":"US","name":"United States"},"city":"New York","type":"personal"},"bank":{"name":"Example Bank","branchCode":"1234","code":"56789","address":{"streetName":"Bank St","streetNumber":"5","postalCode":"98765","city":"Banktown","stateOrProvince":"NY","country":"US"},"swiftCode":"EXABUS33XXX","country":{"code":"US","name":"United States"}},"account":{"number":"1234567890","iban":"US123456789012345678901234567890","currency":"USD","type":"savings"}}}],"clientConfig":{"displayName":"Bank Account","supportsSaveInstrument":true,"flow":"direct","instrumentDataSchema":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"bankAccount","description":"Personal bank account.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","data":{"holder":{"firstName":"John","lastName":"Doe","companyName":"ABC Corp","address":{"streetName":"Example St","streetNumber":"123","postalCode":"12345","city":"Anytown","stateOrProvince":"CA","country":"US"},"email":"john.doe@example.com","dob":"1990-01-15","country":{"code":"US","name":"United States"},"city":"New York","type":"personal"},"bank":{"name":"Example Bank","branchCode":"1234","code":"56789","address":{"streetName":"Bank St","streetNumber":"5","postalCode":"98765","city":"Banktown","stateOrProvince":"NY","country":"US"},"swiftCode":"EXABUS33XXX","country":{"code":"US","name":"United States"}},"account":{"number":"1234567890","iban":"US123456789012345678901234567890","currency":"USD","type":"savings"}}}}}]},"links":{"execution":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016","authorize":{"method":"POST","href":"https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize"}}}},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"event":"ruleEngineExecuted","time":"2022-02-03T14:34:43.557Z","details":{"action":"determinePaymentOptions","context":{"meta":{"order":{"reference":"******"},"customer":{"reference":"******"},"clientContext":{"ipAddress":"******"}}},"rulesets":[{"id":"670e7a35-c282-469f-b77f-336b75bcbe55","version":1,"createdAt":"2022-11-02T12:27:22.73972022Z","trigger":{"on":"determinePaymentOptions","filter":{"paymentMethodCode":"card"}},"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","rules":[{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}}],"defaultAction":{"type":"skip"}}],"evaluations":[{"chosenRule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"action":{"type":"setPriority","params":{"priority":1}},"ruleEvaluationResults":[{"rule":{"condition":{"left":{"field":"customer.country.code","operator":"IS ONE OF","value":["AR","CL"]},"operator":"AND","right":{"field":"clientContext.osType","operator":"=","value":"ios"}},"action":{"type":"setPriority","params":{"priority":1}}},"result":true},{"rule":{"condition":{"field":"clientContext.osType","operator":"=","value":"web"},"action":{"type":"setPriority","params":{"priority":2}}},"result":false}],"entity":{"paymentMethodCode":"card","integrationType":"api","description":"Card.","paymentInstruments":[{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"action"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"networkOffersEnrollmentCompleted","time":"2022-04-22T17:53:36.814Z","details":{"actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"paymentComposition":[{"integrationType":"api","paymentMethodCode":"card","success":true,"operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08656-ecce-4c3c-9a8a-61d484172322","providerConfigId":"5eb08656-ecce-4c3c-9a8a-61d484172322","paymentInstrumentId":"a3a7e52d-bdcc-46a3-a9f2-702b5d7925b0","storeInstrument":true,"paymentInstrument":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}},"tokens":[{"type":"networkOffers","reference":"network-offers-token","meta":{"holderReference":"network-offers-customer-reference"}}]}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionUpdated","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"success":true,"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"operationType":"Authorize","amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationResult":"Success","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","accountFundingTransaction":true,"authorizationCode":"X055258","acquirerReference":"1233524535345","providerReference":"1027724325777","retrievalReference":"8657867867867","acquirerAccountCode":"MI21","acquirerCountryCode":"NL","acquirerMID":"50TP","avsResultCode":"Y","cvvResultCode":"M","success":true,"workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","paymentInstrument":{"tokens":[{"type":"psp","reference":"provider-token","meta":{"holderReference":"provider-customer-reference"}}],"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}},"captureMode":"Instant"}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"},{"notificationEvent":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","workflowCode":"payment-acceptance","workflowExecutionId":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","workflowExecutionEventId":"42dc198e-fee0-45e9-aaa6-765036a15ade","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","createdAt":"2022-02-03T14:38:40.557Z","updatedAt":"2022-02-03T14:38:40.557Z","status":"delivered","body":"{\"action\":\"authorize\",\"actionId\":\"71f9cfed-1583-4483-b5d8-49af91749d85\",\"amount\":{\"currency\":\"EUR\",\"value\":\"22.50\"},\"execution\":{\"id\":\"8a780068-bf6b-4ba1-9b24-d32606b2fc19\",\"holderId\":\"fe8397fc-3301-4ffa-b0bc-b7f83e835a64\",\"holderReference\":\"84c51416-e06c-4dff-a76f-72fd66f3182d\",\"merchantReference\":\"679b48ed-ae78-48ae-b19a-460b52c2354d\"}}"},"event":"executionActionPending","time":"2022-04-22T17:53:36.814Z","details":{"action":"authorize","actionId":"1aa0ef20-36cb-4485-b60e-0526c3699014","execution":{"workflowCode":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f","id":"c5454c2f-ae5e-44f3-8edf-e6dad64f006f","merchantReference":"order_3573894940903","holderReference":"customer123","requiredAction":{"type":"redirect","subType":"client","href":"https://api.sandbox.checkout.com","method":"GET"},"meta":{"order":{"reference":"order_3573894940903"},"customer":{"reference":"1231905323475","country":{"code":"DE"}},"clientContext":{"ipAddress":"217.110.239.132","osType":"ios"}}},"amount":{"value":"12.50","currency":"EUR"},"paymentComposition":[{"amount":{"currency":"EUR","value":"24.00"},"integrationType":"api","operationType":"Authorize","operationResult":"Pending","operationProviderReference":"provider-reference-example","providerId":"5eb08624-ecce-4cbc-9a8a-61d484172815","provider":{"id":"5eb08624-ecce-4cbc-9a8a-61d484172815","name":"checkout","displayName":"Checkout.com","type":"Payment","status":"active","configSchema":"{\"required\":[\"accountDetails\",\"credentials\"],\"definitions\":{\"PspCheckoutAccountDetails\":{\"required\":[\"processingChannelId\"],\"properties\":{\"processingChannelId\":{\"title\":\"Processing channel ID\",\"minLength\":1,\"pattern\":\"^pc_.+$\",\"type\":\"string\"}},\"type\":\"object\"},\"PspCheckoutCredentials\":{\"required\":[\"clientId\",\"clientSecret\"],\"properties\":{\"clientId\":{\"title\":\"Client ID\",\"description\":\"Client ID used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\"},\"clientSecret\":{\"title\":\"Client Secret\",\"description\":\"Client Secret used to authenticate requests to the Checkout API\",\"minLength\":1,\"type\":\"string\",\"format\":\"secret\"},\"hmacKeys\":{\"title\":\"HMAC keys\",\"description\":\"HMAC keys used to authenticate notifications from the Checkout API\",\"pattern\":\"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$\",\"items\":{\"type\":\"string\"},\"type\":\"array\",\"format\":\"secret\"}},\"type\":\"object\"}},\"properties\":{\"accountDetails\":{\"$ref\":\"#/definitions/PspCheckoutAccountDetails\",\"title\":\"Account details\"},\"credentials\":{\"$ref\":\"#/definitions/PspCheckoutCredentials\",\"title\":\"Checkout credentials\"}},\"type\":\"object\"}","createdAt":"2021-01-05T10:20:00.000Z","updatedAt":"2022-06-14T11:50:00.000Z"},"providerConfigId":"a0ad4cd3-f243-4f1a-b294-f7c3df701b10","paymentId":"c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe","paymentInstrumentId":"a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0","storeInstrument":true,"paymentMethodCode":"card","providerReference":"1027724325777","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","success":true,"paymentInstrument":{"id":"b8fe6271-5d71-4d28-b8e8-89e64acc0c49","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","displayName":"Visa **** 1111","description":"Personal card.","merchantReference":"ref_C47C47","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","networkTransactionReference":"987654321234567","data":{"network":"visa","bin":"416598","binLookup":{"bin":"416598","network":"visa","localNetwork":"bancontact","issuer":"Revolut","issuerCountry":{"code":"LT","name":"Lithuania","iso3":"LTU"},"segment":"infinite","type":"debit","typeDetails":"personal"},"suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe","billingAddress":{"country":{"code":"DE","name":"Germany"},"postalCode":"10117"}}}}]},"workspaceId":"0bd0f200-fcff-4f63-8b16-0f692d62bd2f","eventTrigger":"api"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d4b9fae7-35ca-4683-a0b0-12028d8f6562":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"efd92ce5-ab63-4876-8855-f5aa6b6c4d8a":{"description":"Insufficient Scope.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0e85fa03-4286-497b-a752-d54478219057":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"709507c7-cf50-47e9-bdf6-b31daf00356f":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2de65aaa-db26-46d5-bc9e-921dcbeba789":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["executions:read"],"schemeName":"BearerToken"}}},"servers":{"e23a8acb-dc2c-48e6-bf08-5355ad9ca20e":{"url":"https://api.staging.payrails.io","description":"Payrails environment."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["executions:read"],"schemeName":"BearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerToken","name":"Authorization"}],"title":"BearerToken"}]},"originalFileLocation":"https://cdn.payrails.io/docs/api/openapi.min.json"},"subdomain":"payrails-42074109","siteName":"Payrails Docs","title":"Search \u0026 list events - Payrails Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"reference/getworkflowhistory.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search \u0026amp; list events - Payrails Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payrails Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payrails.com/reference/getworkflowhistory\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://payrails-42074109.mintlify.app/_mintlify/api/og/v2?division=Actions\u0026amp;title=Search+%26+list+events\u0026amp;description=Search+and+list+the+event+history+of+a+workflow+execution%2C+filtering+events+by+event+type%2C+action+type%2C+action+ID%2C+notification+status%2C+or+error+code.\u0026amp;theme=8d26c0ee63969d79a6f2d462\u0026amp;signature=a85fa3ef4268c5ef4a60ea1de75d535d3953e8feb1a4db1fe1b8dc1963101acd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search \u0026amp; list events - Payrails Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payrails-42074109.mintlify.app/_mintlify/api/og/v2?division=Actions\u0026amp;title=Search+%26+list+events\u0026amp;description=Search+and+list+the+event+history+of+a+workflow+execution%2C+filtering+events+by+event+type%2C+action+type%2C+action+ID%2C+notification+status%2C+or+error+code.\u0026amp;theme=8d26c0ee63969d79a6f2d462\u0026amp;signature=a85fa3ef4268c5ef4a60ea1de75d535d3953e8feb1a4db1fe1b8dc1963101acd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D63D00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"7723ABF900EAD08F0500790E9BFC62E7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payrails.com/reference/getworkflowhistory\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/getworkflowhistory.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.payrails.com#organization\",\"name\":\"Payrails\",\"legalName\":\"Payrails GmbH\",\"url\":\"https://www.payrails.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.payrails.com/payrails-logo.svg\"},\"sameAs\":[\"https://www.linkedin.com/company/payrails/\",\"https://www.crunchbase.com/organization/payrails\",\"https://www.wikidata.org/wiki/Q137211152\",\"https://x.com/Payrails_com\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payrails.com#website\",\"name\":\"Payrails Docs\",\"url\":\"https://docs.payrails.com\",\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payrails.com/reference/getworkflowhistory#webpage\",\"url\":\"https://docs.payrails.com/reference/getworkflowhistory\",\"name\":\"Search \u0026 list events\",\"description\":\"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\",\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payrails.com/reference/getworkflowhistory#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payrails.com/reference/getworkflowhistory#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflow\",\"item\":\"https://docs.payrails.com/reference/listworkflowconfigurations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Actions\",\"item\":\"https://docs.payrails.com/reference/lookupaction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Search \u0026 list events\",\"item\":\"https://docs.payrails.com/reference/getworkflowhistory\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payrails.com/reference/getworkflowhistory#apireference\",\"headline\":\"Search \u0026 list events\",\"name\":\"Search \u0026 list events\",\"description\":\"Search and list the event history of a workflow execution, filtering events by event type, action type, action ID, notification status, or error code.\",\"url\":\"https://docs.payrails.com/reference/getworkflowhistory\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payrails.com/reference/getworkflowhistory#webpage\"},\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payrails Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Payrails Docs","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/explore-payrails"}]},{"tab":"Connections","pages":[{"title":"Connections","href":"/docs/connections"}]},{"tab":"API Reference","groups":[{"group":"Payrails API Reference","pages":[{"title":"Getting started","href":"/reference"},{"group":"Schemas","pages":[{"title":"Meta","href":"/reference/meta"},{"title":"Funds Transfer","href":"/reference/fundstransfer"},{"group":"Workflow Schemas","expanded":false,"pages":[{"title":"Create Execution Response","href":"/reference/createexecutionresponse"},{"title":"Enrollment Payment Composition","href":"/reference/enrollmentpaymentcomposition"},{"title":"Payment Composition","href":"/reference/paymentcomposition"},{"title":"Payout Composition","href":"/reference/payoutcomposition"},{"title":"Pending Payment Composition","href":"/reference/pendingpaymentcomposition"},{"title":"Resolved Rulesets","href":"/reference/resolvedrulesets"},{"title":"Rule Evaluation","href":"/reference/ruleevaluation"},{"title":"Step Next Actions","href":"/reference/workflowstepnextactions"}]}]}]},{"group":"Get started","pages":[{"group":"Authentication","pages":[{"title":"Request an access token","deprecated":null,"version":null,"sidebarTitle":"Request an access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/token/{clientId}","href":"/reference/getoauthtoken"},{"title":"Request a Vault access token","deprecated":null,"version":null,"sidebarTitle":"Request a Vault access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/auth","href":"/reference/getvaultaccesstoken"}]},{"group":"Client","pages":[{"title":"Initialize a client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/client/init","href":"/reference/clientinit"}]},{"group":"SSO Connections","pages":[{"title":"List SSO connections","deprecated":null,"version":null,"sidebarTitle":"List SSO connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections","href":"/reference/listssoconnections"},{"title":"Create SSO connection","deprecated":null,"version":null,"sidebarTitle":"Create SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/sso/connections","href":"/reference/createssoconnection"},{"title":"Get SSO connection","deprecated":null,"version":null,"sidebarTitle":"Get SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/{connectionId}","href":"/reference/getssoconnectionbyid"},{"title":"Update SSO connection","deprecated":null,"version":null,"sidebarTitle":"Update SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /auth/sso/connections/{connectionId}","href":"/reference/patchssoconnection"},{"title":"Get SAML IdP configuration values","deprecated":null,"version":null,"sidebarTitle":"Get SAML IdP configuration values","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/saml-configs","href":"/reference/listsamlconnectionconfigs"}]}]},{"group":"Workflow","pages":[{"group":"Workflows","pages":[{"title":"Search \u0026 list workflow configurations","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list workflow configurations","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}","href":"/reference/listworkflowconfigurations"},{"title":"Create a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Create a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}","href":"/reference/createworkflowconfiguration"},{"title":"Get a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/getworkflowconfigurationversion"},{"title":"Updates a workflow configuration version","deprecated":null,"version":null,"sidebarTitle":"Updates a workflow configuration version","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/patchworkflowconfigurationversion"},{"title":"Get the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/default","href":"/reference/getdefaultworkflowconfigurationversion"},{"title":"Update the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Update the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/workflows/{workflowCode}/versions/default","href":"/reference/setdefaultworkflowconfigurationversion"}]},{"group":"Executions","pages":[{"title":"Search \u0026 list executions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list executions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions","href":"/reference/listexecutions"},{"title":"Create an execution","deprecated":null,"version":null,"sidebarTitle":"Create an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions","href":"/reference/createexecution"},{"title":"Get an execution by ID","deprecated":null,"version":null,"sidebarTitle":"Get an execution by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}","href":"/reference/getexecution"}]},{"group":"Actions","pages":[{"title":"Lookup payment options","deprecated":null,"version":null,"sidebarTitle":"Lookup payment options","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/lookup","href":"/reference/lookupaction"},{"title":"Start a payment session","deprecated":null,"version":null,"sidebarTitle":"Start a payment session","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/startPaymentSession","href":"/reference/startpaymentsessionaction"},{"title":"Authorize a payment","deprecated":null,"version":null,"sidebarTitle":"Authorize a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/authorize","href":"/reference/authorizeaction"},{"title":"Confirm a payment","deprecated":null,"version":null,"sidebarTitle":"Confirm a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/confirm","href":"/reference/confirmaction"},{"title":"Cancel a payment","deprecated":null,"version":null,"sidebarTitle":"Cancel a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/cancel","href":"/reference/cancelaction"},{"title":"Capture a payment","deprecated":null,"version":null,"sidebarTitle":"Capture a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/capture","href":"/reference/captureaction"},{"title":"Refund a payment","deprecated":null,"version":null,"sidebarTitle":"Refund a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/refund","href":"/reference/refundaction"},{"title":"Create a payout","description":"Request a payout in a workflow execution by sending the amount in the recipient account currency and, optionally, the payout instrument ID to use.","deprecated":null,"version":null,"sidebarTitle":"Create a payout","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/payout","href":"/reference/payoutaction"},{"title":"Search \u0026 list events","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/history","href":"/reference/getworkflowhistory"},{"title":"List actions of an execution","description":"List the actions of a workflow execution, such as authorize, capture, or refund, and set includeEvents to return each action's events in the response.","deprecated":null,"version":null,"sidebarTitle":"List actions of an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/actions","href":"/reference/getworkflowactions"},{"title":"Update fraud order status","deprecated":null,"version":null,"sidebarTitle":"Update fraud order status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/orderUpdate","href":"/reference/fraudupdateaction"},{"title":"Search \u0026 list actions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list actions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions","href":"/reference/listactions"},{"title":"Get an action by ID","deprecated":null,"version":null,"sidebarTitle":"Get an action by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions/{actionId}","href":"/reference/getaction"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"title":"Search \u0026 list payments","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list payments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments","href":"/reference/listpayments"},{"title":"Get payment by ID","deprecated":null,"version":null,"sidebarTitle":"Get payment by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}","href":"/reference/getpayment"},{"title":"Get Payment Operations by Payment ID","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operations by Payment ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations","href":"/reference/getpaymentoperations"},{"title":"Get Payment Operation Logs by Payment Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operation Logs by Payment Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations/{paymentOperationId}/logs","href":"/reference/getpaymentoperationlogs"}]},{"group":"Instruments","pages":[{"title":"Search \u0026 list instruments","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list instruments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments","href":"/reference/listinstruments"},{"title":"Create an instrument","deprecated":null,"version":null,"sidebarTitle":"Create an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments","href":"/reference/createinstrument"},{"title":"Get an instrument by ID","deprecated":null,"version":null,"sidebarTitle":"Get an instrument by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}","href":"/reference/getinstrument"},{"title":"Delete an instrument","deprecated":null,"version":null,"sidebarTitle":"Delete an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}","href":"/reference/deleteinstrument"},{"title":"Update an instrument","deprecated":null,"version":null,"sidebarTitle":"Update an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/instruments/{instrumentId}","href":"/reference/updateinstrument"},{"title":"Provision a Network Token","deprecated":null,"version":null,"sidebarTitle":"Provision a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/provisionNetworkToken","href":"/reference/provisionnetworktokenpublic"},{"title":"Generate cryptogram for a Network Token","deprecated":null,"version":null,"sidebarTitle":"Generate cryptogram for a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/generateCryptogram","href":"/reference/generatecryptogram"}]},{"group":"Instrument Tokens","pages":[{"title":"Search \u0026 list tokens","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list tokens","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens","href":"/reference/listtokens"},{"title":"Create a token","deprecated":null,"version":null,"sidebarTitle":"Create a token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/tokens","href":"/reference/createtoken"},{"title":"Get a token by ID","deprecated":null,"version":null,"sidebarTitle":"Get a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/gettoken"},{"title":"Delete a token by ID","deprecated":null,"version":null,"sidebarTitle":"Delete a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/deletetoken"},{"title":"Get a token by reference","deprecated":null,"version":null,"sidebarTitle":"Get a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/gettokenfromprovider"},{"title":"Delete a token by reference","deprecated":null,"version":null,"sidebarTitle":"Delete a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/deletetokenfromprovider"}]},{"group":"BIN Lookup","pages":[{"title":"Get issuer info by BIN","deprecated":null,"version":null,"sidebarTitle":"Get issuer info by BIN","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/binLookup/{bin}","href":"/reference/getbinlookup"}]},{"group":"API Logs","pages":[{"title":"Search \u0026 list API Logs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list API Logs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs","href":"/reference/apilogs"},{"title":"Get an API Log event by ID","deprecated":null,"version":null,"sidebarTitle":"Get an API Log event by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs/{apiLogEventId}","href":"/reference/getapilogevent"}]},{"group":"Fraud Checks","pages":[{"title":"Search \u0026 list Fraud checks","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Fraud checks","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds","href":"/reference/listfraudchecks"},{"title":"Get Fraud check by ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud check by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}","href":"/reference/getfraud"},{"title":"Get Fraud Operations by Fraud ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operations by Fraud ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations","href":"/reference/getfraudoperations"},{"title":"Get Fraud Operation Logs by Fraud Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operation Logs by Fraud Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations/{fraudOperationId}/logs","href":"/reference/getfraudoperationlogs"}]},{"group":"3D Secure","pages":[{"title":"Search \u0026 list ThreeDS entities","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list ThreeDS entities","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds","href":"/reference/listthreeds"},{"title":"Get ThreeDS authentication by ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS authentication by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}","href":"/reference/getthreeds"},{"title":"Get ThreeDS Operations by ThreeDS ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operations by ThreeDS ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operations","href":"/reference/getthreedsoperations"},{"title":"Get ThreeDS Operation Logs by ThreeDS Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operation Logs by ThreeDS Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operation/{threeDSOperationId}/logs","href":"/reference/getthreedsoperationlogs"}]}]},{"group":"Provider","pages":[{"group":"Providers","pages":[{"title":"Search \u0026 list providers","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list providers","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers","href":"/reference/listproviders"},{"title":"Get provider by ID","deprecated":null,"version":null,"sidebarTitle":"Get provider by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}","href":"/reference/getprovider"}]},{"group":"Provider Configs","pages":[{"title":"List active provider configs","deprecated":null,"version":null,"sidebarTitle":"List active provider configs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/configs","href":"/reference/listactiveproviderconfigs"},{"title":"List Provider Configs by Provider","deprecated":null,"version":null,"sidebarTitle":"List Provider Configs by Provider","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs","href":"/reference/listproviderconfigs"},{"title":"Create a provider config","deprecated":null,"version":null,"sidebarTitle":"Create a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs","href":"/reference/createproviderconfig"},{"title":"Create a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Create a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/authenticated","href":"/reference/createauthenticatedproviderconfig"},{"title":"Provider config by ID","deprecated":null,"version":null,"sidebarTitle":"Provider config by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/providerconfiggetbyid"},{"title":"Update a provider config","deprecated":null,"version":null,"sidebarTitle":"Update a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/updateproviderconfig"},{"title":"Update a provider config status","deprecated":null,"version":null,"sidebarTitle":"Update a provider config status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/patchproviderconfig"},{"title":"Update a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Update a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}/authenticated","href":"/reference/updateauthenticatedproviderconfig"},{"title":"Create a provider config onboarding URL","deprecated":null,"version":null,"sidebarTitle":"Create a provider config onboarding URL","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url","href":"/reference/createproviderconfigonboardingurl"}]}]},{"group":"Merchant","pages":[{"group":"Rulesets","pages":[{"title":"List Rulesets","deprecated":null,"version":null,"sidebarTitle":"List Rulesets","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets","href":"/reference/listrulesets"},{"title":"Create a new Ruleset","deprecated":null,"version":null,"sidebarTitle":"Create a new Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/rulesets","href":"/reference/createruleset"},{"title":"Update a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Update a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/rulesets/{rulesetId}","href":"/reference/updateruleset"},{"title":"Get a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Get a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets/{rulesetId}/versions/{version}","href":"/reference/getruleset"}]},{"group":"Holders","pages":[{"title":"Search \u0026 list holders","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list holders","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders","href":"/reference/listholders"},{"title":"Create a holder","deprecated":null,"version":null,"sidebarTitle":"Create a holder","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/holders","href":"/reference/createholder"},{"title":"Get a holder by ID","deprecated":null,"version":null,"sidebarTitle":"Get a holder by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders/{holderId}","href":"/reference/getholder"}]},{"group":"Workspaces","pages":[{"title":"Fetch a list of workspaces","deprecated":null,"version":null,"sidebarTitle":"Fetch a list of workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces","href":"/reference/getallworkspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"sidebarTitle":"Create a workspace","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces","href":"/reference/createworkspace"},{"title":"Create workspaces","deprecated":null,"version":null,"sidebarTitle":"Create workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces/bulk-create","href":"/reference/createworkspaces"},{"title":"Get a workspace by ID","deprecated":null,"version":null,"sidebarTitle":"Get a workspace by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces/{workspaceId}","href":"/reference/getworkspace"}]},{"group":"Drop-in Links","pages":[{"title":"List drop-in links","deprecated":null,"version":null,"sidebarTitle":"List drop-in links","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks","href":"/reference/listdropinlinks"},{"title":"Create a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Create a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/dropInLinks","href":"/reference/createdropinlink"},{"title":"Get a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Get a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks/{dropInLinkId}","href":"/reference/getdropinlink"},{"title":"Delete a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Delete a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /merchant/dropInLinks/{dropInLinkId}","href":"/reference/deletedropinlink"}]},{"group":"Apple Pay","pages":[{"title":"List Apple Pay web domains","deprecated":null,"version":null,"sidebarTitle":"List Apple Pay web domains","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/applepay/web/domains","href":"/reference/listapplepaywebdomains"},{"title":"Register an Apple Pay web domain","deprecated":null,"version":null,"sidebarTitle":"Register an Apple Pay web domain","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/applepay/web/domains","href":"/reference/registerapplepaywebdomain"}]}]},{"group":"Vault","pages":[{"group":"Vault Instant Proxy","pages":[{"title":"Execute an instant proxy request","deprecated":null,"version":null,"sidebarTitle":"Execute an instant proxy request","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/proxy","href":"/reference/vaultproxy"}]},{"group":"Vault Proxy Connections","pages":[{"title":"Filter \u0026 list connections","deprecated":null,"version":null,"sidebarTitle":"Filter \u0026 list connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections","href":"/reference/listconnections"},{"title":"Create a connection","deprecated":null,"version":null,"sidebarTitle":"Create a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections","href":"/reference/createvaultconnections"},{"title":"Invoke an outbound proxy connection","deprecated":null,"version":null,"sidebarTitle":"Invoke an outbound proxy connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/proxy","href":"/reference/outboundconnectioninvocation"},{"title":"Get connection details","deprecated":null,"version":null,"sidebarTitle":"Get connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}","href":"/reference/getconnection"},{"title":"Delete a connection","deprecated":null,"version":null,"sidebarTitle":"Delete a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/connections/{connectionId}","href":"/reference/deleteconnection"},{"title":"Update connection details","deprecated":null,"version":null,"sidebarTitle":"Update connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /token/connections/{connectionId}","href":"/reference/updateconnection"},{"title":"List connection versions for connection","deprecated":null,"version":null,"sidebarTitle":"List connection versions for connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions","href":"/reference/listconnectionversions"},{"title":"Create a new version of a connection","deprecated":null,"version":null,"sidebarTitle":"Create a new version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/versions","href":"/reference/createvaultconnectionversions"},{"title":"Get connection version details","deprecated":null,"version":null,"sidebarTitle":"Get connection version details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions/{connectionVersionId}","href":"/reference/connectionversiondetail"},{"title":"Set live version of a connection","deprecated":null,"version":null,"sidebarTitle":"Set live version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /token/connections/{connectionId}/versions/live","href":"/reference/setliveversion"}]},{"group":"Vault Records and Aliases","pages":[{"title":"Tokenize records","deprecated":null,"version":null,"sidebarTitle":"Tokenize records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/tokenize","href":"/reference/tokenizerecords"},{"title":"Detokenize records and aliases","deprecated":null,"version":null,"sidebarTitle":"Detokenize records and aliases","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/detokenize","href":"/reference/detokenizerecords"},{"title":"Get field details by alias","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields/{alias}","href":"/reference/fieldbyalias"},{"title":"Delete field by alias","deprecated":null,"version":null,"sidebarTitle":"Delete field by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/fields/{alias}","href":"/reference/deletefieldbyalias"},{"title":"Get field details by alias list","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias list","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields","href":"/reference/fieldsinfobyaliases"},{"title":"Get record and its fields by ID","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/{recordId}","href":"/reference/getrecord"},{"title":"Delete record by ID","deprecated":null,"version":null,"sidebarTitle":"Delete record by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}","href":"/reference/deleterecord"},{"title":"Delete field by record ID and type","deprecated":null,"version":null,"sidebarTitle":"Delete field by record ID and type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}/fields/{fieldType}","href":"/reference/deletefieldbyrecordidandtype"},{"title":"Get record and its fields by alias","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records","href":"/reference/getrecordbyalias"},{"title":"Delete a record by the alias of one of its fields","deprecated":null,"version":null,"sidebarTitle":"Delete a record by the alias of one of its fields","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records","href":"/reference/deleterecordbyalias"},{"title":"Get record and aliases for a given instrumentId.","deprecated":null,"version":null,"sidebarTitle":"Get record and aliases for a given instrumentId.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/instruments/{instrumentId}/records","href":"/reference/recordsforinstrument"}]},{"group":"Vault Display SDK","pages":[{"title":"Initialize a Vault Client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a Vault Client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/client/init","href":"/reference/vaultclientinit"}]},{"group":"Vault Public Encryption","pages":[{"title":"Get a public encryption key for tokenization","deprecated":null,"version":null,"sidebarTitle":"Get a public encryption key for tokenization","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/vault/info","href":"/reference/vaultpublicinfo"}]}]},{"group":"Analytics","pages":[{"group":"Files","pages":[{"title":"Get file by ID.","deprecated":null,"version":null,"sidebarTitle":"Get file by ID.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/files/{fileId}","href":"/reference/getfilebyid"},{"title":"Get a URL for file upload.","deprecated":null,"version":null,"sidebarTitle":"Get a URL for file upload.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/files/upload","href":"/reference/fileupload"}]}]},{"group":"Reporting","pages":[{"group":"Reports","pages":[{"title":"Search \u0026 list reports","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list reports","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports","href":"/reference/getreports"},{"title":"Get a report by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports/{reportId}","href":"/reference/getreport"}]},{"group":"Report Runs","pages":[{"title":"Search \u0026 list report runs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list report runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns","href":"/reference/listreportruns"},{"title":"Create a report run","deprecated":null,"version":null,"sidebarTitle":"Create a report run","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/reportRuns","href":"/reference/createreportrun"},{"title":"Get a report run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns/{reportRunId}","href":"/reference/getreportrun"}]}]},{"group":"Reconciliation","pages":[{"group":"Reconciliation Records","pages":[{"title":"Bulk manually reconcile records","deprecated":null,"version":null,"sidebarTitle":"Bulk manually reconcile records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /reconciliation/records/reconcile","href":"/reference/bulkmanualreconcilerecords"}]}]},{"group":"Dispute","pages":[{"group":"Disputes","pages":[{"title":"Search \u0026 list Disputes","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes","href":"/reference/listdisputes"},{"title":"Bulk Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Bulk Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/tags-bulk","href":"/reference/bulkreplacedisputetagsbytype"},{"title":"Bulk Attach Tags to Disputes","deprecated":null,"version":null,"sidebarTitle":"Bulk Attach Tags to Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/tags-bulk","href":"/reference/bulkattachdisputetags"},{"title":"List dispute service runs","deprecated":null,"version":null,"sidebarTitle":"List dispute service runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs","href":"/reference/listdisputeruns"},{"title":"Get a dispute service run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a dispute service run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs/{runId}","href":"/reference/getdisputerun"},{"title":"List Dispute Alert Enrollments","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Enrollments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments","href":"/reference/listdisputealertenrollments"},{"title":"Enroll Descriptors for Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Enroll Descriptors for Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments","href":"/reference/enrolldisputealert"},{"title":"List Enrollment Descriptors","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Descriptors","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/listenrollmentdescriptors"},{"title":"Add Descriptors to Enrollment","deprecated":null,"version":null,"sidebarTitle":"Add Descriptors to Enrollment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/adddescriptorstoenrollment"},{"title":"Unenroll a Descriptor","deprecated":null,"version":null,"sidebarTitle":"Unenroll a Descriptor","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors/{descriptorId}/unenroll","href":"/reference/unenrollenrollmentdescriptor"},{"title":"List Enrollment Events","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/events","href":"/reference/listenrollmentevents"},{"title":"Search \u0026 list Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts","href":"/reference/listdisputealerts"},{"title":"Get Dispute Alert by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Alert by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}","href":"/reference/getdisputealert"},{"title":"Action a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Action a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/action","href":"/reference/actiondisputealert"},{"title":"Manually Match a Payment to a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Manually Match a Payment to a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/match","href":"/reference/matchdisputealertpayment"},{"title":"Refund a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Refund a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/refund","href":"/reference/refunddisputealert"},{"title":"List Dispute Alert Events","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}/events","href":"/reference/listdisputealertevents"},{"title":"List evidence library documents","deprecated":null,"version":null,"sidebarTitle":"List evidence library documents","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents","href":"/reference/listevidencedocuments"},{"title":"Add an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Add an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents","href":"/reference/createevidencedocument"},{"title":"Get an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Get an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}","href":"/reference/getevidencedocument"},{"title":"Add a version to an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Add a version to an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions","href":"/reference/addevidencedocumentversion"},{"title":"Archive an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Archive an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/archive","href":"/reference/archiveevidencedocument"},{"title":"Get Dispute by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}","href":"/reference/getdispute"},{"title":"Defend a Dispute","deprecated":null,"version":null,"sidebarTitle":"Defend a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/defend","href":"/reference/defenddispute"},{"title":"Accept a Dispute","deprecated":null,"version":null,"sidebarTitle":"Accept a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/accept","href":"/reference/acceptdispute"},{"title":"Get Dispute Activities by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Activities by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/activities","href":"/reference/getdisputeactivities"},{"title":"Get Dispute Documents by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Documents by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/documents","href":"/reference/getdisputedocuments"},{"title":"Search \u0026 list Evidences","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences","href":"/reference/listdisputeevidences"},{"title":"Upload evidence files","deprecated":null,"version":null,"sidebarTitle":"Upload evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences","href":"/reference/uploaddisputeevidence"},{"title":"Attach an evidence library document to a dispute","deprecated":null,"version":null,"sidebarTitle":"Attach an evidence library document to a dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/library","href":"/reference/attachevidencedocumenttodispute"},{"title":"Submit evidence files","deprecated":null,"version":null,"sidebarTitle":"Submit evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit","href":"/reference/submitdisputeevidence"},{"title":"Submit representment plan evidences","deprecated":null,"version":null,"sidebarTitle":"Submit representment plan evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit-plan","href":"/reference/submitdisputerepresentmentplanevidences"},{"title":"Generate representment plan","deprecated":null,"version":null,"sidebarTitle":"Generate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-plan","href":"/reference/generatedisputerepresentmentplan"},{"title":"Regenerate representment plan","deprecated":null,"version":null,"sidebarTitle":"Regenerate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/regenerate-plan","href":"/reference/regeneratedisputerepresentmentplan"},{"title":"Edit representment sections","deprecated":null,"version":null,"sidebarTitle":"Edit representment sections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/evidences/representment-sections","href":"/reference/editdisputerepresentmentsections"},{"title":"Rewrite representment text","deprecated":null,"version":null,"sidebarTitle":"Rewrite representment text","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/representment-sections/rewrite","href":"/reference/rewritedisputerepresentmenttext"},{"title":"Generate representment PDF","deprecated":null,"version":null,"sidebarTitle":"Generate representment PDF","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-representment","href":"/reference/generatedisputerepresentmentpdf"},{"title":"Download the representment evidence bundle","deprecated":null,"version":null,"sidebarTitle":"Download the representment evidence bundle","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/download","href":"/reference/downloadrepresentmentbundle"},{"title":"Download an evidence file by ID","deprecated":null,"version":null,"sidebarTitle":"Download an evidence file by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/{evidenceId}","href":"/reference/downloaddisputeevidence"},{"title":"Edit what a dispute's evidence shows","deprecated":null,"version":null,"sidebarTitle":"Edit what a dispute's evidence shows","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/disputes/{disputeId}/evidences/{evidenceId}/reading","href":"/reference/editdisputeevidencereading"},{"title":"Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/tags","href":"/reference/replacedisputetagsbytype"},{"title":"Attach Tags to a Dispute","deprecated":null,"version":null,"sidebarTitle":"Attach Tags to a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/tags","href":"/reference/attachdisputetags"},{"title":"Detach a Tag from a Dispute","deprecated":null,"version":null,"sidebarTitle":"Detach a Tag from a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/disputes/{disputeId}/tags/{tagId}","href":"/reference/detachdisputetag"},{"title":"List Tags","deprecated":null,"version":null,"sidebarTitle":"List Tags","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/tags","href":"/reference/listtags"},{"title":"Create Tag","deprecated":null,"version":null,"sidebarTitle":"Create Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/tags","href":"/reference/createtag"},{"title":"Delete Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/tags/{tagId}","href":"/reference/deletetag"},{"title":"Update Tag","deprecated":null,"version":null,"sidebarTitle":"Update Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/tags/{tagId}","href":"/reference/updatetag"}]}]}]}]},"title":"Search \u0026 list events - Payrails Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}