payrail 0.1.1

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

use crate::{IdempotencyKey, Money, PaymentProvider, PaymentStatus, ProviderReference};

/// Refund request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RefundRequest {
    /// Provider to route the refund to.
    pub provider: PaymentProvider,
    /// Provider payment reference.
    pub provider_reference: ProviderReference,
    /// Required idempotency key for retry-safe refund creation.
    pub idempotency_key: IdempotencyKey,
    /// Optional partial refund amount.
    pub amount: Option<Money>,
    /// Optional reason.
    pub reason: Option<String>,
}

/// Capture request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CaptureRequest {
    /// Provider to route the capture to.
    pub provider: PaymentProvider,
    /// Provider payment reference.
    pub provider_reference: ProviderReference,
    /// Required idempotency key for retry-safe capture.
    pub idempotency_key: IdempotencyKey,
}

/// Refund response.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RefundResponse {
    /// Provider handling the refund.
    pub provider: PaymentProvider,
    /// Provider refund reference.
    pub provider_reference: ProviderReference,
    /// Normalized status after refund.
    pub status: PaymentStatus,
}

/// Capture response.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CaptureResponse {
    /// Provider handling the capture.
    pub provider: PaymentProvider,
    /// Provider payment reference.
    pub provider_reference: ProviderReference,
    /// Normalized status after capture.
    pub status: PaymentStatus,
}

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

    #[test]
    fn write_requests_carry_idempotency_keys() {
        let key = IdempotencyKey::new("ORDER-1:refund").expect("key should be valid");
        let refund = RefundRequest {
            provider: PaymentProvider::Stripe,
            provider_reference: ProviderReference::new("pi_123")
                .expect("reference should be valid"),
            idempotency_key: key.clone(),
            amount: None,
            reason: None,
        };
        let capture = CaptureRequest {
            provider: PaymentProvider::PayPal,
            provider_reference: ProviderReference::new("ORDER-1")
                .expect("reference should be valid"),
            idempotency_key: IdempotencyKey::new("ORDER-1:capture").expect("key should be valid"),
        };

        assert_eq!(refund.idempotency_key, key);
        assert_eq!(capture.provider, PaymentProvider::PayPal);
    }
}