Class X402A2AUtils

constructor

• new X402A2AUtils(): X402A2AUtils

  Returns X402A2AUtils

Static ReadonlyERROR_KEY

Static ReadonlyPAYLOAD_KEY

Static ReadonlyRECEIPTS_KEY

Static ReadonlyREQUIRED_KEY

Static ReadonlySTATUS_KEY

createPaymentRequiredTask

• createPaymentRequiredTask(
      task: Task,
      paymentRequired: X402PaymentRequired,
  ): Task

  Set a Task to the payment-required state (input-required) with the X402PaymentRequired object in x402.payment.required metadata.

  Mutates and returns task (in place), per the x402 v2 A2A transport.

  Parameters

  • task: Task
  • paymentRequired: X402PaymentRequired

  Returns Task

getPaymentPayload

• getPaymentPayload(task?: Task | null): Record<string, any> | undefined

  Extract the in-band PaymentPayload object from a Task's status message metadata.

  Parameters

  • Optionaltask: Task | null

  Returns Record<string, any> | undefined

getPaymentPayloadFromMessage

• getPaymentPayloadFromMessage(
      message?: Message | null,
  ): Record<string, any> | undefined

  Extract the in-band PaymentPayload object from a Message's metadata.

  The payload is untrusted client input that the server re-encodes into an access token, so this rejects null, arrays and oversized payloads (defense-in-depth, parity with the MCP readPaymentPayload).

  Parameters

  • Optionalmessage: Message | null

  Returns Record<string, any> | undefined

  The PaymentPayload object, or undefined when absent/invalid.

getPaymentRequirements

• getPaymentRequirements(task?: Task | null): X402PaymentRequired | undefined

  Extract the X402PaymentRequired object from a Task's status message metadata.

  Parameters

  • Optionaltask: Task | null

  Returns X402PaymentRequired | undefined

getPaymentRequirementsFromMessage

• getPaymentRequirementsFromMessage(
      message?: Message | null,
  ): X402PaymentRequired | undefined

  Extract the X402PaymentRequired object from a Message's metadata.

  Returns the raw object (already spec-shaped JSON). Returns undefined when absent or not a plain object.

  Parameters

  • Optionalmessage: Message | null

  Returns X402PaymentRequired | undefined

getPaymentStatus

• getPaymentStatus(task?: Task | null): string | undefined

  Extract the payment status from a Task's status message metadata, or undefined.

  Parameters

  • Optionaltask: Task | null

  Returns string | undefined

getPaymentStatusFromMessage

• getPaymentStatusFromMessage(message?: Message | null): string | undefined

  Extract the payment status from a Message's metadata, or undefined.

  Parameters

  • Optionalmessage: Message | null

  Returns string | undefined

recordPaymentDeferred

• recordPaymentDeferred(task: Task): Task

  Record a deferred (batch) settlement on a Task: the payload was verified but on-chain settlement is deferred out-of-band (the handler never confirms it). Sets payment-verified PLUS the Nevermined x402.payment.settlement: 'deferred' marker, so a client can tell it will be charged out-of-band — distinct from a plain verify where nothing is owed.

  Parameters

  • task: Task

  Returns Task

recordPaymentFailure

• recordPaymentFailure(
      task: Task,
      errorCode: string,
      errorResponse?: SettlePermissionsResult,
  ): Task

  Record a payment failure on a Task: x402.payment.status = payment-failed, the error code under x402.payment.error, and (when available) the failed SettleResponse under x402.payment.receipts.

  Parameters

  • task: Task
  • errorCode: string
  • OptionalerrorResponse: SettlePermissionsResult

  Returns Task

recordPaymentSuccess

• recordPaymentSuccess(task: Task, settleResponse?: SettlePermissionsResult): Task

  Record a successful settlement on a Task: sets the x402.payment.status metadata to payment-completed and stores the SettleResponse receipt under x402.payment.receipts (an array, per the spec).

  Parameters

  • task: Task
  • OptionalsettleResponse: SettlePermissionsResult

  Returns Task

recordPaymentVerified

• recordPaymentVerified(task: Task): Task

  Record payment verification on a Task: sets the x402.payment.status metadata to payment-verified. Task state is left to the caller (the spec keeps it working).

  Parameters

  • task: Task

  Returns Task