paymentSessions.update
Modify an existing Ryft payment session to adjust amount, capture flow, customer email, or metadata for payment processing flexibility.
Instructions
Update a Ryft payment session.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| amount | No | ||
| captureFlow | No | ||
| customerEmail | No | ||
| metadata | No |
Implementation Reference
- src/tools/payment-sessions.ts:94-106 (handler)The registration and handler implementation for paymentSessions.update.
registerTool( 'paymentSessions.update', 'Update a Ryft payment session.', paymentSessionUpdateSchema.shape, async (args) => { const parsed = paymentSessionUpdateSchema.parse(args); const { id, customerEmail, ...rest } = parsed; const body = { ...rest, ...(customerEmail ? { customerEmail } : {}), }; return client.patch(`/payment-sessions/${id}`, body); }, - src/tools/payment-sessions.ts:17-23 (schema)Input validation schema for the paymentSessions.update tool.
const paymentSessionUpdateSchema = z.object({ id: z.string().min(1), amount: z.number().int().positive().optional(), captureFlow: z.enum(['Automatic', 'Manual']).optional(), customerEmail: z.string().email().optional(), metadata: z.record(z.string(), z.string()).optional(), });