Flow
List flow rules
Returns a list of rules for a given flow. Each rule has an
associated action, conditions, and outcome.
GET
/flows/{flow}
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/flows/{flow} \
--header 'Authorization: <authorization>'
{
"items": [
{
"action": "select-payment-options",
"conditions": [],
"created_at": "2013-07-16T19:23:00.000+00:00",
"description": "example rule.",
"flow": "checkout",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"position": "2",
"type": "rule",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
]
}
This endpoint requires the flows.read
scope.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
flowrequired
enum<string>
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.redirect-transaction
- Applies when processing any other transaction.
Available options:
checkout
, card-transaction
, redirect-transaction
Response
200 - application/json
items
object[]
A list of rules.
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/flows/{flow} \
--header 'Authorization: <authorization>'
{
"items": [
{
"action": "select-payment-options",
"conditions": [],
"created_at": "2013-07-16T19:23:00.000+00:00",
"description": "example rule.",
"flow": "checkout",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"position": "2",
"type": "rule",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
]
}