Interface IFacilitatorClient

Facilitator client interface Spec compliance: x402 v2 - Facilitator API

interface IFacilitatorClient {
    settle(
        payload: PaymentPayload,
        requirements: PaymentRequirements,
    ): Promise<SettleResponse>;
    supported(): Promise<SupportedResponse>;
    verify(
        payload: PaymentPayload,
        requirements: PaymentRequirements,
    ): Promise<VerifyResponse>;
}

Implemented by

Index

Methods

settle supported verify

Methods

settle

settle(
payload: PaymentPayload,
requirements: PaymentRequirements,
): Promise<SettleResponse>
Settle a verified payment
Parameters
- payload: PaymentPayload
  Payment payload from client
- requirements: PaymentRequirements
  Payment requirements from server
Returns Promise<SettleResponse>
Settlement response
- Defined in facilitator/client.ts:53

supported

supported(): Promise<SupportedResponse>
Get supported payment kinds

Returns Promise<SupportedResponse>
Supported payment kinds, extensions, and signers
- Defined in facilitator/client.ts:62

verify

verify(
payload: PaymentPayload,
requirements: PaymentRequirements,
): Promise<VerifyResponse>
Verify a payment payload against requirements
Parameters
- payload: PaymentPayload
  Payment payload from client
- requirements: PaymentRequirements
  Payment requirements from server
Returns Promise<VerifyResponse>
Verification response
- Defined in facilitator/client.ts:42