botwallet_cancel_paylink
Cancel a pending payment request before it is paid or expires. Use this tool to stop payment processing by providing the request ID.
Instructions
Cancel a pending payment request. Only pending paylinks can be cancelled — paid or expired paylinks cannot.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | Yes | Payment request ID to cancel |
Implementation Reference
- src/tools/earning.ts:139-147 (handler)The handler function for botwallet_cancel_paylink which calls ctx.sdk.cancelPaymentRequest.
async handler(args, ctx) { try { const { request_id } = args as { request_id: string }; const result = await ctx.sdk.cancelPaymentRequest({ request_id }); return formatResult(result); } catch (e) { return formatToolError(e); } }, - src/tools/earning.ts:136-138 (schema)Input schema definition for botwallet_cancel_paylink.
inputSchema: z.object({ request_id: z.string().describe('Payment request ID to cancel'), }), - src/tools/earning.ts:133-148 (registration)The full ToolDefinition for botwallet_cancel_paylink.
const cancelPaylink: ToolDefinition = { name: 'botwallet_cancel_paylink', description: 'Cancel a pending payment request. Only pending paylinks can be cancelled — paid or expired paylinks cannot.', inputSchema: z.object({ request_id: z.string().describe('Payment request ID to cancel'), }), async handler(args, ctx) { try { const { request_id } = args as { request_id: string }; const result = await ctx.sdk.cancelPaymentRequest({ request_id }); return formatResult(result); } catch (e) { return formatToolError(e); } }, };