const x402PaymentPayload: Type<{ asset?: string; network: string; payload: object; scheme: string; x402Version: number; }, { }>

Defined in: packages/types/src/x402.ts:62

x402PaymentRequiredResponse

const x402PaymentRequiredResponse: Type<{ accepts: object[]; error: string; x402Version: number; }, { }>

Defined in: packages/types/src/x402.ts:39

x402PaymentRequiredResponseLenient

const x402PaymentRequiredResponseLenient: Type<{ accepts: object[]; error?: string; x402Version: number; }, { }>

Defined in: packages/types/src/x402.ts:53 Lenient payment required response parser that accepts optional error field. Use this when parsing incoming data from older servers that may not include the error field.

x402PaymentRequirements

const x402PaymentRequirements: Type<{ asset: string; description: string; extra?: object; maxAmountRequired: string; maxTimeoutSeconds: number; mimeType?: string; network: string; outputSchema?: object; payTo: string; resource: string; scheme: string; }, { }>

Defined in: packages/types/src/x402.ts:23

x402SettleRequest

const x402SettleRequest: Type<{ paymentHeader?: string; paymentPayload?: { asset?: string; network: string; payload: object; scheme: string; x402Version: number; }; paymentRequirements: { asset: string; description: string; extra?: object; maxAmountRequired: string; maxTimeoutSeconds: number; mimeType?: string; network: string; outputSchema?: object; payTo: string; resource: string; scheme: string; }; x402Version: number; }, { }> = x402VerifyRequest

Defined in: packages/types/src/x402.ts:107

x402SettleResponse

const x402SettleResponse: Type<{ errorReason?: string; network: string; payer: string; success: boolean; transaction: string; }, { }>

Defined in: packages/types/src/x402.ts:131 Spec-compliant settle response per x402-specification-v1.md Section 5.3. Field names: transaction, network, errorReason (not txHash, networkId, error)

x402SettleResponseLegacy

const x402SettleResponseLegacy: Type<{ error?: null | string; networkId: null | string; payer?: string; success: boolean; txHash: null | string; }, { }>

Defined in: packages/types/src/x402.ts:117 Legacy settle response type with pre-spec field names (txHash, networkId, error). Use x402SettleResponse for spec-compliant field names (transaction, network, errorReason). This type exists for backward compatibility when interfacing with older clients that use legacy field names.

x402SettleResponseLenient

const x402SettleResponseLenient: Type<{ error?: null | string; errorReason?: null | string; network?: null | string; networkId?: null | string; payer?: string; success: boolean; transaction?: null | string; txHash?: null | string; }, { }>

Defined in: packages/types/src/x402.ts:146 Lenient settle response parser that accepts either legacy or spec-compliant field names. Use this when parsing incoming data that may come from older clients using legacy field names.

x402SupportedKind

const x402SupportedKind: Type<{ extra?: object; network: string; scheme: string; x402Version: number; }, { }>

Defined in: packages/types/src/x402.ts:180

x402SupportedResponse

const x402SupportedResponse: Type<{ kinds: object[]; }, { }>

Defined in: packages/types/src/x402.ts:189

x402VerifyRequest

const x402VerifyRequest: Type<{ paymentHeader?: string; paymentPayload?: { asset?: string; network: string; payload: object; scheme: string; x402Version: number; }; paymentRequirements: { asset: string; description: string; extra?: object; maxAmountRequired: string; maxTimeoutSeconds: number; mimeType?: string; network: string; outputSchema?: object; payTo: string; resource: string; scheme: string; }; x402Version: number; }, { }>

Defined in: packages/types/src/x402.ts:77

x402VerifyResponse

const x402VerifyResponse: Type<{ invalidReason?: string; isValid: boolean; payer: string; }, { }>

Defined in: packages/types/src/x402.ts:86

x402VerifyResponseLenient

const x402VerifyResponseLenient: Type<{ invalidReason?: null | string; isValid: boolean; payer?: string; }, { }>

Defined in: packages/types/src/x402.ts:99 Lenient verify response parser that accepts optional payer field. Use this when parsing incoming data from older facilitators that may not include the payer field.

Functions

generateRequirementsMatcher()

generateRequirementsMatcher(scheme, network, asset): object

Defined in: packages/types/src/x402.ts:206 Creates a matcher function for filtering payment requirements. The matcher performs case-insensitive matching on scheme, network, and asset fields.

Parameters

scheme

string[] Accepted payment scheme names

network

string[] Accepted network identifiers

asset

string[] Accepted asset addresses

Returns

object Object with the matcher tuple and isMatchingRequirement function

isMatchingRequirement()

isMatchingRequirement: (req) => boolean

Parameters

req

asset

string = ...

network

string = ...

scheme

string = ...

Returns

boolean

matchTuple

matchTuple: Type<{ asset: (In) => To; network: (In) => To; scheme: (In) => To; }, { }>

normalizeSettleResponse()

normalizeSettleResponse(res): object

Defined in: packages/types/src/x402.ts:164 Normalize a lenient settle response to spec-compliant field names. Converts legacy field names (txHash, networkId, error) to spec-compliant names (transaction, network, errorReason).