Enum SettleResponse 

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

Settlement outcome returned by a facilitator.

extension_responses is the EXTENSION-RESPONSES sidechannel. It is not serialized into JSON and is never merged into extensions.

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: Option<CompactString>

Payer address on the target chain, if the facilitator included it.

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.

extensions: Extensions

Facilitator-attached extension data (JSON body).

extension_responses: Extensions

Facilitator EXTENSION-RESPONSES sidechannel. Not buyer wire.

extra: Option<Value>

Scheme-specific additional 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.

transaction: CompactString

Broadcast transaction hash. Empty when no transaction was submitted. Spec §9: MUST be non-empty when reason is ErrorReason::SettlementPending.

network: CompactString

CAIP-2 chain identifier on which settlement was attempted.

extensions: Extensions

Facilitator-attached extension data (JSON body).

extension_responses: Extensions

Facilitator EXTENSION-RESPONSES sidechannel. Not buyer wire.

extra: Option<Value>

Scheme-specific additional data.

Implementations

impl SettleResponse

pub const fn is_success(&self) -> bool

Whether settlement succeeded.

pub const fn extension_responses(&self) -> &Extensions

Sidechannel map (empty when the header was absent).

pub const fn extensions_mut(&mut self) -> &mut Extensions

Buyer-wire extensions map.

pub fn set_extension_responses(&mut self, responses: Extensions)

Replaces the sidechannel map.

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

Encodes a successful settlement as base64 for Payment-Response.

Returns None for Failure. Use Self::encode_base64_any when the failure body must go on the wire.

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

Encodes any SettleResponse as base64 for Payment-Response.

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

Builds a Failure response from a FacilitatorError.

The caller supplies transaction ("" when no broadcast hash is known). Returns None for FacilitatorError::Transport: that is HTTP 502, not a 402 body.

pub fn is_retryable_settlement_pending(&self) -> bool

success: false, errorReason == settlement_pending, and a non-empty hash.

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