Interface B402PaymentsApiInterface

B402PaymentsApi - interface B402PaymentsApi

interface B402PaymentsApiInterface {
    getB402SupportedConfigurationsV1(
        requestParameters: GetB402SupportedConfigurationsV1Request,
    ): Promise<RestApiResponse<GetB402SupportedConfigurationsV1Response>>;
    getB402SupportedConfigurationsV2(
        requestParameters: GetB402SupportedConfigurationsV2Request,
    ): Promise<RestApiResponse<GetB402SupportedConfigurationsV2Response>>;
    settleB402PaymentV1(
        requestParameters: SettleB402PaymentV1Request,
    ): Promise<RestApiResponse<SettleB402PaymentV1Response>>;
    settleB402PaymentV2(
        requestParameters: SettleB402PaymentV2Request,
    ): Promise<RestApiResponse<SettleB402PaymentV2Response>>;
    verifyB402PaymentV1(
        requestParameters: VerifyB402PaymentV1Request,
    ): Promise<RestApiResponse<VerifyB402PaymentV1Response>>;
    verifyB402PaymentV2(
        requestParameters: VerifyB402PaymentV2Request,
    ): Promise<RestApiResponse<VerifyB402PaymentV2Response>>;
}

Implemented by

B402PaymentsApi

Index

Methods

getB402SupportedConfigurationsV1 getB402SupportedConfigurationsV2 settleB402PaymentV1 settleB402PaymentV2 verifyB402PaymentV1 verifyB402PaymentV2

Methods

getB402SupportedConfigurationsV1

getB402SupportedConfigurationsV1(
requestParameters: GetB402SupportedConfigurationsV1Request,
): Promise<RestApiResponse<GetB402SupportedConfigurationsV1Response>>
Legacy V1 compatibility endpoint. New integrations should use V2. V1 returns x402Version=1, method-specific facilitatorAddress, and V1 signer-map semantics.
Parameters
- requestParameters: GetB402SupportedConfigurationsV1Request
  Request parameters.
Returns Promise<RestApiResponse<GetB402SupportedConfigurationsV1Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:326

getB402SupportedConfigurationsV2

getB402SupportedConfigurationsV2(
requestParameters: GetB402SupportedConfigurationsV2Request,
): Promise<RestApiResponse<GetB402SupportedConfigurationsV2Response>>
Return the live x402 V2 payment kinds available to the authenticated Developer Portal project. Use the result to construct HTTP 402 payment requirements. Copy the selected extra object verbatim and refresh cached configuration periodically.
Parameters
- requestParameters: GetB402SupportedConfigurationsV2Request
  Request parameters.
Returns Promise<RestApiResponse<GetB402SupportedConfigurationsV2Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:338

settleB402PaymentV1

settleB402PaymentV1(
requestParameters: SettleB402PaymentV1Request,
): Promise<RestApiResponse<SettleB402PaymentV1Response>>
Legacy V1 on-chain settlement endpoint. New integrations should use V2. This operation can move real funds and is irreversible. V1 additionally returns confirmations in the settlement result.
Parameters
- requestParameters: SettleB402PaymentV1Request
  Request parameters.
Returns Promise<RestApiResponse<SettleB402PaymentV1Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:350

settleB402PaymentV2

settleB402PaymentV2(
requestParameters: SettleB402PaymentV2Request,
): Promise<RestApiResponse<SettleB402PaymentV2Response>>
Submit a verified x402 V2 authorization on-chain. This operation can move real funds and is irreversible. For permit2-upto, provide settleAmount in atomic units. Business failure is returned as HTTP 200 with data.success=false; reconcile any non-empty transaction hash before retrying.
Parameters
- requestParameters: SettleB402PaymentV2Request
  Request parameters.
Returns Promise<RestApiResponse<SettleB402PaymentV2Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:362

verifyB402PaymentV1

verifyB402PaymentV1(
requestParameters: VerifyB402PaymentV1Request,
): Promise<RestApiResponse<VerifyB402PaymentV1Response>>
Legacy V1 off-chain verification endpoint. New integrations should use V2. Portal identity is resolved from the API Key project, so merchantId is omitted from the external request.
Parameters
- requestParameters: VerifyB402PaymentV1Request
  Request parameters.
Returns Promise<RestApiResponse<VerifyB402PaymentV1Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:374

verifyB402PaymentV2

verifyB402PaymentV2(
requestParameters: VerifyB402PaymentV2Request,
): Promise<RestApiResponse<VerifyB402PaymentV2Response>>
Validate an x402 V2 payment authorization off-chain without spending funds or broadcasting a transaction. Portal identity is resolved from the authenticated API Key project; omit merchantId. A validation failure is returned as HTTP 200 with data.isValid=false.
Parameters
- requestParameters: VerifyB402PaymentV2Request
  Request parameters.
Returns Promise<RestApiResponse<VerifyB402PaymentV2Response>>

Throws

Memberof
B402PaymentsApiInterface
- Defined in clients/web3-wallet/src/rest-api/modules/b402-payments-api.ts:386

Interface B402PaymentsApiInterface

Implemented by

Index

Methods

Methods

getB402SupportedConfigurationsV1

Parameters

Returns Promise<RestApiResponse<GetB402SupportedConfigurationsV1Response>>

Throws

Memberof

getB402SupportedConfigurationsV2

Parameters

Returns Promise<RestApiResponse<GetB402SupportedConfigurationsV2Response>>

Throws

Memberof

settleB402PaymentV1

Parameters

Returns Promise<RestApiResponse<SettleB402PaymentV1Response>>

Throws

Memberof

settleB402PaymentV2

Parameters

Returns Promise<RestApiResponse<SettleB402PaymentV2Response>>

Throws

Memberof

verifyB402PaymentV1

Parameters

Returns Promise<RestApiResponse<VerifyB402PaymentV1Response>>

Throws

Memberof

verifyB402PaymentV2

Parameters

Returns Promise<RestApiResponse<VerifyB402PaymentV2Response>>

Throws

Memberof

Settings

On This Page