Get rule
Returns a configured rule that triggers an action in a flow.
flows.read scope.Authorizations
Path Parameters
The flow name. This can be one of the following.
checkout- Applies during checkout to determine what payment options are shown.card-transaction- Applies when processing a card transaction.non-card-transaction- Applies when processing a gift card only transaction, or a redirect transaction using thedecline-earlyaction.redirect-transaction- Applies when processing any other transaction. The name of the Flow.
checkout, card-transaction, non-card-transaction, redirect-transaction "checkout"
The flow action. Action for the given rule. Actions can only be used in flows that support them.
- The
checkoutflow only supports theselect-payment-optionsaction. - The
card-transactionsupports theroute-transaction,skip-3ds, anddecline-earlyactions. - The
non-card-transactionflow only supports thedecline-earlyaction. - The
redirect-transactionflow only supports theroute-transactionaction.
select-payment-options, decline-early, route-transaction, skip-3ds "select-payment-options"
Response
Returns the flow rule.
Action for the given rule. Actions can only be used in flows that support them.
- The
checkoutflow only supports theselect-payment-optionsaction. - The
card-transactionsupports theroute-transaction,skip-3ds, anddecline-earlyactions. - The
non-card-transactionflow only supports thedecline-earlyaction. - The
redirect-transactionflow only supports theroute-transactionaction.
select-payment-options, decline-early, route-transaction, skip-3ds "select-payment-options"
One or more conditions that apply for this rule. Each condition needs to match for this rule to go into effect.
Amount conditions with a name, operator, and value.
- Flow amount condition
- Flow amount range condition
- Flow zero amount condition
- Flow anti-fraud decision condition
- Flow BIN range condition
- Flow browser language condition
- Flow card country condition
- Flow card issuer name condition
- Flow card product name condition
- Flow card scheme condition
- Flow card source condition
- Flow card type condition
- Flow country condition
- Flow currency condition
- Flow is subsequent payment condition
- Flow metadata condition
- Flow metadata numeric condition
- Flow merchant initiated condition
- Flow payment method condition
- Flow payment methods condition
- Flow payment source condition
- Flow product categories condition
- Flow product types condition
- Flow SKUs condition
- Flow split routing condition
Defines the outcome of a rule in a flow where the result is a list of dictionaries that define the payment service, instrument and transformation to be used to process a transaction.
- Payment service outcome
- Payment method outcome
- Boolean outcome
- UUIDs list outcome
- 3DS outcome