feat: added support for apple pay endpoints

Feature/apple pay

Author: morukele

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2025-06-29
+
+### 🚀 Features
+
+- Added support for initalizing dedicated virtual accounts
+- Added support for creating dedicated virtual account
+- Added support for assigning dedicated virtual account to customer
+- Added support for listing dedicated accounts in the integration
+- Added support for requery dedicated account
+- Added support for deactivating, creating split, and removing split in dedicated virtual account
+- Added support for fetching supported bank providers
+- Added support for the dedicated virtual account api endpoint
+- Added support for the dedicated virtual account api endpoint
+
+### 📚 Documentation
+
+- Updated the doc strings for the different modules
+
 ## [1.2.0] - 2025-06-28
 
 ### ⚙️ Miscellaneous Tasks
@@ -15,6 +33,7 @@ All notable changes to this project will be documented in this file.
 - *(ci)* Updated automatic release github action
 - *(changelog)* Update CHANGELOG.md for release
 - *(ci)* Updated automatic release github action
+- Release paystack-rs version 1.2.0
 
 ## [1.1.1] - 2025-06-26
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "paystack-rs"
-version = "1.2.0"
+version = "1.3.0"
 description = "Paystack API Wrapper"
 authors = ["Oghenemarho Orukele <orukele.dev@gmail.com>"]
 edition = "2021"

README.md

@@ -81,7 +81,7 @@ flowchart TD
 
 ```toml
 [dependencies]
-paystack-rs = "1.2.0"
+paystack-rs = "1.3.0"
 ```
 
 You can also download the source code and use in your code base directly if you prefer.

release.toml

@@ -1,6 +1,6 @@
 pre-release-replacements = [
     { file = "README.md", search = "^paystack-rs = \".*\"$", replace = "{{crate_name}} = \"{{version}}\"" },
-    { file = "src/lib.rs", search = "^//!     paystack-rs = \".*\"$", replace = "//!    {{crate_name}} = \"{{version}}\"" },
+    { file = "src/lib.rs", search = "^//!     paystack-rs = \".*\"$", replace = "//!     {{crate_name}} = \"{{version}}\"" },
 ]
 pre-release-hook = [
     "git",

src/client.rs

@@ -2,8 +2,9 @@
 //! =========
 //! This file contains the Paystack API client, and it associated endpoints.
 use crate::{
-    CustomersEndpoints, DedicatedVirtualAccountEndpoints, HttpClient, SubaccountEndpoints,
-    TerminalEndpoints, TransactionEndpoints, TransactionSplitEndpoints, VirtualTerminalEndpoints,
+    ApplePayEndpoints, CustomersEndpoints, DedicatedVirtualAccountEndpoints, HttpClient,
+    SubaccountEndpoints, TerminalEndpoints, TransactionEndpoints, TransactionSplitEndpoints,
+    VirtualTerminalEndpoints,
 };
 use std::sync::Arc;
 
@@ -24,6 +25,8 @@ pub struct PaystackClient<T: HttpClient + Default> {
     pub customers: CustomersEndpoints<T>,
     /// Dedicated Virtual Account API route
     pub dedicated_virtual_account: DedicatedVirtualAccountEndpoints<T>,
+    /// Apple Pay API route
+    pub apple_pay: ApplePayEndpoints<T>,
 }
 
 impl<T: HttpClient + Default> PaystackClient<T> {
@@ -41,6 +44,7 @@ impl<T: HttpClient + Default> PaystackClient<T> {
                 Arc::clone(&key),
                 Arc::clone(&http),
             ),
+            apple_pay: ApplePayEndpoints::new(Arc::clone(&key), Arc::clone(&http)),
         }
     }
 }

src/endpoints/apple_pay.rs

