70 lines
1.7 KiB
Markdown
70 lines
1.7 KiB
Markdown
---
|
|
name: refunds-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/refunds for the refunds route group.
|
|
---
|
|
|
|
# refunds API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/refunds for the refunds 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_refunds
|
|
|
|
- Operation ID: `get_refunds`
|
|
- Route: `GET /v1/refunds`
|
|
- Mode: READ
|
|
- Summary: List all refunds
|
|
- 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.
|
|
|
|
### post_refunds
|
|
|
|
- Operation ID: `post_refunds`
|
|
- Route: `POST /v1/refunds`
|
|
- Mode: WRITE
|
|
- Summary: Create customer balance refund
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_refunds_refund
|
|
|
|
- Operation ID: `get_refunds_refund`
|
|
- Route: `GET /v1/refunds/{refund}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a refund
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `refund` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_refunds_refund
|
|
|
|
- Operation ID: `post_refunds_refund`
|
|
- Route: `POST /v1/refunds/{refund}`
|
|
- Mode: WRITE
|
|
- Summary: Update a refund
|
|
- Parameters:
|
|
- `refund` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_refunds_refund_cancel
|
|
|
|
- Operation ID: `post_refunds_refund_cancel`
|
|
- Route: `POST /v1/refunds/{refund}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel a refund
|
|
- Parameters:
|
|
- `refund` in `path` required
|
|
- Body: JSON request body accepted.
|