Struct SettleRequest 

pub struct SettleRequest(/* private fields */);

Wire-level settle request. Identical structure to VerifyRequest but distinguished at the type level to prevent accidental misuse.

Implementations

impl SettleRequest

pub fn into_json(self) -> Value

Consumes the request and returns the raw JSON.

pub fn scheme_slug(&self) -> Option<SchemeSlug>

Inspects the request for scheme routing purposes.

pub fn network(&self) -> &str

Returns the CAIP-2 network identifier from paymentRequirements.network.

pub fn set_settlement_amount( &mut self, amount: &str, ) -> Result<(), VerificationError>

Overrides paymentRequirements.amount in-place.

Intended for the upto scheme, where the resource server decides the actual settlement amount at request time (≤ the signed maximum). For the exact scheme this is a no-op: the amount must already equal what the buyer signed.

Errors

Returns VerificationError::InvalidFormat when the JSON does not have a paymentRequirements object.

Trait Implementations

impl Clone for SettleRequest

fn clone(&self) -> SettleRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettleRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SettleRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Value> for SettleRequest

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<VerifyRequest> for SettleRequest

fn from(request: VerifyRequest) -> Self

Converts to this type from the input type.

impl Serialize for SettleRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.