payrail 0.1.5

Provider-neutral Rust payments facade for Stripe, PayPal, and Mobile Money
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use crate::{CountryCode, CurrencyCode, PaymentProvider};

/// Redacted provider error details safe to expose to application code.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProviderErrorDetails {
    /// Provider that returned the error.
    pub provider: PaymentProvider,
    /// HTTP status code.
    pub status: u16,
    /// Safe provider error code.
    pub code: Option<String>,
    /// Safe provider request ID.
    pub request_id: Option<String>,
    /// Redacted message.
    pub message: String,
}

/// `PayRail` error type.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum PaymentError {
    /// Invalid positive amount.
    #[error("invalid amount: {0}")]
    InvalidAmount(i64),

    /// Invalid currency code.
    #[error("invalid currency code: {0}")]
    InvalidCurrencyCode(String),

    /// Invalid country code.
    #[error("invalid country code: {0}")]
    InvalidCountryCode(String),

    /// Invalid reference.
    #[error("invalid reference: {0}")]
    InvalidReference(String),

    /// Invalid idempotency key.
    #[error("invalid idempotency key: {0}")]
    InvalidIdempotencyKey(String),

    /// Invalid phone number.
    #[error("invalid phone number")]
    InvalidPhoneNumber(String),

    /// Invalid URL.
    #[error("invalid url: {0}")]
    InvalidUrl(String),

    /// A required field was missing.
    #[error("missing required field: {0}")]
    MissingRequiredField(&'static str),

    /// Invalid configuration.
    #[error("invalid configuration: {0}")]
    InvalidConfiguration(String),

    /// Connector is not configured.
    #[error("connector not configured: {provider:?}")]
    ConnectorNotConfigured { provider: PaymentProvider },

    /// Unsupported payment method.
    #[error("unsupported payment method: {0}")]
    UnsupportedPaymentMethod(String),

    /// Unsupported country.
    #[error("unsupported country: {0:?}")]
    UnsupportedCountry(CountryCode),

    /// Unsupported currency.
    #[error("unsupported currency: {0:?}")]
    UnsupportedCurrency(CurrencyCode),

    /// Unsupported route.
    #[error("unsupported payment route: method={method}, country={country:?}")]
    UnsupportedPaymentRoute {
        /// Method description.
        method: String,
        /// Optional country.
        country: Option<CountryCode>,
    },

    /// Provider authentication failed.
    #[error("provider authentication failed")]
    AuthenticationFailed,

    /// Provider request failed.
    #[error("provider request failed: {provider:?}, status={status}, message={message}")]
    ProviderRequestFailed {
        /// Provider.
        provider: PaymentProvider,
        /// HTTP status.
        status: u16,
        /// Redacted message.
        message: String,
    },

    /// Redacted provider details.
    #[error("provider request failed: {details:?}")]
    ProviderDetails {
        /// Details.
        details: ProviderErrorDetails,
    },

    /// Provider unavailable.
    #[error("provider unavailable: {0:?}")]
    ProviderUnavailable(PaymentProvider),

    /// Provider rate limited.
    #[error("rate limited by provider: {0:?}")]
    RateLimited(PaymentProvider),

    /// Webhook verification failed.
    #[error("webhook verification failed")]
    WebhookVerificationFailed,

    /// Invalid webhook payload.
    #[error("webhook payload invalid: {0}")]
    InvalidWebhookPayload(String),

    /// Unsupported operation.
    #[error("operation not supported: {0}")]
    UnsupportedOperation(String),

    /// HTTP error.
    #[error("http error: {0}")]
    Http(#[from] reqwest::Error),

    /// JSON error.
    #[error("json error: {0}")]
    Json(#[from] serde_json::Error),
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn invalid_phone_error_does_not_display_value() {
        let error = PaymentError::InvalidPhoneNumber("+260971234567".to_owned());

        assert_eq!(error.to_string(), "invalid phone number");
    }
}