List flow rules

This endpoint requires the flows.read scope.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flow

enum<string>

required

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 the decline-early action.
redirect-transaction - Applies when processing any other transaction.

Available options:

checkout,

card-transaction,

non-card-transaction,

redirect-transaction

Response

200 - application/json

items

object[]

A list of rules.

items.type

enum<string>

The type of this resource. Is always rule.

Available options:

rule

items.id

string

The unique Gr4vy ID for this rule.

items.merchant_account_id

string

The unique ID for a merchant account.

items.description

string | null

Description of the flow rule.

items.flow

enum<string>

The name of the Flow.

Available options:

checkout,

card-transaction,

non-card-transaction,

redirect-transaction

items.action

enum<string>

Action for the given rule. Actions can only be used in flows that support them.

The checkout flow only supports the select-payment-options action.
The card-transaction supports the route-transaction, skip-3ds, and decline-early actions.
The non-card-transaction flow only supports the decline-early action.
The redirect-transaction flow only supports the route-transaction action.

Available options:

select-payment-options,

decline-early,

route-transaction,

skip-3ds

items.conditions

object[]

One or more conditions that apply for this rule. Each condition needs to match for this rule to go into effect.

items.outcome

object

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.

items.position

number

The position of the rule in the flow.

items.created_at

string

The date and time when this buyer was created in our system.

items.updated_at

string

The date and time when this buyer was last updated in our system.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List flow rules

Authorizations

Path Parameters

Response