https://docs.monei.com/assets/js/50d567aa.2126e718.js

1"use strict";(self.webpackChunkmonei_docs=self.webpackChunkmonei_docs||[]).push([["20591"],{79127(e,t,n){n.r(t),n.d(t,{metadata:()=>i,default:()=>m,toc:()=>p,Badge:()=>h,Bullet:()=>d,assets:()=>o,frontMatter:()=>s,SpecifiedBy:()=>a,contentTitle:()=>c});var i=JSON.parse('{"id":"apis/graphql/types/enums/payment-rule-action-type","title":"PaymentRuleActionType","description":"Action applied when a payment rule\'s conditions match. The selected type determines which other fields on the action are populated.","source":"@site/docs/apis/graphql/types/enums/payment-rule-action-type.mdx","sourceDirName":"apis/graphql/types/enums","slug":"/apis/graphql/types/enums/payment-rule-action-type","permalink":"/apis/graphql/types/enums/payment-rule-action-type","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1790004115000,"frontMatter":{"id":"payment-rule-action-type","title":"PaymentRuleActionType"},"sidebar":"graphql","previous":{"title":"PaymentMethods","permalink":"/apis/graphql/types/enums/payment-methods"},"next":{"title":"PaymentRuleCategory","permalink":"/apis/graphql/types/enums/payment-rule-category"}}'),l=n(91987),r=n(39844);let s={id:"payment-rule-action-type",title:"PaymentRuleActionType"},c,o={},d=()=>(0,l.jsx)(l.Fragment,{children:(0,l.jsx)("span",{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25CF\xa0"})}),a=e=>(0,l.jsxs)(l.Fragment,{children:["Specification",(0,l.jsx)("a",{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]}),h=e=>(0,l.jsx)(l.Fragment,{children:(0,l.jsx)("span",{className:e.class,children:e.text})}),p=[{value:"Values",id:"values",level:3},{value:"<code>PaymentRuleActionType.<b>route_to</b></code>",id:"route-to",level:4},{value:"<code>PaymentRuleActionType.<b>route_split</b></code>",id:"route-split",level:4},{value:"<code>PaymentRuleActionType.<b>decline</b></code>",id:"decline",level:4},{value:"<code>PaymentRuleActionType.<b>hide</b></code>",id:"hide",level:4},{value:"<code>PaymentRuleActionType.<b>block_provider</b></code>",id:"block-provider",level:4},{value:"<code>PaymentRuleActionType.<b>force_challenge</b></code>",id:"force-challenge",level:4},{value:"<code>PaymentRuleActionType.<b>skip_challenge</b></code>",id:"skip-challenge",level:4},{value:"<code>PaymentRuleActionType.<b>trigger_fraud_check</b></code>",id:"trigger-fraud-check",level:4},{value:"<code>PaymentRuleActionType.<b>tag_store</b></code>",id:"tag-store",level:4},{value:"<code>PaymentRuleActionType.<b>tag_pos</b></code>",id:"tag-pos",level:4},{value:"<code>PaymentRuleActionType.<b>tag_store_split</b></code>",id:"tag-store-split",level:4},{value:"<code>PaymentRuleActionType.<b>tag_pos_split</b></code>",id:"tag-pos-split",level:4},{value:"Member Of",id:"member-of",level:3}];function u(e){let t={a:"a",code:"code",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsxs)(t.p,{children:["Action applied when a payment rule's ",(0,l.jsx)(t.code,{children:"conditions"})," match. The selected ",(0,l.jsx)(t.code,{children:"type"})," determines which other fields on the action are populated."]}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"route_to"})," - Route the transaction to a single provider. Requires ",(0,l.jsx)(t.code,{children:"providerId"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"route_split"})," - Split traffic across providers by percentage. Requires ",(0,l.jsx)(t.code,{children:"splits"}),"; percentages must sum to 100."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"decline"})," - Decline the transaction. No other fields required."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"hide"})," - Hide one or more payment methods at checkout. Requires ",(0,l.jsx)(t.code,{children:"paymentMethods"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"block_provider"})," - Remove a provider from the candidate pool for the matching transaction. Requires ",(0,l.jsx)(t.code,{children:"providerId"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"force_challenge"})," - Force a 3DS challenge for matching card transactions. No additional fields required. [AUTHENTICATION]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"skip_challenge"})," - Skip the 3DS challenge for matching card transactions (SCA exemption). No additional fields required. [AUTHENTICATION]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"trigger_fraud_check"})," - Run fraud detection for matching transactions, overriding the account-level fraud detector setting. No additional fields required. [FRAUD_DETECTION]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"tag_store"})," - Tag the operation with a store (set-if-absent). Requires ",(0,l.jsx)(t.code,{children:"storeId"}),". [OPERATION_TAGGING]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"tag_pos"})," - Tag the operation with a point of sale (set-if-absent). Requires ",(0,l.jsx)(t.code,{children:"pointOfSaleId"}),". [OPERATION_TAGGING]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"tag_store_split"})," - Tag the operation with a store chosen by percentage split. Requires ",(0,l.jsx)(t.code,{children:"splits"})," (with ",(0,l.jsx)(t.code,{children:"storeId"}),"); percentages must sum to 100. [OPERATION_TAGGING]"]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"tag_pos_split"})," - Tag the operation with a point of sale chosen by percentage split. Requires ",(0,l.jsx)(t.code,{children:"splits"})," (with ",(0,l.jsx)(t.code,{children:"pointOfSaleId"}),"); percentages must sum to 100. [OPERATION_TAGGING]"]}),"\n"]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-graphql",children:"enum PaymentRuleActionType {\n  route_to\n  route_split\n  decline\n  hide\n  block_provider\n  force_challenge\n  skip_challenge\n  trigger_fraud_check\n  tag_store\n  tag_pos\n  tag_store_split\n  tag_pos_split\n}\n"})}),"\n",(0,l.jsx)(t.h3,{id:"values",children:"Values"}),"\n",(0,l.jsx)(t.h4,{id:"route-to",children:(0,l.jsx)(t.a,{href:"#route-to",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"route_to"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"route-split",children:(0,l.jsx)(t.a,{href:"#route-split",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"route_split"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"decline",children:(0,l.jsx)(t.a,{href:"#decline",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"decline"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"hide",children:(0,l.jsx)(t.a,{href:"#hide",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"hide"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"block-provider",children:(0,l.jsx)(t.a,{href:"#block-provider",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"block_provider"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"force-challenge",children:(0,l.jsx)(t.a,{href:"#force-challenge",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"force_challenge"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"skip-challenge",children:(0,l.jsx)(t.a,{href:"#skip-challenge",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"skip_challenge"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"trigger-fraud-check",children:(0,l.jsx)(t.a,{href:"#trigger-fraud-check",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"trigger_fraud_check"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"tag-store",children:(0,l.jsx)(t.a,{href:"#tag-store",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"tag_store"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"tag-pos",children:(0,l.jsx)(t.a,{href:"#tag-pos",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"tag_pos"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"tag-store-split",children:(0,l.jsx)(t.a,{href:"#tag-store-split",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"tag_store_split"})]})})}),"\n",(0,l.jsx)(t.h4,{id:"tag-pos-split",children:(0,l.jsx)(t.a,{href:"#tag-pos-split",children:(0,l.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleActionType.",(0,l.jsx)("b",{children:"tag_pos_split"})]})})}),"\n",(0,l.jsx)(t.h3,{id:"member-of",children:"Member Of"}),"\n",(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.a,{href:"/apis/graphql/types/inputs/payment-rule-action-input",children:(0,l.jsx)(t.code,{children:"PaymentRuleActionInput"})}),"  ",(0,l.jsx)(h,{class:"badge badge--secondary badge--relation",text:"input"})]})]})}function m(e={}){let{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(u,{...e})}):u(e)}},39844(e,t,n){n.d(t,{R:()=>s,x:()=>c});var i=n(71763);let l={},r=i.createContext(l);function s(e){let t=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);