Struct PaymentRequired 

#[non_exhaustive]
pub struct PaymentRequired {
    pub x402_version: Version2,
    pub error: Option<CompactString>,
    pub resource: ResourceInfo,
    pub accepts: Vec<PaymentRequirements>,
    pub extensions: Extensions,
}

Body of an HTTP 402 “Payment Required” response.

Contains:

• the x402 version marker,
• an optional human-readable error string for malformed clients,
• resource metadata,
• the list of PaymentRequirements the seller will accept, and
• an optional extensions block.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

x402_version: Version2

Protocol version (always 2).

error: Option<CompactString>

Optional error message describing why the request was rejected.

resource: ResourceInfo

Resource metadata.

accepts: Vec<PaymentRequirements>

Accepted payment terms.

extensions: Extensions

Optional extension block.

Implementations

impl PaymentRequired

pub fn new(resource: ResourceInfo) -> Self

Constructs a 402 body with the resource block and an empty accepts list. Use Self::with_accepts to attach payment requirements and Self::with_error to surface a diagnostic message to malformed clients.

pub fn with_accepts(self, accepts: Vec<PaymentRequirements>) -> Self

Builder: replaces the accepted payment requirements list.

pub fn add_accept(self, accept: PaymentRequirements) -> Self

Builder: appends a single payment requirement to the accepts list.

pub fn with_error(self, error: impl Into<CompactString>) -> Self

Builder: attaches a human-readable error message describing why the request was rejected (e.g. "missing X-PAYMENT header").

pub fn with_extensions(self, extensions: Extensions) -> Self

Builder: replaces the extensions block.

Trait Implementations

impl Clone for PaymentRequired

fn clone(&self) -> PaymentRequired

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PaymentRequired

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentRequired

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PaymentRequired

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.