Payment flows tools

`sendmock_payment_flow_create`

Add a flow.

Toolset payments.

Input	Type	Description
keyrequired	string	The flow's key; fixed after creation.Example: `wallet_otp`
namerequired	string	The flow's name.Example: `Wallet with OTP`
picker_tabrequired	string	The checkout picker tab its methods show under, e.g. "Mobile banking".Example: `Mobile banking`
stepsrequired	PaymentFlowStep[]	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 call

{
  "name": "sendmock_payment_flow_create",
  "arguments": {
    "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"
      }
    ]
  }
}

Result: PaymentFlowDefinition

API: POST/api/v1/payments/flows
CLI: sendmock payments flows create
In the app: Payments > Flows > Add flow

`sendmock_payment_flow_delete`

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

Toolset payments.

Destructive
Idempotent

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Example call

{
  "name": "sendmock_payment_flow_delete",
  "arguments": {
    "flow_key": "card"
  }
}

Result: nothing

API: DELETE/api/v1/payments/flows/{flowKey}
CLI: sendmock payments flows delete <flowKey>
In the app: Payments > Flows > flow > Delete

`sendmock_payment_flow_get`

One payment flow with its steps.

Toolset payments.

Read only

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Example call

{
  "name": "sendmock_payment_flow_get",
  "arguments": {
    "flow_key": "card"
  }
}

Result: PaymentFlowDefinition

API: GET/api/v1/payments/flows/{flowKey}
CLI: sendmock payments flows show <flowKey>
In the app: Payments > Flows > Edit

`sendmock_payment_flow_list`

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

Toolset payments.

Read only

No inputs.

Example call

{
  "name": "sendmock_payment_flow_list",
  "arguments": {}
}

Result: PaymentFlowDefinition[]

API: GET/api/v1/payments/flows
CLI: sendmock payments flows list
In the app: Payments > Flows

`sendmock_payment_flow_reset`

Put a built-in flow back as shipped.

Toolset payments.

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`

Example call

{
  "name": "sendmock_payment_flow_reset",
  "arguments": {
    "flow_key": "card"
  }
}

Result: PaymentFlowDefinition

API: POST/api/v1/payments/flows/{flowKey}/reset
CLI: sendmock payments flows reset <flowKey>
In the app: Payments > Flows > flow > Reset to default

`sendmock_payment_flow_step_add`

Add a step to a flow.

Toolset payments.

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
steprequired	PaymentFlowStep	The step to add.
position	number	Zero-based; the end of the flow when left out.Example: `1`

Example call

{
  "name": "sendmock_payment_flow_step_add",
  "arguments": {
    "flow_key": "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
  }
}

Result: PaymentFlowDefinition

API: POST/api/v1/payments/flows/{flowKey}/steps
CLI: sendmock payments flows steps add <flowKey>
In the app: Payments > Flows > flow > Add step

`sendmock_payment_flow_step_remove`

Remove one step of a flow.

Toolset payments.

Destructive
Idempotent

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
step_indexrequired	integer	Position of the step in the flow, starting at 0.Example: `0`

Example call

{
  "name": "sendmock_payment_flow_step_remove",
  "arguments": {
    "flow_key": "card",
    "step_index": 0
  }
}

Result: PaymentFlowDefinition

API: DELETE/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
CLI: sendmock payments flows steps remove <flowKey> <stepIndex>
In the app: Payments > Flows > flow > Remove step

`sendmock_payment_flow_step_update`

Change one step of a flow.

Toolset payments; also answers as sendmock_payment_flow_step_move.

Idempotent

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
step_indexrequired	integer	Position of the step in the flow, starting at 0.Example: `0`
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`

Example call

{
  "name": "sendmock_payment_flow_step_update",
  "arguments": {
    "flow_key": "card",
    "step_index": 0,
    "position": 0,
    "title": "Enter the code sent to your phone"
  }
}

Result: PaymentFlowDefinition

API: PATCH/api/v1/payments/flows/{flowKey}/steps/{stepIndex}
CLI: sendmock payments flows steps update <flowKey> <stepIndex>
In the app: Payments > Flows > flow > step labels, Move up, Move down

`sendmock_payment_flow_update`

Change a flow.

Toolset payments.

Idempotent

Input	Type	Description
flow_keyrequired	string	The payment flow's key, e.g. `card` or `wallet`.Example: `card`
keyrequired	string	The flow's key; fixed after creation.Example: `wallet_otp`
namerequired	string	The flow's name.Example: `Wallet with OTP`
picker_tabrequired	string	The checkout picker tab its methods show under, e.g. "Mobile banking".Example: `Mobile banking`
stepsrequired	PaymentFlowStep[]	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 call

{
  "name": "sendmock_payment_flow_update",
  "arguments": {
    "flow_key": "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"
      }
    ]
  }
}

Result: PaymentFlowDefinition

API: PATCH/api/v1/payments/flows/{flowKey}
CLI: sendmock payments flows update <flowKey>
In the app: Payments > Flows > flow > Save flow

`sendmock_payment_flow_variable_list`

The variables a step label can use.

Toolset payments.

Read only

No inputs.

Example call

{
  "name": "sendmock_payment_flow_variable_list",
  "arguments": {}
}

Result: PaymentFlowVariable[]

API: GET/api/v1/payments/flow-variables
CLI: sendmock payments flows variables
In the app: Payments > Flows > flow > Label variables

`sendmock_payment_step_type_list`

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

Toolset payments.

Read only

No inputs.

Example call

{
  "name": "sendmock_payment_step_type_list",
  "arguments": {}
}

Result: PaymentStepTypeInfo[]

API: GET/api/v1/payments/step-types
CLI: sendmock payments flows step-types
In the app: Payments > Flows > flow > Add step menu