List flow outcomes
Returns a list of possible outcomes for a given flow action.
This endpoint requires theDocumentation Index
Fetch the complete documentation index at: https://docs.wizlopay.com/llms.txt
Use this file to discover all available pages before exploring further.
flows.read scope.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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 thedecline-earlyaction.redirect-transaction- Applies when processing any other transaction. The name of the Flow.
checkout, card-transaction, non-card-transaction, redirect-transaction "checkout"
The flow action. Action for the given rule. Actions can only be used in flows that support them.
- The
checkoutflow only supports theselect-payment-optionsaction. - The
card-transactionsupports theroute-transaction,skip-3ds, anddecline-earlyactions. - The
non-card-transactionflow only supports thedecline-earlyaction. - The
redirect-transactionflow only supports theroute-transactionaction.
select-payment-options, decline-early, route-transaction, skip-3ds "select-payment-options"
Query Parameters
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.
^[a-z]{2}(?:-[A-Z]{2})?$"en-US"
Response
Returns a list of rule outcomes.
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.
A list of outcomes.
Outcome for checkout flow/select payment options action. Each option is a Gr4vy payment option object.
- Checkout/Payment Option Outcome
- Card Transactions/Routing Outcome
- Redirect Transactions/Routing Outcome