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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use std::collections::BTreeMap;

use url::Url;
use uuid::Uuid;

use crate::{
    CheckoutUiMode, Customer, IdempotencyKey, MerchantReference, Money, NextAction, PaymentError,
    PaymentId, PaymentMethod, PaymentProvider, PaymentStatus, ProviderReference,
};

/// Request metadata.
pub type Metadata = BTreeMap<String, String>;

/// Request to create a payment.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CreatePaymentRequest {
    amount: Money,
    reference: MerchantReference,
    description: Option<String>,
    customer: Option<Customer>,
    payment_method: PaymentMethod,
    callback_url: Option<Url>,
    return_url: Option<Url>,
    cancel_url: Option<Url>,
    checkout_ui_mode: CheckoutUiMode,
    idempotency_key: Option<IdempotencyKey>,
    metadata: Metadata,
}

impl CreatePaymentRequest {
    /// Starts a create payment request builder.
    #[inline]
    pub fn builder() -> CreatePaymentRequestBuilder {
        CreatePaymentRequestBuilder::default()
    }

    /// Returns the amount.
    #[inline]
    #[must_use]
    pub const fn amount(&self) -> &Money {
        &self.amount
    }

    /// Returns the merchant reference.
    #[inline]
    #[must_use]
    pub const fn reference(&self) -> &MerchantReference {
        &self.reference
    }

    /// Returns the description.
    #[inline]
    #[must_use]
    pub fn description(&self) -> Option<&str> {
        self.description.as_deref()
    }

    /// Returns the customer.
    #[inline]
    #[must_use]
    pub const fn customer(&self) -> Option<&Customer> {
        self.customer.as_ref()
    }

    /// Returns the payment method.
    #[inline]
    #[must_use]
    pub const fn payment_method(&self) -> &PaymentMethod {
        &self.payment_method
    }

    /// Returns the callback URL.
    #[inline]
    #[must_use]
    pub const fn callback_url(&self) -> Option<&Url> {
        self.callback_url.as_ref()
    }

    /// Returns the return URL.
    #[inline]
    #[must_use]
    pub const fn return_url(&self) -> Option<&Url> {
        self.return_url.as_ref()
    }

    /// Returns the cancel URL.
    #[inline]
    #[must_use]
    pub const fn cancel_url(&self) -> Option<&Url> {
        self.cancel_url.as_ref()
    }

    /// Returns the checkout UI mode.
    #[inline]
    #[must_use]
    pub const fn checkout_ui_mode(&self) -> CheckoutUiMode {
        self.checkout_ui_mode
    }

    /// Returns the idempotency key.
    #[inline]
    #[must_use]
    pub const fn idempotency_key(&self) -> Option<&IdempotencyKey> {
        self.idempotency_key.as_ref()
    }

    /// Returns metadata.
    #[inline]
    #[must_use]
    pub const fn metadata(&self) -> &Metadata {
        &self.metadata
    }

    #[cfg(any(feature = "lipila", feature = "paypal", feature = "stripe"))]
    pub(crate) fn into_reference(self) -> MerchantReference {
        self.reference
    }
}

/// Builder for [`CreatePaymentRequest`].
#[derive(Debug, Default, Clone)]
#[must_use]
pub struct CreatePaymentRequestBuilder {
    amount: Option<Money>,
    reference: Option<MerchantReference>,
    description: Option<String>,
    customer: Option<Customer>,
    payment_method: Option<PaymentMethod>,
    callback_url: Option<Url>,
    return_url: Option<Url>,
    cancel_url: Option<Url>,
    checkout_ui_mode: CheckoutUiMode,
    idempotency_key: Option<IdempotencyKey>,
    metadata: Metadata,
}

impl CreatePaymentRequestBuilder {
    /// Sets the amount.
    pub fn amount(mut self, amount: Money) -> Self {
        self.amount = Some(amount);
        self
    }

    /// Sets the merchant reference.
    ///
    /// # Errors
    ///
    /// Returns an error when the reference is invalid.
    pub fn reference(mut self, reference: impl AsRef<str>) -> Result<Self, PaymentError> {
        self.reference = Some(MerchantReference::new(reference)?);
        Ok(self)
    }

