Struct PaymentClient 

pub struct PaymentClient<S = FirstMatch> { /* private fields */ }

Buyer payment client.

Implementations

impl<S: PaymentSelector> PaymentClient<S>

pub async fn extension_headers( &self, payment_required: &PaymentRequired, request_url: &str, ) -> HeaderMap

Merges ClientExtension::on_payment_required headers for advertised keys.

request_url is the 402 response URL after redirects. Unadvertised keys are skipped (official HTTP client only invokes a transport hook when extension.key is in paymentRequired.extensions).

impl<S: PaymentSelector> PaymentClient<S>

pub async fn handle_payment_response( &self, ctx: &PaymentResponseContext, ) -> PaymentResponseResult

Dispatches ClientHooks::on_payment_response for every hook.

First recovered: true wins; remaining hooks still run.

impl PaymentClient<FirstMatch>

pub fn new() -> Self

Empty client with FirstMatch selection and default $1 spend controls.

impl<S> PaymentClient<S>

pub fn register(self, scheme: impl SchemeClient + 'static) -> Self

Registers a scheme client.

pub fn with_selector<P: PaymentSelector>(self, selector: P) -> PaymentClient<P>

Replaces the payment selector.

pub fn with_spend_controls(self, controls: SpendControls) -> Self

Enables spend controls with the given configuration.

pub fn disable_spend_controls(self) -> Self

Disables all spend controls (any asset, no caps).

pub fn with_policy(self, policy: impl PaymentPolicy + 'static) -> Self

Appends a payment policy (applied in registration order).

pub fn with_hook(self, hook: impl ClientHooks + 'static) -> Self

Registers a client lifecycle hook.

pub fn with_extension(self, extension: impl ClientExtension + 'static) -> Self

Registers a client extension (enrich and/or HTTP 402 header hook).

pub fn scheme_count(&self) -> usize

Number of registered scheme clients.

pub fn hook_count(&self) -> usize

Number of registered hooks.

pub fn extension_count(&self) -> usize

Number of registered client extensions.

impl<S: PaymentSelector> PaymentClient<S>

pub async fn create_payment( &self, payment_required: &PaymentRequired, ) -> Result<CreatedPayment, ClientError>

Creates a signed payment payload for a 402 challenge.

Errors

Propagates selection, signing, and before-hook abort errors.

impl<S: PaymentSelector> PaymentClient<S>

pub fn candidates( &self, payment_required: &PaymentRequired, ) -> Vec<PaymentCandidate>

Collects candidates from every registered scheme client.

pub fn select_candidate<'a>( &self, candidates: &'a [PaymentCandidate], ) -> Result<&'a PaymentCandidate, ClientError>

Applies spend controls, policies, and the selector.

Errors

Returns ClientError::NoMatchingPaymentOption when nothing remains, ClientError::UnrecognizedPaymentFlow when every candidate has an unknown extra.paymentFlow, or ClientError::SpendControls when spend controls reject every option.

Trait Implementations

impl<S> Debug for PaymentClient<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PaymentClient<FirstMatch>

fn default() -> Self

Returns the “default value” for a type.