54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
---
|
|
name: cards-routes
|
|
description: Handle 4 OpenAPI operation(s) under /v2/cards for the cards route group.
|
|
---
|
|
|
|
# cards API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /v2/cards for the cards 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
|
|
|
|
### list_cards
|
|
|
|
- Operation ID: `list_cards`
|
|
- Route: `GET /v2/cards`
|
|
- Mode: READ
|
|
- Summary: ListCards
|
|
- Parameters:
|
|
- `cursor` in `query`
|
|
- `customer_id` in `query`
|
|
- `include_disabled` in `query`
|
|
- `reference_id` in `query`
|
|
- `sort_order` in `query`
|
|
|
|
### create_card
|
|
|
|
- Operation ID: `create_card`
|
|
- Route: `POST /v2/cards`
|
|
- Mode: WRITE
|
|
- Summary: CreateCard
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_card
|
|
|
|
- Operation ID: `retrieve_card`
|
|
- Route: `GET /v2/cards/{card_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveCard
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
|
|
### disable_card
|
|
|
|
- Operation ID: `disable_card`
|
|
- Route: `POST /v2/cards/{card_id}/disable`
|
|
- Mode: WRITE
|
|
- Summary: DisableCard
|
|
- Parameters:
|
|
- `card_id` in `path` required
|