Skip to main content
Glama

payouts.list

Retrieve and display payout records for a Ryft account, enabling users to view transaction history and manage financial data.

Instructions

List Ryft payouts for an account.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountIdYes
startTimestampNo
endTimestampNo
ascendingNo
limitNo
startsAfterNo

Implementation Reference

  • The handler for 'payouts.list' which parses input using listPayoutsSchema and calls the Ryft HTTP client.
    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> });
      },
    );
  • Input validation schema for 'payouts.list'.
    const listPayoutsSchema = z.object({
      accountId: z.string().min(1),
      startTimestamp: z.number().int().optional(),
      endTimestamp: z.number().int().optional(),
      ascending: z.boolean().optional(),
      limit: z.number().int().positive().max(100).optional(),
      startsAfter: z.string().optional(),
    });
  • Registration function that exposes 'payouts.list' to the MCP tool registry.
    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}`);
        },
      );
    }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bkawk/ryft-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server