Enum Error 

#[non_exhaustive]
pub enum Error {
    Http {
        provider: &'static str,
        source: Error,
    },
    Gateway {
        provider: &'static str,
        code: i64,
        message: String,
    },
    AmountMismatch {
        expected: Amount,
        actual: Amount,
    },
    Config(String),
    Unsupported {
        provider: &'static str,
        operation: &'static str,
    },
    Decode {
        provider: &'static str,
        message: String,
    },
}

Errors returned by gateway drivers.

Variants fall into three families:

1. Transport — Error::Http wraps every reqwest failure (connection refused, TLS handshake, timeout, malformed response, …).
2. Gateway — Error::Gateway is returned when a provider’s API accepts the request but reports a business failure (insufficient funds, expired authority, blocked merchant, etc.). The contained code is the raw provider code; check provider docs to interpret.
3. Local — Error::Config, Error::AmountMismatch, Error::Unsupported are produced inside the SDK before/after the HTTP roundtrip.

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.

Http

HTTP transport / serialisation failure.

Fields

provider: &'static str

Driver name ("zarinpal", "idpay", …).

source: Error

Underlying reqwest error.

Gateway

Gateway returned a business-level error.

code is the provider’s native error code; consult the provider’s documentation to interpret it. message is the human-readable message (often Persian).

Fields

provider: &'static str

Driver name.

code: i64

Provider-specific numeric error code.

message: String

Provider’s human-readable message.

AmountMismatch

Verification was attempted with an amount that doesn’t match what was originally charged. Almost always indicates someone tampered with the callback query string.

Fields

expected: Amount

What the merchant expected.

actual: Amount

What the gateway reported during verification.

Config(String)

Configuration is invalid (missing merchant ID, malformed URL, etc.).

Unsupported

The provider does not support this operation (e.g. refunds via Pay.ir require a separate API contract).

Fields

provider: &'static str

Driver name.

operation: &'static str

The unsupported operation.

Decode

Response decoding failed — the provider returned a payload we couldn’t match to the expected schema. Usually means the SDK is out of date relative to the provider’s API.

Fields

provider: &'static str

Driver name.

message: String

Description of what went wrong.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.