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

Response

200
application/json
Returns a list of rules.

A list of rule in a flow.

​
items
object[]

A list of rules.

Was this page helpful?

Suggest edits
Delete anti-fraud serviceGet rule