Method.from

Creates a payment method definition.

Usage

import { Method, z } from 'mppx'
 
const charge = Method.from({
  intent: 'charge',
  name: 'tempo',
  schema: {
    credential: {
      payload: z.object({
        signature: z.string(),
        type: z.literal('transaction'),
      }),
    },
    request: z.object({
      amount: z.string(),
      currency: z.string(),
      recipient: z.string(),
    }),
  },
})

Return type

type ReturnType = method

The method object passed in (identity function for type inference).

Parameters

intent

• Type: string

Intent type (for example, "charge", "session").

method

Payment method definition.

name

• Type: string

Payment method name (for example, "tempo", "stripe").

schema

• Type: { credential: { payload: ZodMiniType }, request: ZodMiniType }

Zod schemas for validating Credential payloads and request parameters.