list_gateways
Retrieve company payment gateways with optional filters by status, currency, or included attributes.
Instructions
List company gateways. GET /gateways. Optional: status (filter by active, disabled, error, archive), companyCurrencyId, include.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status (e.g. active, disabled, error, archive) | |
| companyCurrencyId | No | Filter by company currency ID | |
| include | No | Comma-separated attributes to include |
Implementation Reference
- src/tools/gateways/listGateways.ts:28-34 (handler)Handler function that parses args with Zod schema, then calls gatewayService.listGateways(client, parsed.data). Returns result via handleToolCall wrapper.
async function handler(client: Client, args: Record<string, unknown> | undefined) { const parsed = schema.safeParse(args); if (!parsed.success) { return errorResult(parsed.error.errors.map((e) => e.message).join("; ")); } return handleToolCall(() => gatewayService.listGateways(client, parsed.data)); } - Zod input validation schema defining optional fields: status, companyCurrencyId, include.
const schema = z.object({ status: z.string().optional(), companyCurrencyId: z.string().optional(), include: z.string().optional(), }); - src/tools/gateways/listGateways.ts:36-39 (registration)Tool object export combining definition and handler, registered as list_gateways.
export const listGatewaysTool: Tool = { definition, handler, }; - src/services/gatewayServices.ts:35-47 (handler)Core API function that builds query params and makes GET /gateways request via the client.
export async function listGateways( client: Client, params?: ListGatewaysParams ): Promise<unknown> { const searchParams: string[] = []; if (params?.status) searchParams.push(`status=${encodeURIComponent(params.status)}`); if (params?.companyCurrencyId) { searchParams.push(`companyCurrencyId=${encodeURIComponent(params.companyCurrencyId)}`); } if (params?.include) searchParams.push(`include=${encodeURIComponent(params.include)}`); const q = searchParams.join("&"); return client.get<unknown>(`/gateways${q ? `?${q}` : ""}`); } - src/tools/gateways/helpers.ts:18-26 (helper)handleToolCall utility that wraps async function calls, catching errors and returning success/error ToolResult.
export async function handleToolCall<T>(fn: () => Promise<T>): Promise<ToolResult> { try { const data = await fn(); return successResult(data); } catch (err) { const message = err instanceof Error ? err.message : String(err); return errorResult(`Error: ${message}`); } }