balanceTransactions.list
Retrieve and filter Ryft balance transaction records for financial tracking and reconciliation. Supports pagination, payout-specific queries, and account-based filtering.
Instructions
List Ryft balance transactions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| startsAfter | No | ||
| payoutId | No | ||
| accountId | No |
Implementation Reference
- src/tools/balances.ts:37-44 (handler)The handler function for balanceTransactions.list which parses arguments and calls the Ryft HTTP client to fetch balance transactions.
async (args) => { const parsed = listBalanceTransactionsSchema.parse(args); const { accountId, ...query } = parsed; return client.get('/balance-transactions', { query: query as Record<string, QueryValue>, ...(accountId ? { accountId } : {}), }); }, - src/tools/balances.ts:11-16 (schema)The Zod schema definition for balanceTransactions.list arguments.
const listBalanceTransactionsSchema = z.object({ limit: z.number().int().positive().max(100).optional(), startsAfter: z.string().optional(), payoutId: z.string().min(1).optional(), accountId: z.string().min(1).optional(), }); - src/tools/balances.ts:33-45 (registration)The registration of the balanceTransactions.list tool.
registerTool( 'balanceTransactions.list', 'List Ryft balance transactions.', listBalanceTransactionsSchema.shape, async (args) => { const parsed = listBalanceTransactionsSchema.parse(args); const { accountId, ...query } = parsed; return client.get('/balance-transactions', { query: query as Record<string, QueryValue>, ...(accountId ? { accountId } : {}), }); }, );