3.7 KiB
3.7 KiB
name, description
| name | description |
|---|---|
| terminals-routes | Handle 15 OpenAPI operation(s) under /v2/terminals for the terminals route group. |
terminals API Routes
Handle 15 OpenAPI operation(s) under /v2/terminals for the terminals route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
create_terminal_action
- Operation ID:
create_terminal_action - Route:
POST /v2/terminals/actions - Mode: WRITE
- Summary: CreateTerminalAction
- Body: JSON request body accepted.
search_terminal_actions
- Operation ID:
search_terminal_actions - Route:
POST /v2/terminals/actions/search - Mode: WRITE
- Summary: SearchTerminalActions
- Body: JSON request body accepted.
get_terminal_action
- Operation ID:
get_terminal_action - Route:
GET /v2/terminals/actions/{action_id} - Mode: READ
- Summary: GetTerminalAction
- Parameters:
action_idinpathrequired
cancel_terminal_action
- Operation ID:
cancel_terminal_action - Route:
POST /v2/terminals/actions/{action_id}/cancel - Mode: WRITE
- Summary: CancelTerminalAction
- Parameters:
action_idinpathrequired
dismiss_terminal_action
- Operation ID:
dismiss_terminal_action - Route:
POST /v2/terminals/actions/{action_id}/dismiss - Mode: WRITE
- Summary: DismissTerminalAction
- Parameters:
action_idinpathrequired
create_terminal_checkout
- Operation ID:
create_terminal_checkout - Route:
POST /v2/terminals/checkouts - Mode: WRITE
- Summary: CreateTerminalCheckout
- Body: JSON request body accepted.
search_terminal_checkouts
- Operation ID:
search_terminal_checkouts - Route:
POST /v2/terminals/checkouts/search - Mode: WRITE
- Summary: SearchTerminalCheckouts
- Body: JSON request body accepted.
get_terminal_checkout
- Operation ID:
get_terminal_checkout - Route:
GET /v2/terminals/checkouts/{checkout_id} - Mode: READ
- Summary: GetTerminalCheckout
- Parameters:
checkout_idinpathrequired
cancel_terminal_checkout
- Operation ID:
cancel_terminal_checkout - Route:
POST /v2/terminals/checkouts/{checkout_id}/cancel - Mode: WRITE
- Summary: CancelTerminalCheckout
- Parameters:
checkout_idinpathrequired
dismiss_terminal_checkout
- Operation ID:
dismiss_terminal_checkout - Route:
POST /v2/terminals/checkouts/{checkout_id}/dismiss - Mode: WRITE
- Summary: DismissTerminalCheckout
- Parameters:
checkout_idinpathrequired
create_terminal_refund
- Operation ID:
create_terminal_refund - Route:
POST /v2/terminals/refunds - Mode: WRITE
- Summary: CreateTerminalRefund
- Body: JSON request body accepted.
search_terminal_refunds
- Operation ID:
search_terminal_refunds - Route:
POST /v2/terminals/refunds/search - Mode: WRITE
- Summary: SearchTerminalRefunds
- Body: JSON request body accepted.
get_terminal_refund
- Operation ID:
get_terminal_refund - Route:
GET /v2/terminals/refunds/{terminal_refund_id} - Mode: READ
- Summary: GetTerminalRefund
- Parameters:
terminal_refund_idinpathrequired
cancel_terminal_refund
- Operation ID:
cancel_terminal_refund - Route:
POST /v2/terminals/refunds/{terminal_refund_id}/cancel - Mode: WRITE
- Summary: CancelTerminalRefund
- Parameters:
terminal_refund_idinpathrequired
dismiss_terminal_refund
- Operation ID:
dismiss_terminal_refund - Route:
POST /v2/terminals/refunds/{terminal_refund_id}/dismiss - Mode: WRITE
- Summary: DismissTerminalRefund
- Parameters:
terminal_refund_idinpathrequired