Adding payment splits (#66)

* adding Supported Networks in payment config

* adding netwrok utils

* update tests

* adding new network icon

* add network icon validation logic

* adding missing imports

* update network detection validation logic

* allign card number field with network icon

* update local

* add more validation

* update local

* refactor

* fixing RTL

* add expiry validation

* fixing RTL card number formatter

* update network detection

* update network in example

* increase version number 2.1.0

* pub get

* fixing comments

* Fix Apple Pay PaymentNetwork serialization issue

- Convert PaymentNetwork enum instances to string values using toJson() method
- Fixes 'Invalid argument: Instance of PaymentNetwork' error in Apple Pay
- Updated isApplePayAvailable, createConfigString, and createCustomNativeConfig methods
- Ensures proper communication between Flutter and iOS native code

* Bump version to 2.1.1 and update changelog

- Update version from 2.1.0 to 2.1.1 in pubspec.yaml
- Add changelog entry for Apple Pay PaymentNetwork serialization fix
- Document the bug fix that resolves 'Invalid argument: Instance of PaymentNetwork' error

* update version

* update version number

* adding new fonts

* update yml

* update ui

* update logo

* update padding

* finalize rebranding

* update version

* update version number

* adding split model

* adding new splits to the  payment request and resposne

* update demo

* adding new base url to easely customize it in case of staging or production

* update moyasar service to use base url

* update to v2.2.0

Author: Mahmoud-Abdelwahab

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.0
+
+Split Payment Feature 🐛
+
+- [Moyasar] Adding Split Payment support.
+
 ## 2.1.3
 
 STC UI Customization 🐛

example/lib/main.dart

@@ -39,7 +39,21 @@ class _CoffeeShopState extends State<CoffeeShop> {
           merchantId: 'merchant.com.mysr.apple',
           label: 'Blue Coffee Beans',
           manual: false,
-          saveCard: false));
+          saveCard: false),
+      // splits: [
+      //   PaymentSplit(
+      //       recipientId: "7d2d0797-a2be-40fe-bb1b-1fdec9824c95",
+      //       amount: 8000),
+      //   PaymentSplit(
+      //       recipientId: "327680bb-d790-4643-8e10-31455a1ab3a6",
+      //       amount: 2000,
+      //       reference: "optional-reference-for-split-1fcfcbe9-ba75-4eed",
+      //       description: "Platform processing fee",
+      //       feeSource: true,
+      //       refundable: false
+      //   )
+      // ]
+  );
 
   void onPaymentResult(result) {
     if (result is PaymentResponse) {

example/pubspec.lock

@@ -108,26 +108,26 @@ packages:
     dependency: transitive
     description:
       name: leak_tracker
-      sha256: "6bb818ecbdffe216e81182c2f0714a2e62b593f4a4f13098713ff1685dfb6ab0"
+      sha256: "33e2e26bdd85a0112ec15400c8cbffea70d0f9c3407491f672a2fad47915e2de"
       url: "https://pub.dev"
     source: hosted
-    version: "10.0.9"
+    version: "11.0.2"
   leak_tracker_flutter_testing:
     dependency: transitive
     description:
       name: leak_tracker_flutter_testing
-      sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
+      sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.9"
+    version: "3.0.10"
   leak_tracker_testing:
     dependency: transitive
     description:
       name: leak_tracker_testing
-      sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
+      sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.1"
+    version: "3.0.2"
   lints:
     dependency: transitive
     description:
@@ -156,17 +156,17 @@ packages:
     dependency: transitive
     description:
       name: meta
-      sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
+      sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
       url: "https://pub.dev"
     source: hosted
-    version: "1.16.0"
+    version: "1.17.0"
   moyasar:
     dependency: "direct main"
     description:
       path: ".."
       relative: true
     source: path
-    version: "2.1.3"
+    version: "2.2.0"
   path:
     dependency: transitive
     description:
@@ -264,10 +264,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
+      sha256: ab2726c1a94d3176a45960b6234466ec367179b87dd74f1611adb1f3b5fb9d55
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.4"
+    version: "0.7.7"
   typed_data:
     dependency: transitive
     description:
@@ -280,18 +280,18 @@ packages:
     dependency: transitive
     description:
       name: vector_math
-      sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803"
+      sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.4"
+    version: "2.2.0"
   vm_service:
     dependency: transitive
     description:
       name: vm_service
-      sha256: ddfa8d30d89985b96407efce8acbdd124701f96741f2d981ca860662f1c0dc02
+      sha256: "45caa6c5917fa127b5dbcfbd1fa60b14e583afdc08bfc96dda38886ca252eb60"
       url: "https://pub.dev"
     source: hosted
-    version: "15.0.0"
+    version: "15.0.2"
   web:
     dependency: transitive
     description:
@@ -304,18 +304,18 @@ packages:
     dependency: transitive
     description:
       name: webview_flutter
-      sha256: c3e4fe614b1c814950ad07186007eff2f2e5dd2935eba7b9a9a1af8e5885f1ba
+      sha256: a3da219916aba44947d3a5478b1927876a09781174b5a2b67fa5be0555154bf9
       url: "https://pub.dev"
     source: hosted
-    version: "4.13.0"
+    version: "4.13.1"
   webview_flutter_android:
     dependency: transitive
     description:
       name: webview_flutter_android
-      sha256: "9a25f6b4313978ba1c2cda03a242eea17848174912cfb4d2d8ee84a556f248e3"
+      sha256: eeeb3fcd5f0ff9f8446c9f4bbc18a99b809e40297528a3395597d03aafb9f510
       url: "https://pub.dev"
     source: hosted
-    version: "4.10.1"
+    version: "4.10.11"
   webview_flutter_platform_interface:
     dependency: transitive
     description:
@@ -328,10 +328,10 @@ packages:
     dependency: transitive
     description:
       name: webview_flutter_wkwebview
-      sha256: fb46db8216131a3e55bcf44040ca808423539bc6732e7ed34fb6d8044e3d512f
+      sha256: e49f378ed066efb13fc36186bbe0bd2425630d4ea0dbc71a18fdd0e4d8ed8ebc
       url: "https://pub.dev"
     source: hosted
-    version: "3.23.0"
+    version: "3.23.5"
   yaml:
     dependency: transitive
     description:
@@ -341,5 +341,5 @@ packages:
     source: hosted
     version: "3.1.3"
 sdks:
-  dart: ">=3.7.0 <4.0.0"
-  flutter: ">=3.29.0"
+  dart: ">=3.9.0 <4.0.0"
+  flutter: ">=3.35.0"

lib/moyasar.dart

@@ -8,6 +8,7 @@ export 'src/widgets/apple_pay.dart' show ApplePay;
 
 export 'src/models/card_form_model.dart' show CardFormModel;
 export 'src/models/payment_config.dart' show PaymentConfig, PaymentNetwork;
+export 'src/models/payment_split.dart' show PaymentSplit;
 export 'src/models/apple_pay_config.dart' show ApplePayConfig;
 export 'src/models/credit_card_config.dart' show CreditCardConfig;
 export 'src/models/payment_request.dart' show PaymentRequest;

lib/src/models/payment_config.dart

@@ -1,5 +1,6 @@
 import 'package:moyasar/src/models/apple_pay_config.dart';
 import 'package:moyasar/src/models/credit_card_config.dart';
+import 'package:moyasar/src/models/payment_split.dart';
 
 /// Supported Networks: [PaymentNetwork.amex, PaymentNetwork.visa, PaymentNetwork.mada, PaymentNetwork.masterCard]
 enum PaymentNetwork {
@@ -61,6 +62,16 @@ class PaymentConfig {
   /// given_id It is going be the ID of the created payment.
   String? givenID;
 
+  /// Optional payment splits for dividing payment amount among recipients.
+  /// Only available for aggregation clients. Splitting on non-aggregated payments will be ignored.
+  /// Contact your account manager to enable this feature.
+  List<PaymentSplit>? splits;
+
+  /// Optional base URL for the API endpoint.
+  /// Default is 'https://api.moyasar.com/v1/payments'.
+  /// For staging, use 'https://apimig.moyasar.com/v1/payments'.
+  String? baseUrl;
+
   PaymentConfig(
       {required this.publishableApiKey,
       required this.amount,
@@ -70,7 +81,9 @@ class PaymentConfig {
       List<PaymentNetwork>? supportedNetworks,
       this.applePay,
       this.creditCard,
-      this.givenID})
+      this.givenID,
+      this.splits,
+      this.baseUrl})
       : supportedNetworks = (supportedNetworks ?? const [
           PaymentNetwork.visa,
           PaymentNetwork.mada,

lib/src/models/payment_request.dart

@@ -12,6 +12,8 @@ class PaymentRequest {
   late PaymentRequestSource source;
   String? givenID;
   String callbackUrl = PaymentConfig.callbackUrl;
+  List<PaymentSplit>? splits;
+  String? baseUrl;
 
   PaymentRequest(
       PaymentConfig config, PaymentRequestSource paymentRequestSource) {
@@ -21,6 +23,8 @@ class PaymentRequest {
     metadata = config.metadata;
     source = paymentRequestSource;
     givenID = config.givenID;
+    splits = config.splits;
+    baseUrl = config.baseUrl;
   }
 
   Map<String, dynamic> toJson() => {
@@ -31,5 +35,7 @@ class PaymentRequest {
         'metadata': metadata,
         'callback_url': callbackUrl,
         if (givenID != null) 'given_id': givenID,
+        if (splits != null && splits!.isNotEmpty)
+          'splits': splits!.map((split) => split.toJson()).toList(),
       };
 }

lib/src/models/payment_response.dart

@@ -1,5 +1,6 @@
 import 'package:moyasar/moyasar.dart';
 import 'package:moyasar/src/models/payment_type.dart';
+import 'package:moyasar/src/models/payment_split.dart';
 
 /// Moyasar API response for processing a payment.
 class PaymentResponse {
@@ -25,6 +26,7 @@ class PaymentResponse {
   late String updatedAt;
   Map<String, dynamic>? metadata;
   late dynamic source;
+  List<PaymentSplit>? splits;
 
   PaymentResponse.fromJson(Map<String, dynamic> json, PaymentType paymentType) {
     id = json['id'];
@@ -52,6 +54,12 @@ class PaymentResponse {
       metadata = Map<String, dynamic>.from(json['metadata']);
     }
 
+    if (json['splits'] != null) {
+      splits = (json['splits'] as List)
+          .map((split) => PaymentSplit.fromJson(split as Map<String, dynamic>))
+          .toList();
+    }
+
     if (paymentType == PaymentType.creditcard) {
       source = CardPaymentResponseSource.fromJson(json['source']);
     } else if (paymentType == PaymentType.applepay) {
@@ -88,6 +96,9 @@ class PaymentResponse {
     if (metadata != null) {
       data['metadata'] = metadata;
     }
+    if (splits != null) {
+      data['splits'] = splits!.map((split) => split.toJson()).toList();
+    }
     if (source != null) {
       if (source is CardPaymentResponseSource) {
         data['source'] = (source as CardPaymentResponseSource).toJson();

lib/src/models/payment_split.dart

@@ -0,0 +1,59 @@
+/// Represents a payment split for dividing payment amount among recipients.
+/// 
+/// Payment splitting allows a merchant or platform to divide the payment amount
+/// along multiple recipients programmatically, ensuring compliance with SAMA and ZATCA regulations.
+class PaymentSplit {
+
+  /// The recipient ID (entity_id, platform_id, or beneficiary_id)
+  final String recipientId;
+
+  /// The amount to be split to this recipient (in smallest currency unit)
+  final int amount;
+
+  /// The type of recipient: "Entity", "Platform", or "Beneficiary"
+  final String? recipientType;
+
+  /// Optional description for this split
+  final String? description;
+
+  /// Optional reference for this split
+  final String? reference;
+
+  /// Whether this split is the fee source (only one split can be fee_source)
+  final bool feeSource;
+
+  /// Whether this split is refundable
+  final bool refundable;
+
+  const PaymentSplit({
+    required this.recipientId,
+    required this.amount,
+    this.recipientType,
+    this.description,
+    this.reference,
+    this.feeSource = false,
+    this.refundable = true,
+  });
+
+  Map<String, dynamic> toJson() => {
+        'recipient_type': recipientType,
+        'recipient_id': recipientId,
+        'amount': amount,
+        if (description != null) 'description': description,
+        if (reference != null) 'reference': reference,
+        'fee_source': feeSource,
+        'refundable': refundable,
+      };
+
+  factory PaymentSplit.fromJson(Map<String, dynamic> json) {
+    return PaymentSplit(
+      recipientType: json['recipient_type'] as String?,
+      recipientId: json['recipient_id'] as String,
+      amount: json['amount'] as int,
+      description: json['description'] as String?,
+      reference: json['reference'] as String?,
+      feeSource: json['fee_source'] as bool? ?? false,
+      refundable: json['refundable'] as bool? ?? true,
+    );
+  }
+}

lib/src/moyasar.dart

@@ -4,7 +4,7 @@ import 'package:moyasar/moyasar.dart';
 
 import 'models/payment_type.dart';
 
-const version = '2.1.3';
+const version = '2.2.0';
 
 /// Payment service.
 ///
@@ -16,9 +16,10 @@ class Moyasar {
       {required String apiKey, required PaymentRequest paymentRequest}) async {
     final headers = buildRequestHeaders(apiKey);
     final body = jsonEncode(paymentRequest.toJson());
+    final url = paymentRequest.baseUrl ?? apiUrl;
 
     final res = await http
-        .post(Uri.parse(apiUrl), headers: headers, body: body)
+        .post(Uri.parse(url), headers: headers, body: body)
         .onError((error, stackTrace) =>
             http.Response(jsonEncode({'type': NetworkError.type}), 400))
         .timeout(const Duration(seconds: 45),