@@ -0,0 +1,112 @@
+//! Apple Pay
+//! THe Apple Pay API allows you register your application's top-level domain or subdomain.
+
+use std::{marker::PhantomData, sync::Arc};
+
+use serde_json::json;
+
+use crate::{ApplePayResponseData, HttpClient, PaystackAPIError, PaystackResult, Response};
+
+#[derive(Debug, Clone)]
+pub struct ApplePayEndpoints<T: HttpClient + Default> {
+    /// Paystack API key
+    key: String,
+    /// Base URL for the apple pay route
+    base_url: String,
+    /// Http client for the route
+    http: Arc<T>,
+}
+
+impl<T: HttpClient + Default> ApplePayEndpoints<T> {
+    /// Creates a new ApplePayEndpoints instance
+    ///Creates a new ApplePayEndpoints instance
+    ///
+    /// # Arguments
+    /// * `key` - The Paystack API key
+    /// * `http` - The HTTP client implementation to use for API requests
+    ///
+    /// # Returns
+    /// A new ApplePayEndpoints instance
+    pub fn new(key: Arc<String>, http: Arc<T>) -> ApplePayEndpoints<T> {
+        let base_url = String::from("https://api.paystack.co/apple-pay/domain");
+        ApplePayEndpoints {
+            key: key.to_string(),
+            base_url,
+            http,
+        }
+    }
+
+    /// Register a top-level domain or subdomain for your Apple Pay integration.
+    ///
+    /// # Arguments
+    /// * `domain_name` - The domain name to be registered with Apple Pay
+    ///
+    /// # Returns
+    /// A Result containing the registration response or an error
+    pub async fn register_domain(
+        &self,
+        domain_name: String,
+    ) -> PaystackResult<PhantomData<String>> {
+        let url = format!("{}", self.base_url);
+        let body = json!({
+            "domainName": domain_name
+        });
+
+        let response = self.http.post(&url, &self.key, &body).await;
+
+        match response {
+            Ok(response) => {
+                let parsed_response: Response<PhantomData<String>> =
+                    serde_json::from_str(&response)
+                        .map_err(|e| PaystackAPIError::ApplePay(e.to_string()))?;
+
+                Ok(parsed_response)
+            }
+            Err(e) => Err(PaystackAPIError::ApplePay(e.to_string())),
+        }
+    }
+
+    /// Lists all domains registered on your integration
+    ///
+    /// # Returns
+    /// A Result containing the list of registered domains or an error
+    pub async fn list_domains(&self) -> PaystackResult<ApplePayResponseData> {
+        let url = format!("{}", self.base_url);
+
+        let response = self.http.get(&url, &self.key, None).await;
+
+        match response {
+            Ok(response) => {
+                let parsed_response: Response<ApplePayResponseData> =
+                    serde_json::from_str(&response)
+                        .map_err(|e| PaystackAPIError::ApplePay(e.to_string()))?;
+
+                Ok(parsed_response)
+            }
+            Err(e) => Err(PaystackAPIError::ApplePay(e.to_string())),
+        }
+    }
+
+    pub async fn unregister_domain(
+        &self,
+        domain_name: String,
+    ) -> PaystackResult<PhantomData<String>> {
+        let url = format!("{}", self.base_url);
+        let body = json!({
+            "domainName": domain_name
+        });
+
+        let response = self.http.delete(&url, &self.key, &body).await;
+
+        match response {
+            Ok(response) => {
+                let parsed_response: Response<PhantomData<String>> =
+                    serde_json::from_str(&response)
+                        .map_err(|e| PaystackAPIError::ApplePay(e.to_string()))?;
+
+                Ok(parsed_response)
+            }
+            Err(e) => Err(PaystackAPIError::ApplePay(e.to_string())),
+        }
+    }
+}

src/endpoints/mod.rs

@@ -1,3 +1,4 @@
+pub mod apple_pay;
 pub mod customers;
 pub mod dedicated_virtual_account;
 pub mod subaccount;
@@ -7,6 +8,7 @@ pub mod transaction_split;
 pub mod virtual_terminal;
 
 // public re-export
+pub use apple_pay::*;
 pub use customers::*;
 pub use dedicated_virtual_account::*;
 pub use subaccount::*;

src/errors.rs

@@ -31,6 +31,8 @@ pub enum PaystackAPIError {
     /// Error associated with customer
     #[error("Customer Error: {0}")]
     Customer(String),
-    #[error("Dedicated Virtual Account: {0}")]
+    #[error("Dedicated Virtual Account Error: {0}")]
     DedicatedVirtualAccount(String),
+    #[error("Apple Pay Error: {0}")]
+    ApplePay(String),
 }

src/lib.rs

@@ -10,7 +10,7 @@
 //!
 //! ```toml
 //!     [dependencies]
-//!    paystack-rs = "1.2.0"
+//!     paystack-rs = "1.3.0"
 //! ```
 //!
 //! ## Usage

src/models/apple_pay.rs

@@ -0,0 +1,7 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct ApplePayResponseData {
+    #[serde(rename = "domainNames")]
+    pub domain_names: Vec<String>,
+}