List flow rules

Payments

Transactions
Buyers
Checkout Sessions
Payment links
Payment options
Payouts
Refunds
Sessions
Settlement records

Instruments

Card schemes
Digital wallets
Gift cards
Payment methods
Payment method definitions

Vault

Account updater
Network tokens
Payment service tokens
Vault Forward
Vault Forward endpoints
Vault Forward authentication

Connections

All services
Payment services
Digital wallets
Anti-fraud services
Gift-card services

Other

Flow
Merchant accounts
Reports
Report executions
Webhook subscriptions

Errors

GET

flows

{flow}

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/flows/{flow} \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

This endpoint requires the flows.read scope.

Authorizations

Authorization

string

header

required

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

Example:

"checkout"

Response

200

application/json

Returns a list of rules.

A list of rule in a flow.

items

object[]

A list of rules.

items.type

enum<string>

The type of this resource. Is always rule.

Available options:

rule

Example:

"rule"

items.id

string

The unique Gr4vy ID for this rule.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

items.merchant_account_id

string

The unique ID for a merchant account.

Example:

"default"

items.description

string | null

Description of the flow rule.

Required string length: 1 - 200

Example:

"example rule."

items.flow

enum<string>

The name of the Flow.

Available options:

checkout,

card-transaction,

non-card-transaction,

redirect-transaction

Example:

"checkout"

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

Example:

"select-payment-options"

items.conditions

object[]

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.

items.conditions.name

enum<string>

required

The type of match made for this rule.

Available options:

amount

Example:

"amount"

items.conditions.operator

enum<string>

required

The comparison to make on the currency code value.

Available options:

less_than,

greater_than

Example:

"less_than"

items.conditions.value

object

required

Amount value compare the transaction to.

Example:

{
  "Amount condition value": {
    "value": {
      "description": "example amount value.",
      "currency": "USD",
      "value": 100
    }
  }
}

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.outcome.type

enum<string>

required

The type of action outcome for the given rule.

Available options:

card-routing

Example:

"card-routing"

items.outcome.result

object[]

required

Results for a given flow action.

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" }]
  }
]

items.outcome.version

enum<integer>

required

Version of the rule outcome. Current version is 2.

Available options:

2

Example:

2

items.position

number

The position of the rule in the flow.

Example:

2

items.created_at

string

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

Example:

"2013-07-16T19:23:00.000+00:00"

items.updated_at

string

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

Example:

"2013-07-16T19:23:00.000+00:00"

items.error_code

string | null

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.

Required string length: 1 - 255

Example:

"flow_error_code"

Was this page helpful?

Delete gift card service Get rule

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/flows/{flow} \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}