List Payouts
flowcheck_list_payoutsRetrieve and filter Stripe and Shopify payout records with reconciliation status. View payout amounts, filter by source, status, and date range, and access paginated results with confidence scores.
Instructions
List Stripe and Shopify payouts with reconciliation status. Filter by source, status, and date range. Returns paginated results with match confidence scores. Amounts in cents.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | Filter by payout source | |
| status | No | Filter by payout status | |
| from | No | Start date filter (YYYY-MM-DD) | |
| to | No | End date filter (YYYY-MM-DD) | |
| limit | No | Results per page (default 50, max 100) | |
| cursor | No | Pagination cursor from previous response |
Implementation Reference
- src/tools/payouts.ts:9-50 (registration)The tool "flowcheck_list_payouts" is registered here, including its input schema and handler implementation.
server.registerTool( "flowcheck_list_payouts", { title: "List Payouts", description: "List Stripe and Shopify payouts with reconciliation status. " + "Filter by source, status, and date range. Returns paginated results " + "with match confidence scores. Amounts in cents.", inputSchema: z.object({ source: z .enum(["stripe", "shopify"]) .optional() .describe("Filter by payout source"), status: z .enum(["paid", "pending", "in_transit", "failed", "canceled"]) .optional() .describe("Filter by payout status"), from: z .string() .optional() .describe("Start date filter (YYYY-MM-DD)"), to: z .string() .optional() .describe("End date filter (YYYY-MM-DD)"), limit: z .number() .min(1) .max(100) .optional() .describe("Results per page (default 50, max 100)"), cursor: z .string() .optional() .describe("Pagination cursor from previous response"), }), }, async (params) => { const result = await client.request("GET", "/payouts", { params }); return { content: [{ type: "text" as const, text: result }] }; }, );