81 lines
2.0 KiB
Markdown
81 lines
2.0 KiB
Markdown
---
|
|
name: payouts-routes
|
|
description: Handle 6 OpenAPI operation(s) under /v1/payouts for the payouts route group.
|
|
---
|
|
|
|
# payouts API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /v1/payouts for the payouts 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_payouts
|
|
|
|
- Operation ID: `get_payouts`
|
|
- Route: `GET /v1/payouts`
|
|
- Mode: READ
|
|
- Summary: List all payouts
|
|
- Parameters:
|
|
- `arrival_date` in `query`
|
|
- `created` in `query`
|
|
- `destination` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- `status` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_payouts
|
|
|
|
- Operation ID: `post_payouts`
|
|
- Route: `POST /v1/payouts`
|
|
- Mode: WRITE
|
|
- Summary: Create a payout
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_payouts_payout
|
|
|
|
- Operation ID: `get_payouts_payout`
|
|
- Route: `GET /v1/payouts/{payout}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a payout
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `payout` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_payouts_payout
|
|
|
|
- Operation ID: `post_payouts_payout`
|
|
- Route: `POST /v1/payouts/{payout}`
|
|
- Mode: WRITE
|
|
- Summary: Update a payout
|
|
- Parameters:
|
|
- `payout` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_payouts_payout_cancel
|
|
|
|
- Operation ID: `post_payouts_payout_cancel`
|
|
- Route: `POST /v1/payouts/{payout}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel a payout
|
|
- Parameters:
|
|
- `payout` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_payouts_payout_reverse
|
|
|
|
- Operation ID: `post_payouts_payout_reverse`
|
|
- Route: `POST /v1/payouts/{payout}/reverse`
|
|
- Mode: WRITE
|
|
- Summary: Reverse a payout
|
|
- Parameters:
|
|
- `payout` in `path` required
|
|
- Body: JSON request body accepted.
|