Struct PaymentRequirements 

pub struct PaymentRequirements {
    pub scheme: String,
    pub network: String,
    pub max_amount_required: String,
    pub asset: String,
    pub pay_to: String,
    pub resource: String,
    pub description: String,
    pub mime_type: Option<String>,
    pub output_schema: Option<Value>,
    pub max_timeout_seconds: u32,
    pub extra: Option<Value>,
}

Payment requirements for a resource

Fields

scheme: String

Payment scheme identifier (e.g., “exact”)

network: String

Blockchain network identifier (e.g., “base-sepolia”, “ethereum-mainnet”)

max_amount_required: String

Required payment amount in atomic token units

asset: String

Token contract address

pay_to: String

Recipient wallet address for the payment

resource: String

URL of the protected resource

description: String

Human-readable description of the resource

mime_type: Option<String>

MIME type of the expected response

output_schema: Option<Value>

JSON schema describing the response format

max_timeout_seconds: u32

Maximum time allowed for payment completion in seconds

extra: Option<Value>

Scheme-specific additional information

Implementations

impl PaymentRequirements

pub fn new( scheme: impl Into<String>, network: impl Into<String>, max_amount_required: impl Into<String>, asset: impl Into<String>, pay_to: impl Into<String>, resource: impl Into<String>, description: impl Into<String>, ) -> Self

Create a new payment requirements instance

pub fn set_usdc_info(&mut self, network: Network) -> Result<()>

Set USDC token information in the extra field

pub fn amount_as_decimal(&self) -> Result<Decimal>

Get the amount as a decimal

pub fn amount_in_decimal_units(&self, decimals: u8) -> Result<Decimal>

Get the amount in decimal units (e.g., 0.01 for 1 cent)

Trait Implementations

impl Clone for PaymentRequirements

fn clone(&self) -> PaymentRequirements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentRequirements

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentRequirements

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PaymentRequirements

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

where __S: Serializer,

Serialize this value into the given Serde serializer.