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.
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.
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.
Capture mode to define if money is captured instantly, with delay or manually.
Available options:
Instant,
Delayed,
Manual
{"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":"6ae1da2929bef1b4b420c438","collectionId":"29f28411-48f7-4bc8-9e4f-92d0104a5f9e","liveDeploymentHistoryId":"6ae1da2929bef1b4b420c438","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1da2929bef1b4b420c438","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Guides","count":362},{"language":"default","tag":"Payment Orchestration","count":278},{"language":"default","tag":"API Reference","count":175},{"language":"default","tag":"Payment Methods","count":143},{"language":"default","tag":"Integrations","count":63},{"language":"default","tag":"Dispute","count":46},{"language":"default","tag":"Disputes","count":46},{"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}},"isAtlas":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/listrulesets","slug":"/reference/listrulesets","pageMetadata":{"title":"List Rulesets","description":"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.","deprecated":null,"version":null,"sidebarTitle":"List Rulesets","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets","href":"/reference/listrulesets","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: \"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset’s trigger, rules, and default action.\"\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":"List Rulesets","description":"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.","deprecated":null,"version":null,"sidebarTitle":"List Rulesets","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets","href":"/reference/listrulesets","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":"List Rulesets","x-mint":{"metadata":{"description":"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.","sidebarTitle":"List Rulesets"},"href":"/reference/listrulesets"},"operationId":"listRulesets","description":"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.","tags":["Rulesets"],"security":["27acbd92-0f82-4f2d-ad09-521ef45592f2"],"parameters":["57166b4a-43d0-4bc3-8d74-b57247821084","b1a6b7bb-f821-4d6f-b2aa-2421fb0770eb","64219dbb-b206-43c9-b8ef-a4414276b125","876346ff-7c54-43b8-a9f5-79b6a4008a67","47740314-1c20-4dba-9b29-bdab91404e12","faedadce-d842-4437-9ca6-a81df866bf92"],"responses":{"200":"0332c52c-dbb0-48d6-9964-35b3caf22772","400":"0b1be834-19ba-410b-a32e-00132afb75c7","401":"82ddc140-bcfc-4827-a7fd-bd893c18d9b4","403":"cde92066-fbd0-411b-8ecc-2f254af39c2b","429":"67cf0a29-75dc-4c54-96d2-67e82b50b95a"},"method":"get","type":"path","servers":["f2e96af1-11e0-49a4-9f88-a1657eabbf91"],"path":"/merchant/rulesets","baseUrlOptions":["https://api.staging.payrails.io"],"title":"List Rulesets","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"57166b4a-43d0-4bc3-8d74-b57247821084":{"name":"page[after]","in":"query","description":"Search collection items after that cursor.","required":false,"schema":{"type":"string","description":"Search collection items after that cursor.\nCursor for paging results.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"example":"xk2h55zsy5"},"b1a6b7bb-f821-4d6f-b2aa-2421fb0770eb":{"name":"page[before]","in":"query","description":"Search collection items before that cursor.","required":false,"schema":{"type":"string","description":"Search collection items before that cursor.\nCursor for paging results.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"example":"9wkueqcavq"},"64219dbb-b206-43c9-b8ef-a4414276b125":{"name":"page[size]","in":"query","description":"Length of the collection to search.","required":false,"schema":{"type":"integer","format":"int32","isRequired":false,"description":"Length of the collection to search.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"example":20},"876346ff-7c54-43b8-a9f5-79b6a4008a67":{"name":"filter[createdAt]","in":"query","description":"Filter by `createdAt` field using interval notation.\n\n`1973-02-03T04:32:11.596Z` - exact date value\n\n`(1973-02-03T04:32:11.596Z` - after the date excluding it\n\n`[1973-02-03T04:32:11.596Z` - after the date including it\n\n`1973-02-03T04:32:11.596Z)` - before the date excluding it\n\n`1973-02-03T04:32:11.596Z]` - before the date including it\n\n`(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding both\n\n`(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates excluding on the left\n\n`[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding on the right\n\n`[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates including both.\n","schema":{"type":"string","example":"[2026-04-01T00:00:00Z,2026-05-01T00:00:00Z)","description":"Filter by `createdAt` field using interval notation.\n\n`1973-02-03T04:32:11.596Z` - exact date value\n\n`(1973-02-03T04:32:11.596Z` - after the date excluding it\n\n`[1973-02-03T04:32:11.596Z` - after the date including it\n\n`1973-02-03T04:32:11.596Z)` - before the date excluding it\n\n`1973-02-03T04:32:11.596Z]` - before the date including it\n\n`(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding both\n\n`(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates excluding on the left\n\n`[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z)` - between two dates excluding on the right\n\n`[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z]` - between two dates including both.\n","uniqueKey":"","typeLabel":"string"}},"47740314-1c20-4dba-9b29-bdab91404e12":{"name":"filter[id]","in":"query","schema":{"type":"string","description":"Filter for a list of rulesets by id.","uniqueKey":"","typeLabel":"string"},"description":"Filter for a list of rulesets by id."},"faedadce-d842-4437-9ca6-a81df866bf92":{"name":"filter[workspaceId]","in":"query","description":"Filter by Workspace ID.","schema":{"type":"string","description":"Filter by Workspace ID.","uniqueKey":"","typeLabel":"string"}}},"responses":{"0332c52c-dbb0-48d6-9964-35b3caf22772":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","required":["links","results"],"properties":{"links":{"required":["self"],"properties":{"self":{"type":"string","isRequired":true,"uniqueKey":"links.self","typeLabel":"string"},"prev":{"type":"string","uniqueKey":"links.prev","typeLabel":"string"},"next":{"type":"string","uniqueKey":"links.next","typeLabel":"string"},"first":{"type":"string","uniqueKey":"links.first","typeLabel":"string"},"last":{"type":"string","uniqueKey":"links.last","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"links","typeLabel":"object"},"results":{"type":"array","items":{"type":"object","title":"Ruleset","required":["id","version","workspaceId","trigger","defaultAction"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of Ruleset.","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"version":{"type":"number","description":"Ruleset version.","isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].trigger.filter.oneOf.0.paymentMethodCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.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":"results.items.[INDEX].trigger.filter.oneOf.1.workflowNode","typeLabel":"enum\u003cstring>"},"providerConfigId":{"type":"string","format":"uuid","description":"Unique identifier of the provider config.","uniqueKey":"results.items.[INDEX].trigger.filter.oneOf.1.providerConfigId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"results.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":"results.items.[INDEX].trigger.filter.oneOf.2.workflowNode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].trigger.filter.oneOf.2","typeLabel":"Action `repeat` filter · object"}],"uniqueKey":"results.items.[INDEX].trigger.filter","typeLabel":"Action `determinePaymentOptions` filter · object | Action `determineProviderOptions` filter · object | Action `repeat` filter · object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.0.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.0.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.1.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.1.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].defaultAction.oneOf.2.type","typeLabel":"enum\u003cstring>"},"params":{"type":"object","properties":{"delay":{"type":"string","format":"ISO 8601","description":"Delay.","uniqueKey":"results.items.[INDEX].defaultAction.oneOf.2.params.delay","typeLabel":"string\u003cISO 8601>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.2.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.3.params.priority","typeLabel":"number"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.3.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].defaultAction.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].defaultAction.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.6.params.futureUsage","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.6.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.7.params.mapping.items.[INDEX]","typeLabel":"Field mapping · object"},"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.7.params.mapping","typeLabel":"Field mapping · object[]"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.7.params","typeLabel":"Add next step parameters · object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].defaultAction.oneOf.8.params.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.8.params","typeLabel":"Add workflow execution status parameters · object"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].defaultAction.oneOf.8","typeLabel":"Add workflow execution status · object"}],"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.0.empty","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.value.oneOf.3","typeLabel":"(string | number)[]"}],"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.1.referenceField","typeLabel":"string"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.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":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value.oneOf.3","typeLabel":"(string | number)[]"}],"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.2.value","typeLabel":"string | number | boolean | (string | number)[]"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.3.right","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.4.condition","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].condition.oneOf.4","typeLabel":"Condition negation · object"}],"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.0.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.0.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.1.params.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.1.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.2.params.delay","typeLabel":"string\u003cISO 8601>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.2.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.3.params.priority","typeLabel":"number"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.3.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.6.params.futureUsage","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.6.params","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.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":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping.items.[INDEX]","typeLabel":"Field mapping · object"},"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params.mapping","typeLabel":"Field mapping · object[]"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.7.params","typeLabel":"Add next step parameters · object"}},"isRequired":true,"uniqueKey":"results.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":"results.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":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.8.params.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.8.params","typeLabel":"Add workflow execution status parameters · object"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].rules.items.[INDEX].action.oneOf.8","typeLabel":"Add workflow execution status · object"}],"isRequired":true,"uniqueKey":"results.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":"results.items.[INDEX].rules.items.[INDEX]","typeLabel":"Rule · object"},"uniqueKey":"results.items.[INDEX].rules","typeLabel":"Rule · object[]"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"Ruleset · object"},"isRequired":true,"uniqueKey":"results","typeLabel":"Ruleset · object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"links":{"self":"https://api.staging.payrails.io/merchant/rulesets?page[after]=qf7pnbyfrr\u0026page[size]=2","prev":"https://api.staging.payrails.io/merchant/rulesets?page[before]=hbe66nh8i8\u0026page[size]=2","next":"https://api.staging.payrails.io/merchant/rulesets?page[after]=xk2h55zsy5\u0026page[size]=2","first":"https://api.staging.payrails.io/merchant/rulesets?page[size]=2","last":"https://api.staging.payrails.io/merchant/rulesets?page[before]=9wkueqcavq\u0026page[size]=2"},"results":[{"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"}},{"id":"1f3cb3c4-3d8d-4f3c-94ad-30a0a17fde6d","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","version":1,"createdAt":"2022-11-10T14:13:01.85472022Z","trigger":{"on":"determineProviderOptions","filter":{"providerConfigId":"5eb08624-ecce-4cbc-9a8a-61d484172815"}},"defaultAction":{"type":"setPriority","params":{"priority":1}}},{"id":"0dcaf001-32a0-40ee-972c-523f5070e5e3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","version":1,"createdAt":"2022-11-10T14:13:01.85472022Z","trigger":{"on":"determineProviderOptions","filter":{"workflowNode":"authorize","providerConfigId":"1f3cb3c4-3d8d-4f3c-94ad-30a0a17fde6d"}},"rules":[{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":3}}}],"defaultAction":{"type":"setPriority","params":{"priority":2}}}]},"examples":{"Example":{"title":"Example","value":{"links":{"self":"https://api.staging.payrails.io/merchant/rulesets?page[after]=qf7pnbyfrr\u0026page[size]=2","prev":"https://api.staging.payrails.io/merchant/rulesets?page[before]=hbe66nh8i8\u0026page[size]=2","next":"https://api.staging.payrails.io/merchant/rulesets?page[after]=xk2h55zsy5\u0026page[size]=2","first":"https://api.staging.payrails.io/merchant/rulesets?page[size]=2","last":"https://api.staging.payrails.io/merchant/rulesets?page[before]=9wkueqcavq\u0026page[size]=2"},"results":[{"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"}},{"id":"1f3cb3c4-3d8d-4f3c-94ad-30a0a17fde6d","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","version":1,"createdAt":"2022-11-10T14:13:01.85472022Z","trigger":{"on":"determineProviderOptions","filter":{"providerConfigId":"5eb08624-ecce-4cbc-9a8a-61d484172815"}},"defaultAction":{"type":"setPriority","params":{"priority":1}}},{"id":"0dcaf001-32a0-40ee-972c-523f5070e5e3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","version":1,"createdAt":"2022-11-10T14:13:01.85472022Z","trigger":{"on":"determineProviderOptions","filter":{"workflowNode":"authorize","providerConfigId":"1f3cb3c4-3d8d-4f3c-94ad-30a0a17fde6d"}},"rules":[{"condition":{"field":"customer.country.code","operator":"=","value":"DE"},"action":{"type":"setPriority","params":{"priority":3}}}],"defaultAction":{"type":"setPriority","params":{"priority":2}}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0b1be834-19ba-410b-a32e-00132afb75c7":{"description":"Bad Request.","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.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"82ddc140-bcfc-4827-a7fd-bd893c18d9b4":{"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"},"cde92066-fbd0-411b-8ecc-2f254af39c2b":{"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"},"67cf0a29-75dc-4c54-96d2-67e82b50b95a":{"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":{"27acbd92-0f82-4f2d-ad09-521ef45592f2":{"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":["rulesets:list"],"schemeName":"BearerToken"}}},"servers":{"f2e96af1-11e0-49a4-9f88-a1657eabbf91":{"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":["rulesets:list"],"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":"List Rulesets - Payrails Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"reference/listrulesets.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=\"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset\u0026#x27;s trigger, rules, and default action.\">\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=\"List Rulesets - Payrails Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset\u0026#x27;s trigger, rules, and default action.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payrails Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payrails.com/reference/listrulesets\">\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=Rulesets\u0026amp;title=List+Rulesets\u0026amp;description=List+your+rulesets+with+pagination%2C+filtering+by+ruleset+ID%2C+workspace+ID%2C+or+creation+date%2C+with+each+ruleset%27s+trigger%2C+rules%2C+and+default+action.\u0026amp;theme=8d26c0ee63969d79a6f2d462\u0026amp;signature=22ee09d6e6be11306e531ed0bbb4e3bfd483c96e2b8886e303d1205b20e2ff20\">\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=\"List Rulesets - Payrails Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset\u0026#x27;s trigger, rules, and default action.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payrails-42074109.mintlify.app/_mintlify/api/og/v2?division=Rulesets\u0026amp;title=List+Rulesets\u0026amp;description=List+your+rulesets+with+pagination%2C+filtering+by+ruleset+ID%2C+workspace+ID%2C+or+creation+date%2C+with+each+ruleset%27s+trigger%2C+rules%2C+and+default+action.\u0026amp;theme=8d26c0ee63969d79a6f2d462\u0026amp;signature=22ee09d6e6be11306e531ed0bbb4e3bfd483c96e2b8886e303d1205b20e2ff20\">\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/listrulesets\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/listrulesets.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/listrulesets#webpage\",\"url\":\"https://docs.payrails.com/reference/listrulesets\",\"name\":\"List Rulesets\",\"description\":\"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.\",\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payrails.com/reference/listrulesets#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payrails.com/reference/listrulesets#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payrails Docs\",\"item\":\"https://docs.payrails.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Rulesets\",\"item\":\"https://docs.payrails.com/reference/listrulesets\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payrails.com/reference/listrulesets#apireference\",\"headline\":\"List Rulesets\",\"name\":\"List Rulesets\",\"description\":\"List your rulesets with pagination, filtering by ruleset ID, workspace ID, or creation date, with each ruleset's trigger, rules, and default action.\",\"url\":\"https://docs.payrails.com/reference/listrulesets\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payrails.com/reference/listrulesets#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","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","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","description":"Generate a redirect onboarding URL for a provider config from your return URL, and if the config does not exist yet, reuse its ID when you create it.","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","description":"Create a ruleset to determine payment or provider options in a workflow, with a trigger, rules to evaluate, and a default action if no rule matches.","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":"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":"List Rulesets - Payrails Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}