payouts.create
Create a payout to transfer funds from a Ryft account to a payout method, specifying amount, currency, and account details.
Instructions
Create a Ryft payout for an account.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes | ||
| amount | Yes | ||
| currency | Yes | ||
| payoutMethodId | Yes | ||
| metadata | No |
Implementation Reference
- src/tools/payouts.ts:34-38 (handler)The handler function that executes the payouts.create tool.
async (args) => { const parsed = createPayoutSchema.parse(args); const { accountId, ...body } = parsed; return client.post(`/accounts/${accountId}/payouts`, body); }, - src/tools/payouts.ts:7-13 (schema)Input schema for the payouts.create tool.
const createPayoutSchema = z.object({ accountId: z.string().min(1), amount: z.number().int().positive(), currency: z.string().length(3), payoutMethodId: z.string().min(1), metadata: metadataSchema.optional(), }); - src/tools/payouts.ts:30-33 (registration)Registration of the payouts.create tool.
registerTool( 'payouts.create', 'Create a Ryft payout for an account.', createPayoutSchema.shape,