Payment flows commands

`sendmock payments flows create`

Add a flow.

sendmock payments flows create [flags]

Flag	Type	Description
--key <key>required	string	The flow's key; fixed after creation.Example: `wallet_otp`
--name <name>required	string	The flow's name.Example: `Wallet with OTP`
--picker-tab <picker-tab>required	string	The checkout picker tab its methods show under, e.g. "Mobile banking".Example: `Mobile banking`
--steps <steps>required	PaymentFlowStep[] (JSON)	The steps in order.Example: `[{"type":"otp","title":"Enter the code sent to your phone","field_label":"Verification code","hint":"We sent a 6 digit code to your {method} number.","button_label":"Verify"}]`

Example

sendmock payments flows create --key wallet_otp --name 'Wallet with OTP' --picker-tab 'Mobile banking' --steps '[{"type":"otp","title":"Enter the code sent to your phone","field_label":"Verification code","hint":"We sent a 6 digit code to your {method} number.","button_label":"Verify"}]'

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2.

API: POST/api/v1/payments/flows
MCP tool: sendmock_payment_flow_create
In the app: Payments > Flows > Add flow

`sendmock payments flows delete`

Delete a custom flow; 409 while a method uses it.

sendmock payments flows delete <flowKey> [flags]

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Flag	Type	Description
--yes	boolean	Confirms a destructive command; without it the command stops.

Example

sendmock payments flows delete card --yes

Output with --json: nothing. Exit codes: 0, 1, 2, 3.

API: DELETE/api/v1/payments/flows/{flowKey}
MCP tool: sendmock_payment_flow_delete
In the app: Payments > Flows > flow > Delete

`sendmock payments flows list`

Flows: the steps a checkout page runs for a method.

sendmock payments flows list

Example

sendmock payments flows list

Output with --json: PaymentFlowDefinition[]. Exit codes: 0, 1, 2.

API: GET/api/v1/payments/flows
MCP tool: sendmock_payment_flow_list
In the app: Payments > Flows

`sendmock payments flows reset`

Put a built-in flow back as shipped.

sendmock payments flows reset <flowKey>

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Example

sendmock payments flows reset card

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: POST/api/v1/payments/flows/{flowKey}/reset
MCP tool: sendmock_payment_flow_reset
In the app: Payments > Flows > flow > Reset to default

`sendmock payments flows show`

One payment flow with its steps.

sendmock payments flows show <flowKey>

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Example

sendmock payments flows show card

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: GET/api/v1/payments/flows/{flowKey}
MCP tool: sendmock_payment_flow_get
In the app: Payments > Flows > Edit

`sendmock payments flows step-types`

The step types a flow can use, with their fields.

sendmock payments flows step-types

Example

sendmock payments flows step-types

Output with --json: PaymentStepTypeInfo[]. Exit codes: 0, 1, 2.

API: GET/api/v1/payments/step-types
MCP tool: sendmock_payment_step_type_list
In the app: Payments > Flows > flow > Add step menu

`sendmock payments flows steps add`

Add a step to a flow.

sendmock payments flows steps add <flowKey> [flags]

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Flag	Type	Description
--step <step>required	PaymentFlowStep (JSON)	The step to add.
--position <position>	number	Zero-based; the end of the flow when left out.Example: `1`

Example

sendmock payments flows steps add card --step '{"type":"otp","title":"Enter the code sent to your phone","field_label":"Verification code","hint":"We sent a 6 digit code to your {method} number.","button_label":"Verify"}' --position 1

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: POST/api/v1/payments/flows/{flowKey}/steps
MCP tool: sendmock_payment_flow_step_add
In the app: Payments > Flows > flow > Add step

`sendmock payments flows steps remove`

Remove one step of a flow.

sendmock payments flows steps remove <flowKey> <stepIndex> [flags]

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
<stepIndex>required	integer	Position of the step in the flow, starting at 0.Example: `0`

Flag	Type	Description
--yes	boolean	Confirms a destructive command; without it the command stops.

Example

sendmock payments flows steps remove card 0 --yes

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: DELETE/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
MCP tool: sendmock_payment_flow_step_remove
In the app: Payments > Flows > flow > Remove step

`sendmock payments flows steps update`

Change one step of a flow.

sendmock payments flows steps update <flowKey> <stepIndex> [flags]

Also runs as sendmock payments flows steps move <flowKey> <stepIndex>.

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
<stepIndex>required	integer	Position of the step in the flow, starting at 0.Example: `0`

Flag	Type	Description
--position <position>	number	Moves the step to this zero-based position.Example: `0`
--title <title>	string	Shown above the step; may be empty.Example: `Enter the code sent to your phone`
--field-label <field-label>	string	The input's label; empty for steps without a field.Example: `Verification code`
--hint <hint>	string	Small text under the input; `{method}` and `{amount}` are replaced.Example: `We sent a 6 digit code to your {method} number.`
--button-label <button-label>	string	The button's text.Example: `Verify`

Example

sendmock payments flows steps update card 0 --position 0 --title 'Enter the code sent to your phone'

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: PATCH/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
MCP tool: sendmock_payment_flow_step_update
In the app: Payments > Flows > flow > step labels, Move up, Move down

`sendmock payments flows update`

Change a flow.

sendmock payments flows update <flowKey> [flags]

Argument	Type	Description
<flowKey>required	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Flag	Type	Description
--key <key>required	string	The flow's key; fixed after creation.Example: `wallet_otp`
--name <name>required	string	The flow's name.Example: `Wallet with OTP`
--picker-tab <picker-tab>required	string	The checkout picker tab its methods show under, e.g. "Mobile banking".Example: `Mobile banking`
--steps <steps>required	PaymentFlowStep[] (JSON)	The steps in order.Example: `[{"type":"otp","title":"Enter the code sent to your phone","field_label":"Verification code","hint":"We sent a 6 digit code to your {method} number.","button_label":"Verify"}]`

Example

sendmock payments flows update card --key wallet_otp --name 'Wallet with OTP' --picker-tab 'Mobile banking' --steps '[{"type":"otp","title":"Enter the code sent to your phone","field_label":"Verification code","hint":"We sent a 6 digit code to your {method} number.","button_label":"Verify"}]'

Output with --json: PaymentFlowDefinition. Exit codes: 0, 1, 2, 3.

API: PATCH/api/v1/payments/flows/{flowKey}
MCP tool: sendmock_payment_flow_update
In the app: Payments > Flows > flow > Save flow

`sendmock payments flows variables`

The variables a step label can use.

sendmock payments flows variables

Example

sendmock payments flows variables

Output with --json: PaymentFlowVariable[]. Exit codes: 0, 1, 2.

API: GET/api/v1/payments/flow-variables
MCP tool: sendmock_payment_flow_variable_list
In the app: Payments > Flows > flow > Label variables