Flow
List flow outcomes
Returns a list of possible outcomes for a given flow action.
GET
/flows/{flow}/actions/{action}/outcomes
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/flows/{flow}/actions/{action}/outcomes \
--header 'Authorization: <authorization>'
{
"items": []
}
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
actionrequired
enum<string>
The flow action.
Available options:
select-payment-options
, decline-early
, route-transaction
, skip-3ds
Query Parameters
locale
Default: "en"string
An ISO 639-1 Language Code and optional ISO 3166 Country Code. This locale determines the language for the labels returned for every payment option.
Response
200 - application/json
items
object[]
A list of outcomes.
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/flows/{flow}/actions/{action}/outcomes \
--header 'Authorization: <authorization>'
{
"items": []
}