Class X402Adapter

constructor

• new X402Adapter(): X402Adapter

  Returns X402Adapter

Readonlyid

buildChallenge

• buildChallenge(
      amount: Money,
      recipient: string,
      methods: OmpxPaymentMethod[],
      resource: string,
      description?: string,
  ): Record<string, string>

  Build the PAYMENT-REQUIRED header value for a 402 response. Returns headers to be added to the response.

  Parameters

  • amount: Money
  • recipient: string
  • methods: OmpxPaymentMethod[]
  • resource: string
  • Optionaldescription: string

  Returns Record<string, string>

buildCredential

• buildCredential(payload: X402PaymentPayload): Record<string, string>

  Build the PAYMENT-SIGNATURE header from a signed payment payload (client-side).

  Parameters

  • payload: X402PaymentPayload

  Returns Record<string, string>

buildErrorReceipt

• buildErrorReceipt(error: string): Record<string, string>

  Build error response headers (402 with error info in PAYMENT-RESPONSE).

  Parameters

  • error: string

  Returns Record<string, string>

buildReceipt

• buildReceipt(settlement: Settlement): Record<string, string>

  Build the PAYMENT-RESPONSE header for a successful settlement response.

  Parameters

  • settlement: Settlement

  Returns Record<string, string>

findMatchingAccept

• findMatchingAccept(
      requirements: PaymentRequirements,
      methods: OmpxPaymentMethod[],
  ): X402PaymentAccept | null

  Find a matching payment accept option from the requirements that the given methods can handle.

  Parameters

  • requirements: PaymentRequirements
  • methods: OmpxPaymentMethod[]

  Returns X402PaymentAccept | null

findMethod

• findMethod(
      credential: ParsedCredential,
      methods: OmpxPaymentMethod[],
  ): OmpxPaymentMethod | null

  Find the payment method that can handle the given X402 credential.

  Parameters

  • credential: ParsedCredential
  • methods: OmpxPaymentMethod[]

  Returns OmpxPaymentMethod | null

parseChallenge

• parseChallenge(response: Response): PaymentRequirements | null

  Parse the PAYMENT-REQUIRED header from a 402 response (client-side). Returns null if no X402 challenge is present.

  Parameters

  • response: Response

  Returns PaymentRequirements | null

parseCredential

• parseCredential(request: Request): ParsedCredential | null

  Parse the PAYMENT-SIGNATURE header from an incoming request (server-side). Returns null if no X402 credential is present.

  Parameters

  • request: Request

  Returns ParsedCredential | null

parseReceipt

• parseReceipt(response: Response): X402SettlementResponse | null

  Parse the PAYMENT-RESPONSE header from a 200 response (client-side).

  Parameters

  • response: Response

  Returns X402SettlementResponse | null