GET/api/v1/payments/flows
Flows: the steps a checkout page runs for a method.
- CLI
sendmock payments flows list- MCP tool
sendmock_payment_flow_list- In the app
- Payments > Flows
Answer
200 PaymentFlowDefinition[]
Payment flows
GET
POST/api/v1/payments/flows
Add a flow.
- CLI
sendmock payments flows create- MCP tool
sendmock_payment_flow_create- In the app
- Payments > Flows > Add flow
Request body (application/json)
PaymentFlowInput : Body of POST and PATCH /api/v1/payments/flows; the key is fixed after creation.
| Field | Type | Description |
|---|---|---|
| key | string | The flow's key; fixed after creation.Example: wallet_otp |
| name | string | The flow's name.Example: Wallet with OTP |
| picker_tab | string | The checkout picker tab its methods show under, e.g. "Mobile banking".Example: Mobile banking |
| steps | PaymentFlowStep[] | The steps in order. |
Answer
201 PaymentFlowDefinition
Errors: 400, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/payments/flows/{flowKey}
One payment flow with its steps.
- CLI
sendmock payments flows show <flowKey>- MCP tool
sendmock_payment_flow_get- In the app
- Payments > Flows > Edit
Answer
200 PaymentFlowDefinition
Errors: 404, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/payments/flows/{flowKey}
Change a flow.
- CLI
sendmock payments flows update <flowKey>- MCP tool
sendmock_payment_flow_update- In the app
- Payments > Flows > flow > Save flow
Request body (application/json)
PaymentFlowInput : Body of POST and PATCH /api/v1/payments/flows; the key is fixed after creation.
| Field | Type | Description |
|---|---|---|
| key | string | The flow's key; fixed after creation.Example: wallet_otp |
| name | string | The flow's name.Example: Wallet with OTP |
| picker_tab | string | The checkout picker tab its methods show under, e.g. "Mobile banking".Example: Mobile banking |
| steps | PaymentFlowStep[] | The steps in order. |
Answer
200 PaymentFlowDefinition
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/payments/flows/{flowKey}
Delete a custom flow; 409 while a method uses it.
- CLI
sendmock payments flows delete <flowKey>- MCP tool
sendmock_payment_flow_delete- In the app
- Payments > Flows > flow > Delete
Answer
204 No content
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/payments/flows/{flowKey}/reset
Put a built-in flow back as shipped.
- CLI
sendmock payments flows reset <flowKey>- MCP tool
sendmock_payment_flow_reset- In the app
- Payments > Flows > flow > Reset to default
Answer
200 PaymentFlowDefinition
Errors: 404, 409, as { error: { code, message } }
Try it in Demo mode
POST/api/v1/payments/flows/{flowKey}/steps
Add a step to a flow.
- CLI
sendmock payments flows steps add <flowKey>- MCP tool
sendmock_payment_flow_step_add- In the app
- Payments > Flows > flow > Add step
Request body (application/json)
PaymentFlowStepAddRequest : Body of POST /api/v1/payments/flows/{flowKey}/steps: one step, appended unless a position is given.
| Field | Type | Description |
|---|---|---|
| step | PaymentFlowStep | The step to add. |
| position? | number | Zero-based; the end of the flow when left out.Example: 1 |
Answer
200 PaymentFlowDefinition
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
Change one step of a flow.
- CLI
sendmock payments flows steps update <flowKey> <stepIndex>- MCP tool
sendmock_payment_flow_step_update- In the app
- Payments > Flows > flow > step labels, Move up, Move down
Request body (application/json)
PaymentFlowStepUpdateRequest : Body of PATCH /api/v1/payments/flows/{flowKey}/steps/{stepIndex}.
| Field | Type | Description |
|---|---|---|
| position? | number | Moves the step to this zero-based position.Example: 0 |
| title? | string | Shown above the step; may be empty.Example: Enter the code sent to your phone |
| field_label? | string | The input's label; empty for steps without a field.Example: Verification code |
| 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? | string | The button's text.Example: Verify |
Answer
200 PaymentFlowDefinition
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
Remove one step of a flow.
- CLI
sendmock payments flows steps remove <flowKey> <stepIndex>- MCP tool
sendmock_payment_flow_step_remove- In the app
- Payments > Flows > flow > Remove step
Answer
200 PaymentFlowDefinition
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
GET/api/v1/payments/step-types
The step types a flow can use, with their fields.
- CLI
sendmock payments flows step-types- MCP tool
sendmock_payment_step_type_list- In the app
- Payments > Flows > flow > Add step menu
Answer
200 PaymentStepTypeInfo[]
Try it in Demo mode
GET/api/v1/payments/flow-variables
The variables a step label can use.
- CLI
sendmock payments flows variables- MCP tool
sendmock_payment_flow_variable_list- In the app
- Payments > Flows > flow > Label variables
Answer
200 PaymentFlowVariable[]