{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Gr4vy","colors":{"primary":"#0066CC","light":"#0099FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99","dark":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=7a09594217c27f95e0d127250c4cc958"},"favicon":"https://mintcdn.com/flexxbuy/39tfKGesfNHyX7HE/assets/favicon.png?fit=max\u0026auto=format\u0026n=39tfKGesfNHyX7HE\u0026q=85\u0026s=fc89afd637da9116e218f41f2c6b1105","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["csharp","go","java","php","python","javascript","curl"]},"mdx":{"auth":{"method":"bearer"},"server":["https://api.sandbox.flexxbuy.gr4vy.app","https://api.flexxbuy.gr4vy.app"]}},"navbar":{"links":[{"icon":"bell","href":"https://status.gr4vy.com","label":"Status"},{"icon":"github","href":"https://github.com/gr4vy","label":"GitHub"}],"primary":{"type":"button","label":"Gr4vy","href":"https://gr4vy.com/#form-contact"}},"footer":{"socials":{"website":"https://gr4vy.com","twitter":"https://twitter.com/Gr4vyInc","github":"https://github.com/gr4vy","linkedin":"https://www.linkedin.com/company/gr4vy-inc"},"links":[{"header":"About","items":[{"label":"Payment orchestration","href":"https://gr4vy.com/payment-orchestration"},{"label":"Gr4vy for merchants","href":"https://gr4vy.com/merchants"},{"label":"Gr4vy for platforms","href":"https://gr4vy.com/platforms"},{"label":"Increasing your revenue","href":"https://gr4vy.com/revenue"}]},{"header":"Developers","items":[{"label":"GitHub","href":"https://github.com/gr4vy"},{"label":"Latest news","href":"https://docs.gr4vy.com/updates"},{"label":"System status","href":"https://status.gr4vy.com"},{"label":"Customer support","href":"https://support.gr4vy.com"}]}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"G-9CX4E9QWKQ"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexxbuy","hasAudioNarration":false,"actualSubdomain":"flexxbuy","customDomains":["docs.byzly.com"],"gitSource":{"type":"github","owner":"gr4vy","repo":"flexxbuy-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf64bc3d6319f7be041995","collectionId":"bdb65d06-a21b-40ca-800b-8b423f379e82","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf64bc3d6319f7be041995"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf64bc3d6319f7be041995","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Build","count":195},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Connections","count":168},{"language":"default","tag":"Methods","count":141},{"language":"default","tag":"Features","count":95},{"language":"default","tag":"Integration guides","count":91},{"language":"default","tag":"Banking","count":46},{"language":"default","tag":"Dashboard","count":44},{"language":"default","tag":"Other","count":39},{"language":"default","tag":"Embed","count":38}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".payment-service-definition{background-color:#fff!important;border:1px solid #0a0e0d1a;border-radius:16px;padding:2em;vertical-align:middle}.payment-service-definition img{margin:0 1em 0 0;max-width:3em;display:inline-block}.payment-service-definition h2{margin:0;display:inline-block;position:relative;top:.1em}#sidebar-title{text-transform:uppercase}#sidebar-group .group{flex-direction:row-reverse}#footer .max-w-36{max-width:40rem}"}],"page":{"pagePath":"reference/flow/list-rules","slug":"/reference/flow/list-rules","pageMetadata":{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","description":"Returns a list of rules for a given flow. Each rule has an\nassociated action, conditions, and outcome.","href":"/reference/flow/list-rules"},"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: \"Returns a list of rules for a given flow. Each rule has an\\nassociated action, conditions, and outcome.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`This endpoint requires the `,_jsx(_components.code,{children:`flows.read`}),` scope.`]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","description":"Returns a list of rules for a given flow. Each rule has an\nassociated action, conditions, and outcome.","href":"/reference/flow/list-rules"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"list-flow-rules","summary":"List flow rules","description":"Returns a list of rules for a given flow. Each rule has an\nassociated action, conditions, and outcome.","tags":["Flow"],"x-internal":true,"responses":{"200":"e5c4fd75-6f5c-40ee-9ea3-720cc6eddbf8","401":"799ba18b-64e5-4605-a37e-ce61c863c706"},"method":"get","type":"path","servers":["687beca7-453b-424d-a360-eaca1398b8d8","578272f1-d32a-4d53-8e16-3dc13be44c34"],"security":["6c6223af-e151-4dcc-8f35-88257b966832"],"path":"/flows/{flow}","baseUrlOptions":["https://api.sandbox.{id}.gr4vy.app","https://api.{id}.gr4vy.app"],"title":"List flow rules","codeSamples":[],"requestExampleLanguages":["csharp","go","java","php","python","javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d9fa1a04-8f1a-4415-8ead-3d261b77ce46":{"schema":{"type":"string","description":"The flow name. This can be one of the following.\n\n- `checkout` - Applies during checkout to determine what payment options are shown.\n- `card-transaction` - Applies when processing a card transaction.\n- `non-card-transaction` - Applies when processing a gift card only transaction, or a\nredirect transaction using the `decline-early` action.\n- `redirect-transaction` - Applies when processing any other transaction.\nThe name of the Flow.","example":"checkout","enum":["checkout","card-transaction","non-card-transaction","redirect-transaction"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"name":"flow","in":"path","required":true,"description":"The flow name. This can be one of the following.\n\n- `checkout` - Applies during checkout to determine what payment options are shown.\n- `card-transaction` - Applies when processing a card transaction.\n- `non-card-transaction` - Applies when processing a gift card only transaction, or a\nredirect transaction using the `decline-early` action.\n- `redirect-transaction` - Applies when processing any other transaction."}},"responses":{"e5c4fd75-6f5c-40ee-9ea3-720cc6eddbf8":{"description":"Returns a list of rules.","content":{"application/json":{"schema":{"title":"Flow rules","type":"object","description":"A list of rule in a flow.","x-tags":["Flow"],"x-internal":true,"properties":{"items":{"type":"array","description":"A list of rules.","items":{"title":"Flow rule","type":"object","x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of this resource. Is always `rule`.","example":"rule","enum":["rule"],"uniqueKey":"\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","example":"fe26475d-ec3e-4884-9553-f7356683f7f9","description":"The unique Gr4vy ID for this rule.","format":"uuid","uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"merchant_account_id":{"type":"string","description":"The unique ID for a merchant account.","example":"default","uniqueKey":"\\items.items.[INDEX].merchant_account_id","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Description of the flow rule.","example":"example rule.","minLength":1,"maxLength":200,"uniqueKey":"\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the flow rule.","example":"example rule.","minLength":1,"maxLength":200,"uniqueKey":"\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string | null"},"flow":{"type":"string","description":"The name of the Flow.","example":"checkout","enum":["checkout","card-transaction","non-card-transaction","redirect-transaction"],"uniqueKey":"\\items.items.[INDEX].flow","typeLabel":"enum\u003cstring>"},"action":{"type":"string","description":"Action for the given rule. Actions can only be used in\nflows that support them.\n\n* The `checkout` flow only supports the\n`select-payment-options` action.\n* The `card-transaction` supports the `route-transaction`,\n`skip-3ds`, and `decline-early` actions.\n* The `non-card-transaction` flow only supports the\n`decline-early` action.\n* The `redirect-transaction` flow only supports\nthe `route-transaction` action.\n","example":"select-payment-options","enum":["select-payment-options","decline-early","route-transaction","skip-3ds"],"uniqueKey":"\\items.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"One or more conditions that apply for this rule. Each condition\nneeds to match for this rule to go into effect.","items":{"oneOf":[{"type":"object","title":"Flow amount condition","description":"Amount conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"amount","enum":["amount"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the currency code `value`.","example":"less_than","enum":["less_than","greater_than"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"object","description":"Amount value compare the transaction to.","properties":{"currency":{"type":"string","example":"USD","description":"Currency ISO codes to compare the transaction to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.currency","typeLabel":"string"},"value":{"type":"number","example":1,"minimum":0,"nullable":false,"description":"Amount value to compare transaction value to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.value","typeLabel":"number"}},"example":{"Amount condition value":{"value":{"description":"example amount value.","currency":"USD","value":100}}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0.value","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.0","typeLabel":"Flow amount condition · object"},{"type":"object","title":"Flow amount range condition","description":"Amount range conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"amount","enum":["amount"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the currency code `value`.","example":"is_between","enum":["is_between"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"object","description":"Amount value compare the transaction to.","properties":{"currency":{"type":"string","example":"USD","description":"Currency ISO codes to compare the transaction to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.value.currency","typeLabel":"string"},"min":{"type":"number","example":1,"minimum":0,"description":"Minimum value to compare transaction value to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.value.min","typeLabel":"number"},"max":{"type":"number","example":200,"minimum":0,"description":"Maximum value to compare transaction value to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.value.max","typeLabel":"number"}},"example":{"Amount condition value":{"value":{"description":"example amount value.","currency":"USD","min":1,"max":200}}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1.value","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.1","typeLabel":"Flow amount range condition · object"},{"type":"object","title":"Flow zero amount condition","description":"Amount conditions matching a value of 0 in any currency.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"amount_zero","enum":["amount_zero"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the transaction `value`.","example":"equal_to","enum":["equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"The value of the transaction must be 0.","example":0,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.2.value","typeLabel":"number"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.2","typeLabel":"Flow zero amount condition · object"},{"type":"object","title":"Flow anti-fraud decision condition","description":"Anti-fraud decision condition with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"anti_fraud_decision","enum":["anti_fraud_decision"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.3.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"A list of anti-fraud decisions to match.","example":["exception"],"items":{"type":"string","minLength":1,"enum":["accept","error","reject","review","exception","skipped"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.3.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.3.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.3","typeLabel":"Flow anti-fraud decision condition · object"},{"type":"object","title":"Flow BIN range condition","description":"BIN range conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_bin","enum":["card_bin"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.4.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `card_bin` `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.4.value.items.[INDEX]","typeLabel":"string"},"description":"BIN range to compare with the transaction. A card BIN is\n8 characters long at maximum.","example":["41410000-42429999"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.4.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.4","typeLabel":"Flow BIN range condition · object"},{"type":"object","title":"Flow browser language condition","description":"Browser language conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"browser_language","enum":["browser_language"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.5.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the browser language `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.5.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"Browser language two-letter ISO 639-1 codes to compare the transaction to.","example":["en","de","fr"],"items":{"maxLength":2,"minLength":2,"type":"string","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.5.value.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.5.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.5","typeLabel":"Flow browser language condition · object"},{"type":"object","title":"Flow card country condition","description":"Card country condition with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_country","enum":["card_country"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.6.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.6.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"Countries to compare the card originating country to\nin `ISO-3166` 2 character format.","example":["ES","GB"],"items":{"maxLength":2,"minLength":2,"type":"string","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.6.value.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.6.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.6","typeLabel":"Flow card country condition · object"},{"type":"object","title":"Flow card issuer name condition","description":"Card issuer name condition with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_issuer_name","enum":["card_issuer_name"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.7.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"like_one_of","enum":["like_one_of","unlike_any_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.7.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.7.value.items.[INDEX]","typeLabel":"string"},"description":"Issuer name(s) to compare the card issuer name to.\nValues can be a part of the full card's issuer name.\nThe comparison is case-insensitive.\nFor example, `Hsbc Uk Bank Plc` and `Pt Bank Hsbc Indonesia` will match `HSBC`.","example":["HSBC","Barclays"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.7.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.7","typeLabel":"Flow card issuer name condition · object"},{"type":"object","title":"Flow card product name condition","description":"Card product name condition with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_product_name","enum":["card_product_name"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.8.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"like_one_of","enum":["like_one_of","unlike_any_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.8.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.8.value.items.[INDEX]","typeLabel":"string"},"description":"Product name(s) to compare the card product name to.\nValues can be a part of the full card's product name.\nThe comparison is case-insensitive.\nFor example, `Platinum MasterCard` and `Visa Platinum` will match `platinum`.","example":["Electron","MasterCard Black"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.8.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.8","typeLabel":"Flow card product name condition · object"},{"type":"object","title":"Flow card scheme condition","description":"Card scheme conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_scheme","enum":["card_scheme"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.9.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.9.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"Card scheme(s) to compare the transaction to.","example":["visa","mastercard"],"items":{"type":"string","example":"visa","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","rupay","star","uatp","unionpay","visa",null],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.9.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.9.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.9","typeLabel":"Flow card scheme condition · object"},{"type":"object","title":"Flow card source condition","description":"Card source conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_source","enum":["card_source"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.10.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.10.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","minLength":1,"maxLength":50,"description":"Card sources to compare the transaction to.","enum":["applepay","googlepay","network-token","raw","token"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.10.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["raw","applepay"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.10.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.10","typeLabel":"Flow card source condition · object"},{"type":"object","title":"Flow card type condition","description":"Card type condition with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"card_type","enum":["card_type"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.11.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.11.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"Card type to compare the transaction to.","example":["credit"],"items":{"type":"string","minLength":1,"maxLength":50,"enum":["credit","debit","prepaid"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.11.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.11.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.11","typeLabel":"Flow card type condition · object"},{"type":"object","title":"Flow country condition","description":"Country conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"country","enum":["country"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.12.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the country code `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.12.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","description":"Country two-letter ISO codes to compare the transaction to.","example":["US","DE"],"items":{"maxLength":2,"minLength":2,"type":"string","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.12.value.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.12.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.12","typeLabel":"Flow country condition · object"},{"type":"object","title":"Flow currency condition","description":"Currency conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"currency","enum":["currency"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.13.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the currency code `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.13.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.13.value.items.[INDEX]","typeLabel":"string"},"description":"Currency ISO codes to compare the transaction to.","example":["USD","EUR","GBP"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.13.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.13","typeLabel":"Flow currency condition · object"},{"type":"object","title":"Flow is subsequent payment condition","description":"`is_subsequent_payment` flag conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"is_subsequent_payment","enum":["is_subsequent_payment"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.14.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `is_subsequent_payment` flag `value`.","example":"equal_to","enum":["equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.14.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"boolean","description":"`is_subsequent_payment` flag value to compare the transaction to.","example":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.14.value","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.14","typeLabel":"Flow is subsequent payment condition · object"},{"type":"object","title":"Flow metadata condition","description":"Metadata conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"metadata","enum":["metadata"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the currency code `value`.","example":"includes","enum":["includes","excludes"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"object","description":"The metadata to compare the transaction to.","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"example":"product","description":"Key to metadata value to compare transaction to.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value.key","typeLabel":"string"},"value":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value.value.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of metadata values to compare transaction to.","maxLength":128,"minLength":1,"example":["value1","value2"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value.value.oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Value of metadata to compare transaction to.","maxLength":255,"minLength":1,"example":"phone","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value.value.oneOf.1","typeLabel":"string"}],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value.value","typeLabel":"string[] | string"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15.value","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.15","typeLabel":"Flow metadata condition · object"},{"type":"object","title":"Flow metadata numeric condition","description":"Metadata conditions with a name, operator, and numeric value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The unique name of this condition.","example":"metadata_numeric","enum":["metadata_numeric"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The numeric comparison to evaluate.","example":"less_than","enum":["less_than","greater_than","equal_to","less_than_or_equal_to","greater_than_or_equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"object","description":"The metadata object to evaluate rules against.","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"example":"product","description":"The key of the metadata object you wish to compare.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16.value.key","typeLabel":"string"},"value":{"type":"number","example":100,"description":"The numeric value to compare against.","uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16.value.value","typeLabel":"number"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16.value","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.16","typeLabel":"Flow metadata numeric condition · object"},{"type":"object","title":"Flow merchant initiated condition","description":"`merchant_initiated` flag conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"merchant_initiated","enum":["merchant_initiated"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `merchant_initiated` flag `value`.","example":"equal_to","enum":["equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.17.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"boolean","description":"`merchant_initiated` flag value to compare the transaction to.","example":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.17.value","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.17","typeLabel":"Flow merchant initiated condition · object"},{"type":"object","title":"Flow payment method condition","description":"Payment method conditions with a name, operator, and value. This\ncondition is only for use with the `route-transaction` action.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"payment_method","enum":["payment_method"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.18.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"equal_to","enum":["equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.18.operator","typeLabel":"enum\u003cstring>"},"value":{"description":"The payment method to compare the transaction to.","example":"card","type":"string","enum":["affirm","afterpay","alipay","alipayhk","applepay","bacs","bancontact","banked","becs","bitpay","boleto","boost","card","cashapp","chaseorbital","checkout-session","clearpay","click-to-pay","dana","dcb","dlocal","ebanx","efecty","eps","everydaypay","gcash","gem","gemds","gift-card","giropay","givingblock","gocardless","googlepay","googlepay_pan_only","gopay","grabpay","id","ideal","kakaopay","kcp","klarna","latitude","latitudeds","laybuy","linepay","linkaja","maybankqrpay","mercadopago","multibanco","multipago","netbanking","network-token","oney_3x","oney_4x","oney_6x","oney_10x","oney_12x","ovo","oxxo","payid","paymaya","paypal","paypalpaylater","payto","venmo","pix","pse","rabbitlinepay","razorpay","scalapay","sepa","shopeepay","singteldash","smartpay","sofort","spei","stripedd","thaiqr","touchngo","truemoney","trustly","trustlyeurope","upi","vipps","waave","webpay","wechat","zippay"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.18.value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.18","typeLabel":"Flow payment method condition · object"},{"type":"object","title":"Flow payment methods condition","description":"Payment methods condition with a name, operator, and value. This\ncondition is only for use with the `decline-early` action.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"payment_method","enum":["payment_method"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.19.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.19.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","example":"card","enum":["affirm","afterpay","alipay","alipayhk","applepay","bacs","bancontact","banked","becs","bitpay","boleto","boost","card","cashapp","chaseorbital","checkout-session","clearpay","click-to-pay","dana","dcb","dlocal","ebanx","efecty","eps","everydaypay","gcash","gem","gemds","gift-card","giropay","givingblock","gocardless","googlepay","googlepay_pan_only","gopay","grabpay","id","ideal","kakaopay","kcp","klarna","latitude","latitudeds","laybuy","linepay","linkaja","maybankqrpay","mercadopago","multibanco","multipago","netbanking","network-token","oney_3x","oney_4x","oney_6x","oney_10x","oney_12x","ovo","oxxo","payid","paymaya","paypal","paypalpaylater","payto","venmo","pix","pse","rabbitlinepay","razorpay","scalapay","sepa","shopeepay","singteldash","smartpay","sofort","spei","stripedd","thaiqr","touchngo","truemoney","trustly","trustlyeurope","upi","vipps","waave","webpay","wechat","zippay"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.19.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["paypal","shopeepay"],"description":"Payment method(s) to compare the transaction to.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.19.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.19","typeLabel":"Flow payment methods condition · object"},{"type":"object","title":"Flow payment source condition","description":"Payment source conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"payment_source","enum":["payment_source"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.20.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the payment source `value`.","example":"is_one_of","enum":["is_one_of","is_not_one_of"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.20.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","example":"recurring","enum":["ecommerce","moto","recurring","installment","card_on_file"],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.20.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["recurring","installment"],"description":"Payment sources to compare the transaction to.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.20.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.20","typeLabel":"Flow payment source condition · object"},{"type":"object","title":"Flow product categories condition","description":"Cart items' product categories conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"product_categories","enum":["product_categories"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.21.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"includes_all","enum":["includes_all","includes_at_least_one","includes_none"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.21.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.21.value.items.[INDEX]","typeLabel":"string"},"description":"Cart items' product categories to compare the transaction to.","example":["electronics","printers"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.21.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.21","typeLabel":"Flow product categories condition · object"},{"type":"object","title":"Flow product types condition","description":"Cart items' product types conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"product_types","enum":["product_types"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.22.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"includes_all","enum":["includes_all","includes_at_least_one","includes_none"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.22.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","example":"physical","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge",null],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.22.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["shipping_fee","sales_tax"],"description":"Cart items' product types to compare the transaction to.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.22.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.22","typeLabel":"Flow product types condition · object"},{"type":"object","title":"Flow SKUs condition","description":"Cart items' SKUs conditions with a name, operator, and value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The type of match made for this rule.","example":"skus","enum":["skus"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.23.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The comparison to make on the `value`.","example":"includes_all","enum":["includes_all","includes_at_least_one","includes_none"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.23.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.23.value.items.[INDEX]","typeLabel":"string"},"description":"Cart items' SKU values to compare the transaction to.","example":["YZ1234","AB2345","TU4567"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.23.value","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.23","typeLabel":"Flow SKUs condition · object"},{"type":"object","title":"Flow split routing condition","description":"Split routing condition with a name, operator, and numeric value.","required":["name","operator","value"],"x-tags":["Flow"],"x-internal":true,"properties":{"name":{"type":"string","description":"The unique name of this condition.","example":"split_routing","enum":["split_routing"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.24.name","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"The numeric comparison to evaluate.","example":"less_than_or_equal_to","enum":["less_than_or_equal_to"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.24.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","description":"The probability percentage of this condition to be triggered.","minimum":1,"maximum":99,"example":50,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.24.value","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX].oneOf.24","typeLabel":"Flow split routing condition · object"}],"uniqueKey":"\\items.items.[INDEX].conditions.items.[INDEX]","typeLabel":"Flow amount condition · object | Flow amount range condition · object | Flow zero amount condition · object | Flow anti-fraud decision condition · object | Flow BIN range condition · object | Flow browser language condition · object | Flow card country condition · object | Flow card issuer name condition · object | Flow card product name condition · object | Flow card scheme condition · object | Flow card source condition · object | Flow card type condition · object | Flow country condition · object | Flow currency condition · object | Flow is subsequent payment condition · object | Flow metadata condition · object | Flow metadata numeric condition · object | Flow merchant initiated condition · object | Flow payment method condition · object | Flow payment methods condition · object | Flow payment source condition · object | Flow product categories condition · object | Flow product types condition · object | Flow SKUs condition · object | Flow split routing condition · object"},"uniqueKey":"\\items.items.[INDEX].conditions","typeLabel":"(Flow amount condition · object | Flow amount range condition · object | Flow zero amount condition · object | Flow anti-fraud decision condition · object | Flow BIN range condition · object | Flow browser language condition · object | Flow card country condition · object | Flow card issuer name condition · object | Flow card product name condition · object | Flow card scheme condition · object | Flow card source condition · object | Flow card type condition · object | Flow country condition · object | Flow currency condition · object | Flow is subsequent payment condition · object | Flow metadata condition · object | Flow metadata numeric condition · object | Flow merchant initiated condition · object | Flow payment method condition · object | Flow payment methods condition · object | Flow payment source condition · object | Flow product categories condition · object | Flow product types condition · object | Flow SKUs condition · object | Flow split routing condition · object)[]"},"outcome":{"oneOf":[{"type":"object","title":"Payment service outcome","description":"Defines the outcome of a rule in a flow where the result\nis a list of dictionaries that define the payment service,\ninstrument and transformation to be used to process a\ntransaction.","required":["type","result","version"],"x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of action outcome for the given rule.","example":"card-routing","enum":["card-routing"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.type","typeLabel":"enum\u003cstring>"},"result":{"type":"array","description":"Results for a given flow action.","items":{"type":"object","properties":{"payment_service_id":{"type":"string","description":"ID of the payment service to be used when processing the transaction.","nullable":false,"example":"fe26475d-ec3e-4884-9553-f7356683f7f9","format":"uuid","uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX].payment_service_id","typeLabel":"string\u003cuuid>"},"instrument":{"type":"string","description":"The name of the instrument to be used to process the transaction.\nFor `pan`, if a Payment Service token is available, the API will use that\nfor stored payment methods.\n","enum":["network_token","pan"],"example":"network_token","uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX].instrument","typeLabel":"enum\u003cstring>"},"transformations":{"type":"array","description":"List of transformations to apply when processing the transaction.","nullable":false,"items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the transformation.","example":"force_mit","enum":["force_mit","use_additional_scheme"],"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX].transformations.items.[INDEX].name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX].transformations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX].transformations","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result.items.[INDEX]","typeLabel":"object"},"example":[{"payment_service_id":"fe26475d-ec3e-4884-9553-f7356683f7f9","instrument\"":"network_token","transformations":[]},{"payment_service_id":"d88aca32-07fb-46cd-a43f-86da02b73c21","instrument":"pan","transformations":[{"name":"force_mit"}]}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.result","typeLabel":"object[]"},"version":{"type":"integer","description":"Version of the rule outcome. Current version is `2`.","example":2,"enum":[2],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0.version","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.0","typeLabel":"Payment service outcome · object"},{"type":"object","title":"Payment method outcome","description":"Defines the outcome of a rule in a flow where the result\nis a list of payment types.","required":["type","result"],"x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of action outcome for the given rule.","example":"list","enum":["list"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.1.type","typeLabel":"enum\u003cstring>"},"result":{"type":"array","description":"Results for a given flow action.","items":{"type":"string","example":"card","enum":["affirm","afterpay","alipay","alipayhk","applepay","bacs","bancontact","banked","becs","bitpay","boleto","boost","card","cashapp","chaseorbital","checkout-session","clearpay","click-to-pay","dana","dcb","dlocal","ebanx","efecty","eps","everydaypay","gcash","gem","gemds","gift-card","giropay","givingblock","gocardless","googlepay","googlepay_pan_only","gopay","grabpay","id","ideal","kakaopay","kcp","klarna","latitude","latitudeds","laybuy","linepay","linkaja","maybankqrpay","mercadopago","multibanco","multipago","netbanking","network-token","oney_3x","oney_4x","oney_6x","oney_10x","oney_12x","ovo","oxxo","payid","paymaya","paypal","paypalpaylater","payto","venmo","pix","pse","rabbitlinepay","razorpay","scalapay","sepa","shopeepay","singteldash","smartpay","sofort","spei","stripedd","thaiqr","touchngo","truemoney","trustly","trustlyeurope","upi","vipps","waave","webpay","wechat","zippay"],"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.1.result.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["card","paypal"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.1.result","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.1","typeLabel":"Payment method outcome · object"},{"type":"object","title":"Boolean outcome","description":"Defines the outcome of a rule in a flow where the result\nis a boolean.","required":["type","result"],"x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of action outcome for the given rule.","example":"boolean","enum":["boolean"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.2.type","typeLabel":"enum\u003cstring>"},"result":{"type":"boolean","description":"Results for a given flow action.","enum":[true],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.2.result","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.2","typeLabel":"Boolean outcome · object"},{"type":"object","title":"UUIDs list outcome","description":"Defines the outcome of a rule in a flow where the result\nis a list of UUIDs.\n\nDepending on the flow and action where this outcome is used, the UUIDs\nmay have an important meaning like the ID of a payment service to be\nused (this is the case for `redirect-transaction` flow and\n`route-transaction` action).","required":["type","result"],"x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of action outcome for the given rule.","example":"list","enum":["list"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.3.type","typeLabel":"enum\u003cstring>"},"result":{"type":"array","description":"Results for a given flow action.","items":{"type":"string","example":"fe26475d-ec3e-4884-9553-f7356683f7f9","format":"uuid","uniqueKey":"\\items.items.[INDEX].outcome.oneOf.3.result.items.[INDEX]","typeLabel":"string\u003cuuid>"},"example":["fe26475d-ec3e-4884-9553-f7356683f7f9","d88aca32-07fb-46cd-a43f-86da02b73c21"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.3.result","typeLabel":"string\u003cuuid>[]"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.3","typeLabel":"UUIDs list outcome · object"},{"type":"object","title":"3DS outcome","description":"Defines the outcome of a rule in a flow for 3DS.","required":["type","result"],"x-tags":["Flow"],"x-internal":true,"properties":{"type":{"type":"string","description":"The type of action outcome for the given rule.","example":"three-d-secure","enum":["three-d-secure"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.4.type","typeLabel":"enum\u003cstring>"},"result":{"type":"string","description":"Result for a given flow action.","example":"attempt","enum":["attempt","force","skip"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.4.result","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].outcome.oneOf.4","typeLabel":"3DS outcome · object"}],"uniqueKey":"\\items.items.[INDEX].outcome","typeLabel":"Payment service outcome · object | Payment method outcome · object | Boolean outcome · object | UUIDs list outcome · object | 3DS outcome · object"},"position":{"description":"The position of the rule in the flow.","type":"number","example":2,"uniqueKey":"\\items.items.[INDEX].position","typeLabel":"number"},"created_at":{"description":"The date and time\nwhen this buyer was created in our system.","example":"2013-07-16T19:23:00.000+00:00","format":"date-time","type":"string","uniqueKey":"\\items.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"The date and time\nwhen this buyer was last updated in our system.","example":"2013-07-16T19:23:00.000+00:00","format":"date-time","type":"string","uniqueKey":"\\items.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"error_code":{"oneOf":[{"type":"string","description":"A custom error code returned when this rule is triggered. This only applies\nto `\"decline-early\"` rule actions. The value must have a `flow_` prefix.","example":"flow_error_code","minLength":1,"maxLength":255,"pattern":"^flow_[a-z_]+$","uniqueKey":"\\items.items.[INDEX].error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"A custom error code returned when this rule is triggered. This only applies\nto `\"decline-early\"` rule actions. The value must have a `flow_` prefix.","example":"flow_error_code","minLength":1,"maxLength":255,"pattern":"^flow_[a-z_]+$","uniqueKey":"\\items.items.[INDEX].error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].error_code","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"Flow rule · object"},"uniqueKey":"\\items","typeLabel":"Flow rule · object[]"}},"uniqueKey":"","typeLabel":"Flow rules · object"},"examples":{"Example":{"title":"Example","value":{"items":[{"type":"rule","id":"fe26475d-ec3e-4884-9553-f7356683f7f9","merchant_account_id":"default","description":"example rule.","flow":"checkout","action":"select-payment-options","conditions":[{"name":"amount","operator":"less_than","value":{"Amount condition value":{"value":{"description":"example amount value.","currency":"USD","value":100}}}}],"outcome":{"type":"card-routing","result":[{"payment_service_id":"fe26475d-ec3e-4884-9553-f7356683f7f9","instrument\"":"network_token","transformations":[]},{"payment_service_id":"d88aca32-07fb-46cd-a43f-86da02b73c21","instrument":"pan","transformations":[{"name":"force_mit"}]}],"version":2},"position":2,"created_at":"2013-07-16T19:23:00.000+00:00","updated_at":"2013-07-16T19:23:00.000+00:00","error_code":"flow_error_code"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"799ba18b-64e5-4605-a37e-ce61c863c706":{"description":"Returns an error if no valid authentication was provided.","content":{"application/json":{"schema":{"title":"Unauthorized Error","type":"object","description":"Unauthorized Error (HTTP 401).","x-tags":["Errors"],"properties":{"type":{"type":"string","description":"`error`.","enum":["error"],"example":"error","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"`unauthorized`.","example":"unauthorized","enum":["unauthorized"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"status":{"type":"integer","description":"`401`.","example":401,"enum":[401],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","description":"No valid API authentication found.","example":"No valid API authentication found","enum":["No valid API authentication found"],"uniqueKey":"message","typeLabel":"enum\u003cstring>"},"details":{"type":"array","description":"A list of detail objects that further clarify the reason for the error.\nNot every error supports more detail.","example":[],"items":{"title":"Error details","description":"Additional detail about the part of a request body that caused an issue.","type":"object","x-tags":["Errors"],"properties":{"location":{"type":"string","example":"body","description":"The location where the error caused an issue.","enum":["query","body","path","header"],"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"type":{"type":"string","example":"value_error.missing","description":"A unique identifier for the type of error that occurred.","uniqueKey":"details.items.[INDEX].type","typeLabel":"string"},"pointer":{"type":"string","example":"/payment_method/number","description":"The exact item for which the validation did not succeed. This is a JSON\npointer for request bodies, while for query, path, and header parameters\nit is the name of the parameter.","uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","example":"field required","description":"A human readable message for this error detail.","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"Error details · object"},"uniqueKey":"details","typeLabel":"Error details · object[]"}},"uniqueKey":"","typeLabel":"Unauthorized Error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"unauthorized","status":401,"message":"No valid API authentication found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6c6223af-e151-4dcc-8f35-88257b966832":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"687beca7-453b-424d-a360-eaca1398b8d8":{"url":"https://api.sandbox.{id}.gr4vy.app","x-speakeasy-server-id":"sandbox","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}},"578272f1-d32a-4d53-8e16-3dc13be44c34":{"url":"https://api.{id}.gr4vy.app","x-speakeasy-server-id":"production","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.v1.json"},"subdomain":"flexxbuy","siteName":"Gr4vy","title":"List flow rules - Gr4vy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-16T19:01:25.193Z","originalFileLocation":"reference/flow/list-rules.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=\"system\"}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=\"Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List flow rules - Gr4vy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gr4vy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzly.com/reference/flow/list-rules\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Flow\u0026amp;title=List+flow+rules\u0026amp;description=Returns+a+list+of+rules+for+a+given+flow.+Each+rule+has+an%0Aassociated+action%2C+conditions%2C+and+outcome.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=fec4f01ccf9a752728717f5392636187e4c0da08bba745730a62282ff1771b29\">\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 flow rules - Gr4vy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Flow\u0026amp;title=List+flow+rules\u0026amp;description=Returns+a+list+of+rules+for+a+given+flow.+Each+rule+has+an%0Aassociated+action%2C+conditions%2C+and+outcome.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=fec4f01ccf9a752728717f5392636187e4c0da08bba745730a62282ff1771b29\">\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/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzly.com/reference/flow/list-rules\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/flow/list-rules.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzly.com/#organization\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzly.com#website\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzly.com/reference/flow/list-rules#webpage\",\"url\":\"https://docs.byzly.com/reference/flow/list-rules\",\"name\":\"List flow rules\",\"description\":\"Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.\",\"dateModified\":\"2025-09-16T19:01:25.193Z\",\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzly.com/reference/flow/list-rules#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzly.com/reference/flow/list-rules#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Other\",\"item\":\"https://docs.byzly.com/reference/api-key-pairs/list-api-key-pairs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List flow rules\",\"item\":\"https://docs.byzly.com/reference/flow/list-rules\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzly.com/reference/flow/list-rules#apireference\",\"headline\":\"List flow rules\",\"name\":\"List flow rules\",\"description\":\"Returns a list of rules for a given flow. Each rule has an associated action, conditions, and outcome.\",\"url\":\"https://docs.byzly.com/reference/flow/list-rules\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzly.com/reference/flow/list-rules#webpage\"},\"dateModified\":\"2025-09-16T19:01:25.193Z\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gr4vy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gr4vy","nav":{"global":null,"tabs":[{"tab":"Build","icon":"credit-card","pages":[{"title":"Build","href":"/guides/get-started"}]},{"tab":"Dashboard","icon":"circle-user","pages":[{"title":"Dashboard","href":"/guides/dashboard/overview"}]},{"tab":"Connections","icon":{"style":"light","name":"circle-nodes"},"pages":[{"title":"Connections","href":"/connections/payments/overview"}]},{"tab":"Custom Connectors","icon":"plug","hidden":true,"pages":[{"title":"Custom Connectors","href":"/guides/features/custom-connectors/overview"}]},{"tab":"Connector Requirements","icon":"clipboard-check","hidden":true,"pages":[{"title":"Connector Requirements","href":"/partners/connector-requirements/overview"}]},{"tab":"External Apps","icon":"puzzle-piece","hidden":true,"pages":[{"title":"External Apps","href":"/partners/external-apps"}]},{"tab":"API Reference","icon":{"style":"light","name":"square-terminal"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Authentication","mode":"wide","href":"/guides/api/authentication"},{"title":"Managing API keys","sidebarTitle":"API keys","mode":"wide","href":"/guides/api/api-keys"},{"title":"API Compatibility","sidebarTitle":"Compatibility","href":"/guides/api/compatibility"},{"title":"Connectivity and TLS","sidebarTitle":"Connectivity","href":"/guides/api/connectivity"},{"sidebarTitle":"JWTs","title":"Authentication with JWTs","href":"/guides/api/jwts"},{"title":"Environments","href":"/guides/api/environments"},{"title":"Error handling","sidebarTitle":"Errors","mode":"wide","href":"/guides/api/errors"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"title":"IP address forwarding","href":"/guides/api/ip-address-forwarding"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"},{"title":"Pagination","href":"/guides/api/pagination"},{"sidebarTitle":"Prefer header","title":"Prefer header","href":"/guides/api/prefer-header"},{"title":"Rate limiting","href":"/guides/api/rate-limiting"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"},{"title":"Transaction error codes","sidebarTitle":"Error Codes","mode":"wide","href":"/guides/api/error-codes"}]},{"group":"Transactions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions","title":"List transactions","href":"/reference/transactions/list-transactions"},{"openapi":"openapi.speakeasy.json POST /transactions","title":"Create transaction","href":"/reference/transactions/new-transaction"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}","title":"Get transaction","href":"/reference/transactions/get-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/capture","title":"Capture transaction","href":"/reference/transactions/capture-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/void","title":"Void transaction","href":"/reference/transactions/void-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/authorization/increment","title":"Increment transaction authorization","href":"/reference/transactions/increment-transaction-authorization"},{"group":"Captures","pages":[{"sidebarTitle":"List captures","title":"List transaction captures","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures","href":"/reference/transactions/list-transaction-captures"},{"sidebarTitle":"Get capture","title":"Get capture","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures/{capture_id}","href":"/reference/transactions/get-transaction-capture"}]},{"group":"More actions","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/events","title":"List transaction events","href":"/reference/transactions/list-transaction-events"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/actions","title":"List transaction Flow rules","href":"/reference/transactions/list-transaction-actions"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/sync","title":"Sync transaction","href":"/reference/transactions/sync-transaction"},{"title":"Update a transaction","openapi":"openapi.speakeasy.json PUT /transactions/{transaction_id}","href":"/reference/transactions/update-transaction"},{"title":"Cancel a transaction","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/cancel","href":"/reference/transactions/cancel-transaction"},{"title":"Get or update transaction session","sidebarTitle":"Get session","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/session","href":"/reference/transactions/get-transaction-session"}]}]},{"group":"Buyers","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /buyers","title":"List all buyers","href":"/reference/buyers/list-buyers"},{"openapi":"openapi.speakeasy.json POST /buyers","title":"Add a buyer","href":"/reference/buyers/new-buyer"},{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}","title":"Get a buyer","href":"/reference/buyers/get-buyer"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}","title":"Update a buyer","href":"/reference/buyers/update-buyer"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}","title":"Delete a buyer","href":"/reference/buyers/delete-buyer"},{"group":"Shipping details","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}/shipping-details","title":"List a buyer's shipping details","href":"/reference/buyers/get-buyer-shipping-details"},{"openapi":"openapi.speakeasy.json POST /buyers/{buyer_id}/shipping-details","title":"Add buyer shipping details","href":"/reference/buyers/new-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Update a buyer's shipping details","href":"/reference/buyers/update-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Delete a buyer's shipping details","href":"/reference/buyers/delete-buyer-shipping-detail"}]}]},{"group":"Checkout Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","href":"/reference/checkout-sessions/new-checkout-session"},{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/get-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/update-checkout-session"},{"openapi":"openapi.speakeasy.json DELETE /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/delete-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}/fields","sidebarTitle":"Update session fields","title":null,"href":"/reference/checkout-sessions/update-checkout-session-fields"}]},{"group":"Payment links","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payment-links","title":"List all payment links","href":"/reference/payment-links/list-payment-links"},{"openapi":"openapi.speakeasy.json POST /payment-links","title":"Add a payment link","href":"/reference/payment-links/new-payment-link"},{"openapi":"openapi.speakeasy.json GET /payment-links/{payment_link_id}","title":"Get payment link","href":"/reference/payment-links/get-payment-link"},{"openapi":"openapi.speakeasy.json POST /payment-links/{payment_link_id}/expire","title":"Expire a payment link","href":"/reference/payment-links/expire-payment-link"}]},{"group":"Payment options","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-options","title":"List payment options","href":"/reference/payment-options/list-payment-options"}]},{"group":"Payouts","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payouts","title":"List payouts created","href":"/reference/payouts/list-payouts"},{"openapi":"openapi.speakeasy.json POST /payouts","title":"Create a payout","href":"/reference/payouts/new-payout"},{"openapi":"openapi.speakeasy.json GET /payouts/{payout_id}","title":"Get a payout","href":"/reference/payouts/get-payout"}]},{"group":"Refunds","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refunds","title":"List transaction refunds","href":"/reference/transactions/list-transaction-refunds"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds","title":"Create transaction refund","href":"/reference/transactions/refund-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds/all","sidebarTitle":"Refund all instruments","title":"Create batch transaction refund","href":"/reference/transactions/refund-all"},{"sidebarTitle":"Get refund","title":"Get refund","openapi":"openapi.speakeasy.json GET /refunds/{refund_id}","href":"/reference/transactions/get-refund"}]},{"group":"Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-service-definitions/{payment_service_definition_id}/sessions","sidebarTitle":"Get session","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session"},{"openapi":"openapi.speakeasy.json POST /payment-services/{payment_service_id}/sessions","sidebarTitle":"Get session by ID","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session-by-id"}]},{"group":"Settlement records","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements","sidebarTitle":"List settlement records","title":"List transaction settlements","href":"/reference/settlements/list-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements/{settlement_id}","sidebarTitle":"Get settlement record","title":"Get transaction settlement","href":"/reference/settlements/get-settlement"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements","sidebarTitle":"List refund settlement records","title":"List transaction refund settlements","href":"/reference/settlements/list-refund-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements/{settlement_id}","sidebarTitle":"Get refund settlement record","title":"Get transaction refund settlement","href":"/reference/settlements/get-refund-settlement"}]},{"group":"Disputes","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargebacks","sidebarTitle":"List chargeback records","title":"List transaction chargebacks","href":"/reference/disputes/list-chargebacks"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargeback-reversals","sidebarTitle":"List chargeback reversal records","title":"List transaction chargeback reversals","href":"/reference/disputes/list-chargeback-reversals"}]},{"group":"Instruments","icon":"code","pages":[{"group":"Card schemes","pages":[{"openapi":"openapi.speakeasy.json GET /card-scheme-definitions","title":"List card scheme definitions","href":"/reference/card-schemes/list-card-scheme-definitions"}]},{"group":"Card details","pages":[{"openapi":"openapi.speakeasy.json GET /card-details","title":"Get card details","href":"/reference/card-details/get-card-details"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/apple/session","title":"Create a Apple Pay session","href":"/reference/digital-wallets/get-apple-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/google/session","title":"Create a Google Pay session","href":"/reference/digital-wallets/get-google-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/click-to-pay/session","title":"Create a Click to Pay session","href":"/reference/digital-wallets/get-click-to-pay-session"}]},{"group":"Gift cards","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/gift-cards","title":"List gift cards for a buyer","href":"/reference/gift-cards/list-buyer-gift-cards"},{"openapi":"openapi.speakeasy.json GET /gift-cards","title":"List gift cards","href":"/reference/gift-cards/list-gift-cards"},{"openapi":"openapi.speakeasy.json POST /gift-cards/balances","title":"Verify and get gift card balances","sidebarTitle":"Verify \u0026 get balance","href":"/reference/gift-cards/list-gift-card-balances"},{"openapi":"openapi.speakeasy.json POST /gift-cards","title":"Create gift card","href":"/reference/gift-cards/new-gift-card"},{"openapi":"openapi.speakeasy.json GET /gift-cards/{gift_card_id}","title":"Get gift card","href":"/reference/gift-cards/get-gift-card"},{"openapi":"openapi.speakeasy.json DELETE /gift-cards/{gift_card_id}","title":"Delete a gift card","href":"/reference/gift-cards/delete-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/issuances","title":"Issue a gift card","href":"/reference/gift-cards/issue-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/activations","title":"Activate a gift card","href":"/reference/gift-cards/activate-gift-card"}]},{"group":"Payment methods","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/payment-methods","title":"List payment methods for a buyer","href":"/reference/payment-methods/list-buyer-payment-methods"},{"openapi":"openapi.speakeasy.json GET /payment-methods","title":"List all payment methods","href":"/reference/payment-methods/list-payment-methods"},{"openapi":"openapi.speakeasy.json POST /payment-methods","title":"Create payment method","href":"/reference/payment-methods/new-payment-method"},{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}","title":"Get payment method","href":"/reference/payment-methods/get-payment-method"},{"openapi":"openapi.speakeasy.json PUT /payment-methods/{payment_method_id}","title":"Update payment method","href":"/reference/payment-methods/update-payment-method"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}","title":"Delete payment method","href":"/reference/payment-methods/delete-payment-method"}]},{"group":"Payment method definitions","pages":[{"openapi":"openapi.speakeasy.json GET /payment-method-definitions","title":"List payment method definitions","href":"/reference/payment-method-definitions/list-payment-method-definitions"}]}]},{"group":"Vault","icon":"code","pages":[{"group":"Account updater","pages":[{"openapi":"openapi.speakeasy.json POST /account-updater/jobs","sidebarTitle":"Create a job","title":"Create account updater job","href":"/reference/account-updater/new-account-updater-job"}]},{"group":"Network tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/network-tokens","title":"List network tokens","href":"/reference/network-tokens/list-network-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens","title":"Provision network token","href":"/reference/network-tokens/provision-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram","title":"Provision network token cryptogram","href":"/reference/network-tokens/get-network-token-cryptogram"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend","title":"Suspend network token","href":"/reference/network-tokens/suspend-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume","title":"Resume network token","href":"/reference/network-tokens/resume-network-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/network-tokens/{network_token_id}","title":"Delete network token","href":"/reference/network-tokens/delete-network-token"}]},{"group":"Payment service tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/payment-service-tokens","title":"List payment service tokens","href":"/reference/payment-service-tokens/list-payment-service-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/payment-service-tokens","title":"Create payment service token","href":"/reference/payment-service-tokens/provision-payment-service-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}","title":"Delete payment service token","href":"/reference/payment-service-tokens/delete-payment-service-token"}]},{"group":"Vault Forward","pages":[{"openapi":"openapi.v1.json POST /vault-forward","title":"Forward PCI data","href":"/reference/vault-forwarding/make-vault-forward"}]},{"group":"Vault Forward endpoints","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs","sidebarTitle":"List endpoints","title":"List configured Vault Forward endpoints","href":"/reference/vault-forwarding/list-vault-forward-configs"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}","sidebarTitle":"Get endpoint","title":"Get configured Vault Forward endpoints","href":"/reference/vault-forwarding/get-vault-forward-config"}]},{"group":"Vault Forward authentication","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Get authentications","title":"List configured Vault Forward authentication methods","href":"/reference/vault-forwarding/list-vault-forward-authentications"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Get authentication","title":"Get Vault Forward authentication method","href":"/reference/vault-forwarding/get-vault-forward-authentication"},{"openapi":"openapi.v1.json POST /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Add authentication","title":"Adds new Vault Forward authentication method","href":"/reference/vault-forwarding/add-vault-forward-authentication"},{"openapi":"openapi.v1.json PUT /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Update authentication","title":"Update Vault Forward authentication method","href":"/reference/vault-forwarding/update-vault-forward-authentication"},{"openapi":"openapi.v1.json DELETE /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Remove authentication","title":"Remove a Vault Forward authentication method","href":"/reference/vault-forwarding/delete-vault-forward-authentication"}]}]},{"group":"PSPs \u0026 Gateways","icon":"code","pages":[{"group":"All services","pages":[{"openapi":"openapi.v1.json GET /connections","title":"List connections","href":"/reference/connections/list-connections"},{"openapi":"openapi.speakeasy.json GET /connection-definitions","title":null,"href":"/reference/connections/list-connection-definitions"}]},{"group":"Payment services","pages":[{"openapi":"openapi.speakeasy.json GET /payment-service-definitions/{payment_service_definition_id}","sidebarTitle":"Get service definition","title":"Get a payment service definition","href":"/reference/payment-service-definitions/get-payment-service-definition"},{"openapi":"openapi.speakeasy.json GET /payment-services","title":"List payment services","href":"/reference/payment-services/list-payment-services"},{"openapi":"openapi.speakeasy.json POST /payment-services","title":"Configure a payment service","href":"/reference/payment-services/new-payment-service"},{"openapi":"openapi.speakeasy.json GET /payment-services/{payment_service_id}","title":"Get payment service","href":"/reference/payment-services/get-payment-service"},{"openapi":"openapi.speakeasy.json PUT /payment-services/{payment_service_id}","title":"Update a configured payment service","href":"/reference/payment-services/update-payment-service"},{"openapi":"openapi.speakeasy.json DELETE /payment-services/{payment_service_id}","title":"Delete a configured payment service","href":"/reference/payment-services/delete-payment-service"},{"openapi":"openapi.speakeasy.json POST /payment-services/verify","sidebarTitle":"Verify credentials","title":"Verify payment service credentials","href":"/reference/payment-services/verify-payment-service"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json GET /digital-wallets","title":"List digital wallets","href":"/reference/digital-wallets/list-digital-wallets"},{"openapi":"openapi.speakeasy.json GET /digital-wallets/{digital_wallet_id}","title":"Get digital wallet","href":"/reference/digital-wallets/get-digital-wallet"},{"openapi":"openapi.speakeasy.json POST /digital-wallets","title":"Register digital wallet","href":"/reference/digital-wallets/register-digital-wallet"},{"openapi":"openapi.speakeasy.json PUT /digital-wallets/{digital_wallet_id}","title":"Update digital wallet","href":"/reference/digital-wallets/update-digital-wallet"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}","title":"Delete digital wallet","href":"/reference/digital-wallets/deregister-digital-wallet"},{"group":"Domain registration","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/{digital_wallet_id}/domains","title":"Register a digital wallet domain","href":"/reference/digital-wallets/new-digital-wallet-domain"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}/domains","title":"Remove a digital wallet domain","href":"/reference/digital-wallets/delete-digital-wallet-domain"}]},{"group":"Mobile Certificates (Apple Pay)","pages":[{"openapi":"openapi.v1.json GET /apple-pay-certificates","sidebarTitle":"List certificates","title":"List Apple Pay certificates","href":"/reference/digital-wallets/list-apple-pay-certificates"},{"openapi":"openapi.v1.json POST /apple-pay-certificates","sidebarTitle":"Create certificate","title":"New Apple Pay certificate","href":"/reference/digital-wallets/create-apple-pay-certificate"},{"openapi":"openapi.v1.json PUT /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Update certificate","title":"Update Apple Pay certificate","href":"/reference/digital-wallets/update-apple-pay-certificate"},{"openapi":"openapi.v1.json DELETE /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Delete certificate","title":"Remove Apple Pay certificate","href":"/reference/digital-wallets/delete-apple-pay-certificate"}]}]},{"group":"Anti-fraud services","pages":[{"openapi":"openapi.v1.json GET /anti-fraud-service-definitions/{anti_fraud_service_definition_id}","sidebarTitle":"Get service definition","title":"Get anti fraud service definition","href":"/reference/anti-fraud-services/get-anti-fraud-service-definition"},{"openapi":"openapi.v1.json POST /anti-fraud-services","title":"New anti-fraud service","href":"/reference/anti-fraud-services/new-anti-fraud-service"},{"openapi":"openapi.v1.json GET /anti-fraud-services/{anti_fraud_service_id}","title":"Get anti-fraud service","href":"/reference/anti-fraud-services/get-anti-fraud-service"},{"openapi":"openapi.v1.json PUT /anti-fraud-services/{anti_fraud_service_id}","title":"Update anti-fraud service","href":"/reference/anti-fraud-services/update-anti-fraud-service"},{"openapi":"openapi.v1.json DELETE /anti-fraud-services/{anti_fraud_service_id}","title":"Delete anti-fraud service","href":"/reference/anti-fraud-services/delete-anti-fraud-service"}]},{"group":"Gift-card services","pages":[{"openapi":"openapi.v1.json GET /gift-card-service-definitions/{gift_card_service_definition_id}","sidebarTitle":"Get service definition","title":"Get gift card service definition","href":"/reference/gift-card-services/get-gift-card-service-definition"},{"openapi":"openapi.v1.json POST /gift-card-services","title":"New gift card service","href":"/reference/gift-card-services/new-gift-card-service"},{"openapi":"openapi.v1.json GET /gift-card-services/{gift_card_service_id}","title":"Get gift card service","href":"/reference/gift-card-services/get-gift-card-service"},{"openapi":"openapi.v1.json PUT /gift-card-services/{gift_card_service_id}","title":"Update gift card service","href":"/reference/gift-card-services/update-gift-card-service"},{"openapi":"openapi.v1.json DELETE /gift-card-services/{gift_card_service_id}","title":"Delete gift card service","href":"/reference/gift-card-services/delete-gift-card-service"}]}]},{"group":"Errors","icon":"code","pages":[{"title":"Client-side errors (4XX)","sidebarTitle":"Client errors","href":"/reference/errors/client-errors"},{"title":"Server-side errors (5XX)","sidebarTitle":"Server errors","href":"/reference/errors/server-errors"},{"openapi":"openapi.v1.json GET /api-logs","title":"List 4XX errors","href":"/reference/logs/list-api-error-logs"}]},{"group":"Other","icon":"code","pages":[{"group":"API keys","pages":[{"openapi":"openapi.speakeasy.json GET /api-key-pairs","sidebarTitle":"List API keys","title":"List all API key pairs","href":"/reference/api-key-pairs/list-api-key-pairs"},{"openapi":"openapi.speakeasy.json POST /api-key-pairs","sidebarTitle":"Create API key","title":"Create an API key pair","href":"/reference/api-key-pairs/new-api-key-pair"},{"openapi":"openapi.speakeasy.json GET /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Get API key","title":"Get an API key pair","href":"/reference/api-key-pairs/get-api-key-pair"},{"openapi":"openapi.speakeasy.json PUT /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Update API key","title":"Update an API key pair","href":"/reference/api-key-pairs/update-api-key-pair"},{"openapi":"openapi.speakeasy.json DELETE /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Delete API key","title":"Delete an API key pair","href":"/reference/api-key-pairs/delete-api-key-pair"}]},{"group":"3DS Configuration","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"List 3DS configuration","sidebarTitle":"List 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"Add 3DS configuration","sidebarTitle":"Add 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Update 3DS configuration","sidebarTitle":"Update 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration"},{"openapi":"openapi.speakeasy.json DELETE /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Delete 3DS configuration","sidebarTitle":"Delete 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration"}]},{"group":"3DS Scenarios","pages":[{"openapi":"openapi.speakeasy.json GET /three-ds-scenarios","title":"List 3DS scenario","href":"/reference/three-ds-scenarios/list-three-ds-scenarios"},{"openapi":"openapi.speakeasy.json POST /three-ds-scenarios","title":"Create a 3DS scenario","href":"/reference/three-ds-scenarios/new-three-ds-scenario"},{"openapi":"openapi.speakeasy.json PUT /three-ds-scenarios/{three_ds_scenario_id}","title":"Update a 3DS scenario","href":"/reference/three-ds-scenarios/update-three-ds-scenario"},{"openapi":"openapi.speakeasy.json DELETE /three-ds-scenarios/{three_ds_scenario_id}","title":"Delete a 3DS scenario","description":"Removes a 3DS scenario from our system. Only available in sandbox environments.","href":"/reference/three-ds-scenarios/delete-three-ds-scenario"}]},{"group":"Flow","pages":[{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","href":"/reference/flow/list-rules"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Get rule","description":"Returns a configured rule that triggers an action in a flow.","href":"/reference/flow/get-rule"},{"openapi":"openapi.v1.json POST /flows/{flow}/actions/{action}/rules","title":"Create flow rule","href":"/reference/flow/new-rule"},{"openapi":"openapi.v1.json PUT /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Update flow rule","href":"/reference/flow/update-rule"},{"openapi":"openapi.v1.json DELETE /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Delete flow rule","href":"/reference/flow/delete-rule"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/outcomes","title":"List flow outcomes","href":"/reference/flow/list-outcomes"}]},{"group":"Merchant accounts","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts","title":"List all merchant accounts","href":"/reference/merchant-accounts/list-merchant-accounts"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts","title":"Create a merchant account","href":"/reference/merchant-accounts/new-merchant-account"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}","title":"Update a merchant account","href":"/reference/merchant-accounts/update-merchant-account"}]},{"group":"Reports","pages":[{"openapi":"openapi.speakeasy.json GET /reports","title":"List configured reports","href":"/reference/reports/list-reports"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}","title":"Get a report","href":"/reference/reports/get-report"},{"openapi":"openapi.speakeasy.json POST /reports","title":"Add a report","href":"/reference/reports/new-report"},{"openapi":"openapi.speakeasy.json PUT /reports/{report_id}","title":"Update a report","href":"/reference/reports/update-report"}]},{"group":"Report executions","pages":[{"openapi":"openapi.speakeasy.json GET /report-executions","title":"List executed reports","href":"/reference/reports/list-all-report-executions"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}/executions","title":"List executions for report","href":"/reference/reports/list-executions-for-report"},{"openapi":"openapi.speakeasy.json GET /report-executions/{report_execution_id}","title":"Get executed report","href":"/reference/reports/get-report-execution"},{"openapi":"openapi.speakeasy.json POST /reports/{report_id}/executions/{report_execution_id}/url","title":"Create URL for executed report","href":"/reference/reports/generate-download-url"}]},{"group":"Roles","pages":[{"openapi":"openapi.speakeasy.json GET /roles","sidebarTitle":"List roles","title":"List all roles","href":"/reference/roles/list-roles"}]},{"group":"Users","pages":[{"openapi":"openapi.speakeasy.json GET /audit-logs","title":"List audit log entries","href":"/reference/audit-logs/list-audit-logs"}]},{"group":"Webhook subscriptions","pages":[{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions","sidebarTitle":"List subscriptions","title":"List webhook subscriptions","href":"/reference/webhook-subscriptions/list-webhook-subscriptions"},{"openapi":"openapi.speakeasy.json POST /webhook-subscriptions","sidebarTitle":"New subscription","title":"Create webhook subscription","href":"/reference/webhook-subscriptions/new-webhook-subscription"},{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions/{subscription_id}","sidebarTitle":"Get subscription","title":"Get webhook subscription","href":"/reference/webhook-subscriptions/get-webhook-subscription"},{"openapi":"openapi.speakeasy.json PUT /webhook-subscriptions/{subscription_id}","sidebarTitle":"Update subscription","title":"Update webhook subscription","href":"/reference/webhook-subscriptions/update-webhook-subscription"},{"openapi":"openapi.speakeasy.json DELETE /webhook-subscriptions/{subscription_id}","sidebarTitle":"Delete subscription","title":"Delete webhook subscription","href":"/reference/webhook-subscriptions/delete-webhook-subscription"}]}]}]},{"tab":"Updates","icon":"bullhorn","pages":[{"title":"Updates","href":"/updates"}]}]},"title":"List flow rules - Gr4vy","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}