    /// Sets the description.
    pub fn description(mut self, description: impl Into<String>) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Sets the customer.
    pub fn customer(mut self, customer: Customer) -> Self {
        self.customer = Some(customer);
        self
    }

    /// Sets the payment method.
    pub fn payment_method(mut self, payment_method: PaymentMethod) -> Self {
        self.payment_method = Some(payment_method);
        self
    }

    /// Sets the callback URL.
    ///
    /// # Errors
    ///
    /// Returns an error when the URL is invalid.
    pub fn callback_url(mut self, url: impl AsRef<str>) -> Result<Self, PaymentError> {
        self.callback_url = Some(parse_url(url.as_ref())?);
        Ok(self)
    }

    /// Sets the return URL.
    ///
    /// # Errors
    ///
    /// Returns an error when the URL is invalid.
    pub fn return_url(mut self, url: impl AsRef<str>) -> Result<Self, PaymentError> {
        self.return_url = Some(parse_url(url.as_ref())?);
        Ok(self)
    }

    /// Sets the cancel URL.
    ///
    /// # Errors
    ///
    /// Returns an error when the URL is invalid.
    pub fn cancel_url(mut self, url: impl AsRef<str>) -> Result<Self, PaymentError> {
        self.cancel_url = Some(parse_url(url.as_ref())?);
        Ok(self)
    }

    /// Sets the checkout UI mode.
    pub const fn checkout_ui_mode(mut self, checkout_ui_mode: CheckoutUiMode) -> Self {
        self.checkout_ui_mode = checkout_ui_mode;
        self
    }

    /// Sets the idempotency key.
    ///
    /// # Errors
    ///
    /// Returns an error when the key is invalid.
    pub fn idempotency_key(mut self, key: impl AsRef<str>) -> Result<Self, PaymentError> {
        self.idempotency_key = Some(IdempotencyKey::new(key)?);
        Ok(self)
    }

    /// Adds one metadata entry.
    pub fn metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.metadata.insert(key.into(), value.into());
        self
    }

    /// Builds the request.
    ///
    /// # Errors
    ///
    /// Returns an error when a required field is missing.
    pub fn build(self) -> Result<CreatePaymentRequest, PaymentError> {
        Ok(CreatePaymentRequest {
            amount: self
                .amount
                .ok_or(PaymentError::MissingRequiredField("amount"))?,
            reference: self
                .reference
                .ok_or(PaymentError::MissingRequiredField("reference"))?,
            description: self.description,
            customer: self.customer,
            payment_method: self
                .payment_method
                .ok_or(PaymentError::MissingRequiredField("payment_method"))?,
            callback_url: self.callback_url,
            return_url: self.return_url,
            cancel_url: self.cancel_url,
            checkout_ui_mode: self.checkout_ui_mode,
            idempotency_key: self.idempotency_key,
            metadata: self.metadata,
        })
    }
}

fn parse_url(value: &str) -> Result<Url, PaymentError> {
    Url::parse(value).map_err(|error| PaymentError::InvalidUrl(error.to_string()))
}

/// Normalized payment creation response.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PaymentSession {
    /// `PayRail` payment ID.
    pub payment_id: PaymentId,
    /// Provider handling the payment.
    pub provider: PaymentProvider,
    /// Provider reference.
    pub provider_reference: ProviderReference,
    /// Merchant reference.
    pub merchant_reference: MerchantReference,
    /// Normalized status.
    pub status: PaymentStatus,
    /// Next required action.
    pub next_action: Option<NextAction>,
}

impl PaymentSession {
    /// Creates a normalized session with a generated `PayRail` payment ID.
    ///
    /// # Errors
    ///
    /// Returns an error if generated ID validation fails.
    pub fn new(
        provider: PaymentProvider,
        provider_reference: ProviderReference,
        merchant_reference: MerchantReference,
        status: PaymentStatus,
        next_action: Option<NextAction>,
    ) -> Result<Self, PaymentError> {
        Ok(Self {
            payment_id: PaymentId::new(format!("pay_{}", Uuid::new_v4()))?,
            provider,
            provider_reference,
            merchant_reference,
            status,
            next_action,
        })
    }

