Flow structure
A flow is a JSON object with the following top-level fields:
Each node has a
type and a data object. The fields in data differ by node type.
Node types
Start
Marks the entry point of the flow. Every flow must have exactly one start node, and the top-levelstart field must reference its id.
Transaction
Pauses the flow and dispatches a CloudEvent to your processor integration. The flow resumes when your integration responds with a Finish event.The
ce-type of the Custom Transaction Event sent to your integration.Gateway
Evaluates theresult from your integration’s Finish event and routes the flow to the appropriate next node. If no rule matches, the flow execution fails.
Requirement
Signals that an external action must be completed before the flow can continue — for example, a 3DS authentication challenge presented to the cardholder. The flow pauses until it receives a confirmation event routed through the next gateway.Transition
Sets the flow’s outcome state and then routes to the next node. Use this node to record whether a flow path ended in success or failure before reaching the end.End
Marks a terminal point in the flow. A flow can have multiple end nodes — for example, one per outcome path.Schema
Download the JSON Schema (Draft 2020-12): flow.schema.jsonExamples
- Payment
- Refund
The payment flow handles a card sale with optional 3DS v1 authentication. If the processor requires 3DS, the flow pauses for the cardholder challenge and then confirms authentication before completing the sale.

