Interface PaymentRail

A payment rail — registered by id, mirrors the ActivityRegistry resolver shape.

interface PaymentRail {
    id: string;
    available?(
        req: PaymentRequest,
        ctx: RouterContext,
    ): boolean | Promise<boolean>;
    match(req: PaymentRequest, ctx: RouterContext): boolean;
    quote(req: PaymentRequest, ctx: RouterContext): Promise<RouteQuote>;
}

Index

Properties

Methods

available? match quote

Properties

id

id: string

Methods

`Optional`available

available?(req: PaymentRequest, ctx: RouterContext): boolean | Promise<boolean>
Availability gate — where a rail drops itself for an out-of-limits amount.
Parameters
- req: PaymentRequest
- ctx: RouterContext
Returns boolean | Promise<boolean>
- Defined in payment/types.ts:91

match

match(req: PaymentRequest, ctx: RouterContext): boolean
Classification only — amount-blind; takes the request for uniformity.
Parameters
- req: PaymentRequest
- ctx: RouterContext
Returns boolean
- Defined in payment/types.ts:89

quote

quote(req: PaymentRequest, ctx: RouterContext): Promise<RouteQuote>
Parameters
- req: PaymentRequest
- ctx: RouterContext
Returns Promise<RouteQuote>
- Defined in payment/types.ts:92