Class A2APaymentServer

A2A Payment Server

Provides server-side payment handling for A2A agent endpoints.

Example

const server = new A2APaymentServer({
  facilitator: facilitatorClient,
  defaultRequirements: {
    t402Version: 2,
    resource: 'agent://my-agent/skill',
  },
});

// Create payment-required response
const requirements = server.createRequirements({
  accepts: [{ scheme: 'exact', network: 'eip155:8453', amount: '1000000', ... }],
});
const task = server.createPaymentRequiredTask(taskId, requirements);

// Process payment submission
const result = await server.processPayment(message, requirements);
if (result.success) {
  // Continue with task execution
}

Index

Constructors

constructor

Methods

createRequirements createPaymentRequiredStatus createPaymentRequiredTask extractPaymentPayload hasPaymentPayload processPayment createPaymentCompletedStatus createPaymentFailedStatus updateTaskWithPaymentResult handlePayment createEmbeddedPaymentRequiredTask extractEmbeddedPayload

Constructors

constructor

new A2APaymentServer(options?: A2APaymentServerOptions): A2APaymentServer
Parameters
- options: A2APaymentServerOptions = {}
Returns A2APaymentServer
- Defined in a2a/src/server.ts:125

Methods

createRequirements

createRequirements(requirements: PaymentRequired): PaymentRequired
Create payment requirements with defaults
Parameters
- requirements: PaymentRequired
  Partial requirements to merge with defaults
Returns PaymentRequired
Complete payment requirements
- Defined in a2a/src/server.ts:135

createPaymentRequiredStatus

createPaymentRequiredStatus(
requirements: PaymentRequired,
text?: string,
): A2ATaskStatus
Create a payment-required task status
Parameters
- requirements: PaymentRequired
  Payment requirements
- Optionaltext: string
  Optional text message
Returns A2ATaskStatus
A2A task status
- Defined in a2a/src/server.ts:150

createPaymentRequiredTask

createPaymentRequiredTask(
    taskId: string,
    requirements: PaymentRequired,
    text?: string,
): A2ATask
Create a payment-required task
Parameters
- taskId: string
  Task identifier
- requirements: PaymentRequired
  Payment requirements
- Optionaltext: string
  Optional text message
Returns A2ATask
A2A task in input-required state
- Defined in a2a/src/server.ts:169

extractPaymentPayload

extractPaymentPayload(message: A2AMessage): any
Extract payment payload from an A2A message
Parameters
- message: A2AMessage
  A2A message that may contain payment
Returns any
Payment payload or undefined
- Defined in a2a/src/server.ts:187

hasPaymentPayload

hasPaymentPayload(message: A2AMessage): boolean
Check if a message contains a payment submission
Parameters
- message: A2AMessage
  A2A message to check
Returns boolean
Whether the message contains a payment
- Defined in a2a/src/server.ts:198

processPayment

processPayment(
message: A2AMessage,
requirements: PaymentRequired,
): Promise<A2APaymentResult>
Process a payment submission
Parameters
- message: A2AMessage
  A2A message containing payment payload
- requirements: PaymentRequired
  Original payment requirements
Returns Promise<A2APaymentResult>
Payment processing result
- Defined in a2a/src/server.ts:215

createPaymentCompletedStatus

createPaymentCompletedStatus(
receipts: SettleResponse[],
text?: string,
): A2ATaskStatus
Create a completed task status with payment receipts
Parameters
- receipts: SettleResponse[]
  Settlement receipts
- Optionaltext: string
  Optional text message
Returns A2ATaskStatus
A2A task status
- Defined in a2a/src/server.ts:315

createPaymentFailedStatus

createPaymentFailedStatus(
    error: string,
    receipts?: SettleResponse[],
    errorCode?: string,
): A2ATaskStatus
Create a failed task status with payment error
Parameters
- error: string
  Error message
- receipts: SettleResponse[] = []
  Optional settlement receipts
- errorCode: string = "T402-5000"
  Optional error code
Returns A2ATaskStatus
A2A task status
- Defined in a2a/src/server.ts:334

updateTaskWithPaymentResult

updateTaskWithPaymentResult(task: A2ATask, result: A2APaymentResult): A2ATask
Update a task with payment completion
Parameters
- task: A2ATask
  Original task
- result: A2APaymentResult
  Payment processing result
Returns A2ATask
Updated task
- Defined in a2a/src/server.ts:353

handlePayment

handlePayment(
    task: A2ATask,
    message: A2AMessage,
    requirements: PaymentRequired,
): Promise<A2ATask>
Handle a complete payment flow for a task

This is a convenience method that processes a payment submission and returns an updated task.
Parameters
- task: A2ATask
  The current A2A task
- message: A2AMessage
  The message containing payment payload
- requirements: PaymentRequired
  Payment requirements
Returns Promise<A2ATask>
Updated task with payment result
- Defined in a2a/src/server.ts:380

createEmbeddedPaymentRequiredTask

createEmbeddedPaymentRequiredTask(
    taskId: string,
    cartContents: CartContents,
    requirements: PaymentRequirements[],
    merchantAuthorization?: string,
    text?: string,
): A2ATask
Create a payment-required task using the AP2 embedded flow. Returns a CartMandate as artifact instead of metadata.
Parameters
- taskId: string
  Task identifier
- cartContents: CartContents
  Cart contents (payment_request will be augmented with x402)
- requirements: PaymentRequirements[]
  x402 payment requirements to embed
- OptionalmerchantAuthorization: string
  Optional merchant JWT
- Optionaltext: string
  Optional text message
Returns A2ATask
A2A task with CartMandate artifact and embedded flow metadata
- Defined in a2a/src/server.ts:400

extractEmbeddedPayload

extractEmbeddedPayload(message: A2AMessage): any
Extract x402 PaymentPayload from an embedded-flow message. Scans message parts for PaymentMandate DataPart.
Parameters
- message: A2AMessage
  A2A message with PaymentMandate DataPart
Returns any
x402 PaymentPayload or undefined
- Defined in a2a/src/server.ts:447

Class A2APaymentServer

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns A2APaymentServer

Methods

createRequirements

Parameters

Returns PaymentRequired

createPaymentRequiredStatus

Parameters

Returns A2ATaskStatus

createPaymentRequiredTask

Parameters

Returns A2ATask

extractPaymentPayload

Parameters

Returns any

hasPaymentPayload

Parameters

Returns boolean

processPayment

Parameters

Returns Promise<A2APaymentResult>

createPaymentCompletedStatus

Parameters

Returns A2ATaskStatus

createPaymentFailedStatus

Parameters

Returns A2ATaskStatus

updateTaskWithPaymentResult

Parameters

Returns A2ATask

handlePayment

Parameters

Returns Promise<A2ATask>

createEmbeddedPaymentRequiredTask

Parameters

Returns A2ATask

extractEmbeddedPayload

Parameters

Returns any

Settings

On This Page