Get rule
Returns a configured rule that triggers an action in a flow.
This endpoint requires the flows.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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-early
action.redirect-transaction
- Applies when processing any other transaction.
checkout
, card-transaction
, non-card-transaction
, redirect-transaction
The flow action.
select-payment-options
, decline-early
, route-transaction
, skip-3ds
The unique ID for a rule.
Response
The type of this resource. Is always rule
.
rule
The unique Gr4vy ID for this rule.
The unique ID for a merchant account.
Description of the flow rule.
The name of the Flow.
checkout
, card-transaction
, non-card-transaction
, redirect-transaction
Action for the given rule. Actions can only be used in flows that support them.
- The
checkout
flow only supports theselect-payment-options
action. - The
card-transaction
supports theroute-transaction
,skip-3ds
, anddecline-early
actions. - The
non-card-transaction
flow only supports thedecline-early
action. - The
redirect-transaction
flow only supports theroute-transaction
action.
select-payment-options
, decline-early
, route-transaction
, skip-3ds
One or more conditions that apply for this rule. Each condition needs to match for this rule to go into effect.
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.
The position of the rule in the flow.
The date and time when this buyer was created in our system.
The date and time when this buyer was last updated in our system.
A custom error code returned when this rule is triggered. This only applies
to "decline-early"
rule actions. The value must have a flow_
prefix.
Was this page helpful?