payouts.get
Retrieve payout details by ID to track financial transactions and verify payment status for account management.
Instructions
Get a Ryft payout by id.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes | ||
| payoutId | Yes |
Implementation Reference
- src/tools/payouts.ts:52-60 (handler)The handler implementation for 'payouts.get' which fetches a payout by accountId and payoutId.
registerTool( 'payouts.get', 'Get a Ryft payout by id.', payoutTargetSchema.shape, async (args) => { const { accountId, payoutId } = payoutTargetSchema.parse(args); return client.get(`/accounts/${accountId}/payouts/${payoutId}`); }, ); - src/tools/payouts.ts:15-18 (schema)The validation schema for the 'payouts.get' tool arguments.
const payoutTargetSchema = z.object({ accountId: z.string().min(1), payoutId: z.string().min(1), }); - src/tools/payouts.ts:29-61 (registration)The registration function for payout tools where 'payouts.get' is registered.
export function registerPayoutTools(registerTool: ToolRegistrar, client: RyftHttpClient) { registerTool( 'payouts.create', 'Create a Ryft payout for an account.', createPayoutSchema.shape, async (args) => { const parsed = createPayoutSchema.parse(args); const { accountId, ...body } = parsed; return client.post(`/accounts/${accountId}/payouts`, body); }, ); registerTool( 'payouts.list', 'List Ryft payouts for an account.', listPayoutsSchema.shape, async (args) => { const parsed = listPayoutsSchema.parse(args); const { accountId, ...query } = parsed; return client.get(`/accounts/${accountId}/payouts`, { query: query as Record<string, QueryValue> }); }, ); registerTool( 'payouts.get', 'Get a Ryft payout by id.', payoutTargetSchema.shape, async (args) => { const { accountId, payoutId } = payoutTargetSchema.parse(args); return client.get(`/accounts/${accountId}/payouts/${payoutId}`); }, ); }