    /// Returns the `PayRail` payment ID.
    #[inline]
    #[must_use]
    pub const fn payment_id(&self) -> &PaymentId {
        &self.payment_id
    }

    /// Returns the provider handling the payment.
    #[inline]
    #[must_use]
    pub const fn provider(&self) -> &PaymentProvider {
        &self.provider
    }

    /// Returns the provider reference.
    #[inline]
    #[must_use]
    pub const fn provider_reference(&self) -> &ProviderReference {
        &self.provider_reference
    }

    /// Returns the merchant reference.
    #[inline]
    #[must_use]
    pub const fn merchant_reference(&self) -> &MerchantReference {
        &self.merchant_reference
    }

    /// Returns the normalized status.
    #[inline]
    #[must_use]
    pub const fn status(&self) -> PaymentStatus {
        self.status
    }

    /// Returns the next required action.
    #[inline]
    #[must_use]
    pub const fn next_action(&self) -> Option<&NextAction> {
        self.next_action.as_ref()
    }
}

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

impl PaymentStatusResponse {
    /// Returns the provider handling the payment.
    #[inline]
    #[must_use]
    pub const fn provider(&self) -> &PaymentProvider {
        &self.provider
    }

    /// Returns the provider reference.
    #[inline]
    #[must_use]
    pub const fn provider_reference(&self) -> &ProviderReference {
        &self.provider_reference
    }

    /// Returns the normalized status.
    #[inline]
    #[must_use]
    pub const fn status(&self) -> PaymentStatus {
        self.status
    }
}

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

    #[test]
    fn builder_requires_fields() {
        assert!(matches!(
            CreatePaymentRequest::builder().build(),
            Err(PaymentError::MissingRequiredField("amount"))
        ));
    }

    #[test]
    fn builder_creates_request() {
        let request = CreatePaymentRequest::builder()
            .amount(Money::new_minor(1_000, "USD").expect("money should be valid"))
            .reference("ORDER-1")
            .expect("reference should be valid")
            .description("Order 1")
            .customer(Customer::new().with_email("customer@example.com"))
            .payment_method(PaymentMethod::card())
            .callback_url("https://example.com/webhook")
            .expect("url should be valid")
            .return_url("https://example.com/success")
            .expect("url should be valid")
            .cancel_url("https://example.com/cancel")
            .expect("url should be valid")
            .checkout_ui_mode(CheckoutUiMode::Elements)
            .idempotency_key("ORDER-1:create")
            .expect("key should be valid")
            .metadata("cart", "primary")
            .build()
            .expect("request should be valid");

        assert_eq!(request.reference().as_str(), "ORDER-1");
        assert_eq!(request.description(), Some("Order 1"));
        assert_eq!(
            request
                .customer()
                .expect("customer should be present")
                .email(),
            Some("customer@example.com")
        );
        assert!(request.callback_url().is_some());
        assert!(request.return_url().is_some());
        assert!(request.cancel_url().is_some());
        assert_eq!(request.checkout_ui_mode(), CheckoutUiMode::Elements);
        assert_eq!(
            request
                .idempotency_key()
                .expect("key should be present")
                .as_str(),
            "ORDER-1:create"
        );
        assert_eq!(
            request
                .metadata()
                .get("cart")
                .expect("metadata should exist"),
            "primary"
        );
    }

    #[test]
    fn builder_defaults_to_hosted_checkout() {
        let request = CreatePaymentRequest::builder()
            .amount(Money::new_minor(1_000, "USD").expect("money should be valid"))
            .reference("ORDER-1")
            .expect("reference should be valid")
            .payment_method(PaymentMethod::card())
            .build()
            .expect("request should be valid");

        assert_eq!(request.checkout_ui_mode(), CheckoutUiMode::Hosted);
    }

    #[test]
    fn payment_session_new_generates_payment_id() {
        let session = PaymentSession::new(
            PaymentProvider::Stripe,
            ProviderReference::new("provider-ref").expect("reference should be valid"),
            MerchantReference::new("ORDER-1").expect("reference should be valid"),
            PaymentStatus::Created,
            None,
        )
        .expect("session should be valid");

        assert!(session.payment_id.as_str().starts_with("pay_"));
        assert_eq!(session.provider, PaymentProvider::Stripe);
    }
}