Enum ReceivePaymentMethod 

pub enum ReceivePaymentMethod {
    SparkAddress,
    SparkInvoice {
        amount: Option<u128>,
        token_identifier: Option<String>,
        expiry_time: Option<u64>,
        description: Option<String>,
        sender_public_key: Option<String>,
    },
    BitcoinAddress {
        new_address: Option<bool>,
    },
    Bolt11Invoice {
        description: String,
        amount_sats: Option<u64>,
        expiry_secs: Option<u32>,
        payment_hash: Option<String>,
        receiver_identity_public_key: Option<String>,
    },
    CrossChain {
        route: CrossChainRoutePair,
        amount: u128,
        destination: Option<SparkAsset>,
        fee_mode: Option<CrossChainFeeMode>,
        max_slippage_bps: Option<u32>,
        target_overpay_bps: Option<u32>,
    },
}

Variants

SparkAddress

SparkInvoice

Fields

amount: Option<u128>

Amount to receive. Denominated in sats if token identifier is empty, otherwise in the token base units

token_identifier: Option<String>

The presence of this field indicates that the payment is for a token If empty, it is a Bitcoin payment

expiry_time: Option<u64>

The expiry time of the invoice as a unix timestamp in seconds

description: Option<String>

A description to embed in the invoice.

sender_public_key: Option<String>

If set, the invoice may only be fulfilled by a payer with this public key

BitcoinAddress

Fields

new_address: Option<bool>

If true, rotate to a new deposit address. Previous ones remain valid. If false or absent, return the existing address (creating one if none exists yet).

Bolt11Invoice

Fields

description: String

amount_sats: Option<u64>

expiry_secs: Option<u32>

The expiry of the invoice as a duration in seconds

payment_hash: Option<String>

If set, creates a HODL invoice with this payment hash (hex-encoded). The payer’s HTLC will be held until the preimage is provided via claim_htlc_payment or the HTLC expires.

receiver_identity_public_key: Option<String>

Spark identity public key that will receive the payment. If absent, the connected wallet’s identity public key is used.

CrossChain

Fields

route: CrossChainRoutePair

The selected cross-chain route in the receive direction.

amount: u128

The amount, in the source asset’s base units (route.decimals). USD-stable sources are at parity, so 1 USD = 10^route.decimals (e.g. 1_000_000 for 6-decimal USDC/USDT, 10^18 for 18-decimal BSC USDC).

• FeesExcluded (default): what the receiver ends up with, sized as if amount source units were converted to the Spark-side destination at parity (USDB) or the live BTC/USD rate (Bitcoin).
• FeesIncluded: what the sender deposits. The receiver ends up with that amount minus provider fees.

destination: Option<SparkAsset>

Spark-side asset the receiver wants delivered. When absent, the SDK auto-selects: the wallet’s active stable-balance token if the route supports it, otherwise Bitcoin (sats). When set, the value must appear in the route’s accepted_assets.

fee_mode: Option<CrossChainFeeMode>

How amount should be interpreted. When absent, defaults to FeesExcluded.

max_slippage_bps: Option<u32>

Maximum slippage in basis points. When absent, the SDK default (100 bps) is used.

target_overpay_bps: Option<u32>

Per-request override for the overpay buffer applied to the sender’s deposit when fee_mode == FeesExcluded. Range 0 to 500. When absent, falls back to CrossChainConfig::default_target_overpay_bps then the built-in default (15 bps). Ignored when fee_mode is FeesIncluded.

Trait Implementations

impl Clone for ReceivePaymentMethod

fn clone(&self) -> ReceivePaymentMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceivePaymentMethod

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

Formats the value using the given formatter.

impl Serialize for ReceivePaymentMethod

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

where __S: Serializer,

Serialize this value into the given Serde serializer.