Enum SettleResponse 

#[non_exhaustive]
pub enum SettleResponse {
    Success {
        payer: CompactString,
        transaction: CompactString,
        network: CompactString,
        amount: Option<CompactString>,
        extensions: Extensions,
    },
    Failure {
        reason: ErrorReason,
        message: Option<CompactString>,
        payer: Option<CompactString>,
        network: CompactString,
        extensions: Extensions,
    },
}

Settlement outcome returned by a facilitator.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Success

Settlement succeeded.

Fields

payer: CompactString

The payer address on the target chain.

transaction: CompactString

On-chain transaction hash / signature.

network: CompactString

CAIP-2 chain identifier the transaction landed on.

amount: Option<CompactString>

Actual amount settled, in the token’s smallest unit.

Required when the upto scheme is in use; included for exact too to give clients unambiguous receipts.

extensions: Extensions

Facilitator-attached extension data.

Failure

Settlement failed.

Fields

reason: ErrorReason

Wire-level reason code.

message: Option<CompactString>

Optional human-readable message.

payer: Option<CompactString>

Optional payer address if identifiable.

network: CompactString

CAIP-2 chain identifier on which settlement was attempted.

extensions: Extensions

Facilitator-attached extension data.

Implementations

impl SettleResponse

pub const fn is_success(&self) -> bool

Returns true when the settlement succeeded.

pub fn encode_base64(&self) -> Option<Base64Bytes>

Encodes a successful settlement as base64 bytes for the Payment-Response HTTP header.

Returns None for Failure variants to avoid accidentally transmitting a failed settlement as if it were successful. Call Self::encode_base64_any when the failure body is needed on the wire (for example, when a paygate must inform a browser client of a failed settlement via the Payment-Response header).

pub fn encode_base64_any(&self) -> Option<Base64Bytes>

Encodes any SettleResponse (success or failure) as base64 bytes for the Payment-Response HTTP header.

Use this when surfacing failed settlements is required by the spec, e.g. paygate error paths that still want to communicate the machine-readable error reason and chain to a browser client. Prefer Self::encode_base64 when you only want to forward successful settlements.

pub fn from_facilitator_error( error: &FacilitatorError, network: impl Into<CompactString>, ) -> Self

Builds a Failure response from a FacilitatorError.

Trait Implementations

impl Clone for SettleResponse

fn clone(&self) -> SettleResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettleResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SettleResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SettleResponse

impl PartialEq for SettleResponse

fn eq(&self, other: &SettleResponse) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SettleResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SettleResponse