Class MPPAdapter

constructor

• new MPPAdapter(): MPPAdapter

  Returns MPPAdapter

Readonlyid

buildChallenge

• buildChallenge(
      amount: Money,
      recipient: string,
      methods: OmpxPaymentMethod[],
      request: Request,
      description?: string,
      secret?: string,
  ): Promise<{ "WWW-Authenticate": string[] }>

  Build WWW-Authenticate: Payment challenge headers for a 402 response. Returns an array of header values (one per payment method). Use Headers.append() to add multiple WWW-Authenticate headers.

  Parameters

  • amount: Money
  • recipient: string
  • methods: OmpxPaymentMethod[]
  • request: Request
  • Optionaldescription: string
  • Optionalsecret: string

  Returns Promise<{ "WWW-Authenticate": string[] }>

buildCredential

• buildCredential(credential: MPPCredential): Record<string, string>

  Build the Authorization: Payment header from an MPP credential (client-side).

  Parameters

  • credential: MPPCredential

  Returns Record<string, string>

buildReceipt

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

  Build the Payment-Receipt header for a successful response.

  Parameters

  • settlement: Settlement
  • challengeId: string

  Returns Record<string, string>

findMatchingChallenge

• findMatchingChallenge(
      requirements: PaymentRequirements,
      methods: OmpxPaymentMethod[],
  ): MPPChallenge | null

  Find a challenge from the requirements that the given methods can handle.

  Parameters

  • requirements: PaymentRequirements
  • methods: OmpxPaymentMethod[]

  Returns MPPChallenge | null

findMethod

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

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

  Parameters

  • credential: ParsedCredential
  • methods: OmpxPaymentMethod[]

  Returns OmpxPaymentMethod | null

parseChallenge

• parseChallenge(response: Response): PaymentRequirements | null

  Convert parsed MPP challenges to unified PaymentRequirements. Returns null if no valid MPP challenges found.

  Parameters

  • response: Response

  Returns PaymentRequirements | null

parseChallenges

• parseChallenges(response: Response): MPPChallenge[]

  Parse all MPP challenges from a 402 response's WWW-Authenticate headers (client-side). Returns an empty array if no MPP challenges are found.

  Parameters

  • response: Response

  Returns MPPChallenge[]

parseCredential

• parseCredential(request: Request): ParsedCredential | null

  Parse the Authorization: Payment header from an incoming request (server-side). Returns null if no MPP credential is present.

  Parameters

  • request: Request

  Returns ParsedCredential | null

parseReceipt

• parseReceipt(response: Response): MPPReceipt | null

  Parse the Payment-Receipt header from a successful response (client-side).

  Parameters

  • response: Response

  Returns MPPReceipt | null