EdfaPay Logo

Installation

Add the EdfaPay Payment Gateway SDK to your Android, iOS, or Flutter project. Covers dependency declaration, the Compose / Apple Pay prerequisites, and the manifest / Podfile changes each platform needs.

1

Prerequisites

Make sure your toolchain matches the SDK before adding the dependency. The bundled checkout UI is Jetpack Compose on Android and Compose-on-UIKit on iOS, both requiring the versions below.

Android

minSdk 24 (Android 7.0)
JVM 17, Kotlin 2.x
Jetpack Compose

iOS

iOS 13.0+
Swift 5.9+, Xcode 15+

Flutter

Flutter 3.24+
Dart 3.11+

Credentials

X-API-KEY + base URL from EdfaPay

2

Add the Dependency

Declare the SDK on each platform you target. Android pulls from Maven Central; iOS ships as the EdfaPayPGSDK binary framework via Swift Package Manager, CocoaPods, or a manual XCFramework; Flutter adds the pub package (its podspec already vendors the native framework).

Loading...

iOS delivery channels

The iOS framework is named EdfaPayPGSDK. SPM exposes the sdk product (add https://github.com/edfapay/paymentGateway in Xcode → File → Add Packages…); CocoaPods uses pod 'EdfaPayPGSDK'; or drop edfapay_pg_sdk.xcframework in manually. Pick one.

Platform Setup

Beyond the dependency, each platform needs a small amount of project configuration — internet permission, Compile/JVM 17, and (on iOS) the optional Apple Pay capability.

Android

Enable Compose and JVM 17, and declare the INTERNET permission. Flutter's default MainActivity : FlutterActivity already extends ComponentActivity, so the bundled sheet renders without changes.

Loading...

iOS

Use dynamic frameworks and iOS 13 as the deployment target. Apple Pay is optional — add the capability and a merchant identifier only if you call applePay(...).

Loading...

Flutter

Match the underlying KMP SDK on Android (JVM 17, minSdk 24) and run pod install for iOS. The plugin's podspec vendors the native framework, so no extra iOS pod is required.

Loading...

Import the SDK

Import the single public entry point wherever you call the SDK. On Flutter, one barrel exports EdfaPgSdk, the CardPay builder, every data model, the enums, and the EdfaPgSdkIsNotInitializedException.

Loading...

Next Step

Initialization