62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
---
|
|
name: disputes-routes
|
|
description: Handle 4 OpenAPI operation(s) under /v1/disputes for the disputes route group.
|
|
---
|
|
|
|
# disputes API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /v1/disputes for the disputes 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
|
|
|
|
### get_disputes
|
|
|
|
- Operation ID: `get_disputes`
|
|
- Route: `GET /v1/disputes`
|
|
- Mode: READ
|
|
- Summary: List all disputes
|
|
- Parameters:
|
|
- `charge` in `query`
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `payment_intent` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_disputes_dispute
|
|
|
|
- Operation ID: `get_disputes_dispute`
|
|
- Route: `GET /v1/disputes/{dispute}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a dispute
|
|
- Parameters:
|
|
- `dispute` in `path` required
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_disputes_dispute
|
|
|
|
- Operation ID: `post_disputes_dispute`
|
|
- Route: `POST /v1/disputes/{dispute}`
|
|
- Mode: WRITE
|
|
- Summary: Update a dispute
|
|
- Parameters:
|
|
- `dispute` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_disputes_dispute_close
|
|
|
|
- Operation ID: `post_disputes_dispute_close`
|
|
- Route: `POST /v1/disputes/{dispute}/close`
|
|
- Mode: WRITE
|
|
- Summary: Close a dispute
|
|
- Parameters:
|
|
- `dispute` in `path` required
|
|
- Body: JSON request body accepted.
|