payoutMethods.create
Create payout methods for Ryft accounts to enable fund transfers, specifying bank details, currency, and country requirements.
Instructions
Create a Ryft payout method for an account.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accountId | Yes | ||
| type | Yes | ||
| displayName | No | ||
| currency | Yes | ||
| country | Yes | ||
| bankAccount | Yes |
Implementation Reference
- src/tools/payout-methods.ts:48-52 (handler)Handler implementation for payoutMethods.create, which posts to the Ryft API.
async (args) => { const parsed = createPayoutMethodSchema.parse(args); const { accountId, ...body } = parsed; return client.post(`/accounts/${accountId}/payout-methods`, body); }, - src/tools/payout-methods.ts:15-22 (schema)Schema definition for payoutMethods.create input arguments.
const createPayoutMethodSchema = z.object({ accountId: z.string().min(1), type: z.string().min(1), displayName: z.string().min(1).optional(), currency: z.string().length(3), country: z.string().length(2), bankAccount: bankAccountSchema, }); - src/tools/payout-methods.ts:44-53 (registration)Tool registration for payoutMethods.create.
registerTool( 'payoutMethods.create', 'Create a Ryft payout method for an account.', createPayoutMethodSchema.shape, async (args) => { const parsed = createPayoutMethodSchema.parse(args); const { accountId, ...body } = parsed; return client.post(`/accounts/${accountId}/payout-methods`, body); }, );