Flutter SDK
This section explains how to integrate Credit Card payments using the Novalnet Flutter SDK. The SDK handles the complete payment flow, including UI, validation, and transaction processing.
To get started:
Requirements
- Android
- Android 5.0 (API level 21) or later
- Enable Google Pay in the Android native layer (AndroidManifest.xml) if required by your project setup.
- iOS
- iOS 12.0 or later
- Xcode (latest stable version recommended)
- Apple Developer account with Apple Pay enabled
- Add Apple Pay capability in Xcode (Signing & Capabilities)
- Flutter
- Flutter SDK 3.0 or later
- Dart SDK 3.0 or later
- Compatible with both Android and iOS platforms
Supported Payment Methods
- Credit / Debit Cards
- Apple Pay
- Google Pay
Flutter SDK Integration
To integrate the Novalnet SDK, follow the steps below.
Step 1: Get the stable version of Novalnet sdk github >> link <<.
Step 2: Open Your flutter application -> pubspec.yaml file.
Step 3: To add the Novalnet SDK in dependencies.(ensure you are using the correct reference version v1.0.0)
dependencies: # level 0
pay: ^3.2.0 # +2 spaces
YAML is space-sensitive, so incorrect indentation will cause error
Step 4: Configuration Setup (config.yaml)
This step explains how merchants should create and include the required configuration file for the SDK.
1: Create config.yaml
Create a file named config.yaml inside your project’s assets folder:
If the assets folder does not already exist, create it first and then add the file inside it.
Folder structure :
Flutter Application -> Assets -> config.yaml
2: Add Configuration Values
Add your required merchant and payment configuration inside the file: refer example screenshot:
Replace all placeholder values with your actual merchant and transaction details.
Refer the parameter below.
3: Add Asset in pubspec.yaml
In your `pubspec.yaml` file, register the `config.yaml` file under the `flutter` section.
flutter: # level 0
assets: # +2 spaces
- assets/config.yaml # +4 spacesEnable Material Design Support :
Add the following configuration in your pubspec.yaml file under the flutter section:
flutter: # level 0
uses-material-design: true # +2 spacesAfter completing the configuration setup, run flutter pub get to fetch and install all the dependencies.
Note: Whenever you make changes or updates to the dependencies, run the flutter pub get command to apply and fetch the updated packages.
Important Notes
- Ensure the file path is correct: assets/config.yaml
- Maintain proper YAML formatting (no tabs, only spaces)
"signature": "###YOUR_API_KEY_SIGNATURE###"
"access_key": "###YOUR_PAYMENT_ACCESS_KEY###"
"client_key": "###YOUR_CLIENT_KEY###"
"tariff": "###YOUR_TARIFF_ID###"
"first_name": "###CUSTOMER_FIRST_NAME###"
"last_name": "###CUSTOMER_LAST_NAME###"
"email": "###CUSTOMER_E-MAIL###"
"customer_no": "###CUSTOMER_NO###"
"tel": "###CUSTOMER_TELEPHONE_NO###"
"billing":
"city": "###CUSTOMER_CITY###"
"country_code": "###CUSTOMER_COUNTRY_CODE (e.g: DE)###"
"house_no": "###CUSTOMER_HOUSE_NO"
"street": "###CUSTOMER_STREET###"
"zip": "###CUSTOMER_ZIP_CODE###"
"shipping":
"city": "###CUSTOMER_CITY###"
"country_code": "###CUSTOMER_COUNTRY_CODE (e.g: DE)###"
"house_no": "###CUSTOMER_HOUSE_NO"
"street": "###CUSTOMER_STREET###"
"zip": "###CUSTOMER_ZIP_CODE###"
"test_mode": "###TEST_MODE###"
"css_url": "###CUSTOM_CSS_URL###"
"amount": "###TRANSACTION_AMOUNT###"
"order_no": "###ORDER_NO###"
"currency": "###CURRENCY###"
"return_url": "Appname://payment-success"
"error_return_url": "Appname://payment-failed"
"payment_action": "payment/authorize"
"enforce_3d": "0"
"lang": "###STORE_LANGUAGE###"For a complete reference of all parameters, including descriptions, request headers, and response details, Refer to this link.
Payment Action
payment - where transactions are directly confirmed, and funds are automatically transferred from the buyer’s account to the merchant account. This can be changed as per your business requirements.
authorize - Payment details are verified while the funds are reserved, which will be captured later.
Step 5: After integrating the SDK into your app, proceed to prepare the payments.
Technical Support Through Novalnet
For any questions or further enquiries, please contact one of the following departments as per your requirement. Our in-house experts are ready to assist you in case of queries or issues.
If you have any installation assistance, recommendations, or suggestions for improvement, kindly share your thoughts with us to develop our flutter SDK further at technic@novalnet.de or call us at +49 89 9230683-19.
For our License details, see for Freeware License Agreement.