GET
/
flows
/
{flow}
/
actions
/
{action}
/
outcomes

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
action
enum<string>
required

The flow action.

Available options:
select-payment-options,
decline-early,
route-transaction,
skip-3ds

Query Parameters

locale
string
default: en

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

Defines the outcome of a rule in a flow. Currently the outcomes can be a boolean value, or a list of string values. The meaning of this outcome depends on the action this rule is triggered for.

items
object[]

A list of outcomes.

Was this page helpful?

Delete flow ruleList merchant accounts