51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
---
|
|
name: refunds-routes
|
|
description: Handle 3 OpenAPI operation(s) under /v2/refunds for the refunds route group.
|
|
---
|
|
|
|
# refunds API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /v2/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
|
|
|
|
### list_payment_refunds
|
|
|
|
- Operation ID: `list_payment_refunds`
|
|
- Route: `GET /v2/refunds`
|
|
- Mode: READ
|
|
- Summary: ListPaymentRefunds
|
|
- Parameters:
|
|
- `begin_time` in `query`
|
|
- `end_time` in `query`
|
|
- `sort_order` in `query`
|
|
- `cursor` in `query`
|
|
- `location_id` in `query`
|
|
- `status` in `query`
|
|
- `source_type` in `query`
|
|
- `limit` in `query`
|
|
- `updated_at_begin_time` in `query`
|
|
- `updated_at_end_time` in `query`
|
|
- `sort_field` in `query`
|
|
|
|
### refund_payment
|
|
|
|
- Operation ID: `refund_payment`
|
|
- Route: `POST /v2/refunds`
|
|
- Mode: WRITE
|
|
- Summary: RefundPayment
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_payment_refund
|
|
|
|
- Operation ID: `get_payment_refund`
|
|
- Route: `GET /v2/refunds/{refund_id}`
|
|
- Mode: READ
|
|
- Summary: GetPaymentRefund
|
|
- Parameters:
|
|
- `refund_id` in `path` required
|