Seerbit Flutter SDK
Seerbit Flutter SDK can be used to integrate the SeerBit payment gateway into your flutter application.
Requirements
Register for a merchant account on Seerbit Merchant Dashboard to get started.
Dart sdk: ">=3.4.3 <4.0.0"
Flutter: ">=1.17.0"
Android: minSdkVersion 17 and add support for androidx (see AndroidX Migration to migrate an existing app)
iOS: --ios-language swift, Xcode version >= 12
Instalation
flutter pub get seerbit_flutter
API Documentation
Support
If you have any problems, questions or suggestions, create an issue here or send your inquiry to care@seerbit.com
Implementation
You should already have your API keys. If not, go to dashboard.seerbitapi.com. Login -> Settings menu -> API Keys menu -> Copy your public key
Properties
Property | Type | Required | Default | Desc |
---|---|---|---|---|
currency | String |
Optional | NGN | The currency for the transaction e.g NGN |
String |
Required | None | The email of the user to be charged | |
description | String |
Optional | None | The transaction description which is optional |
fullName | String |
Optional | None | The fullname of the user to be charged |
country | String |
Optional | None | Transaction country which can be optional |
transRef | String |
Required | None | Set a unique transaction reference for every transaction |
amount | String |
Required | None | The transaction amount in kobo |
callbackUrl | String |
Optional | None | This is the redirect url when transaction is successful |
publicKey | String |
Required | None | Your Public key or see above step to get yours |
closeOnSuccess | bool |
Optional | False | Close checkout when trasaction is successful |
closePrompt | bool |
Optional | False | Close the checkout page if transaction is not initiated |
setAmountByCustomer | bool |
Optional | False | Set to true if you want user to enter transaction amount |
pocketRef | String |
Optional | None | This is your pocket reference for vendors with pocket |
vendorId | String |
Optional | None | This is the vendorId of your business using pocket |
tokenize | bool |
Optional | False | Tokenize card |
planId | String |
Optional | None | Subcription Plan ID |
customization | CustomizationModel | Optional | CustomizationModel | CustomizationMode( borderColor: "#000000", backgroundColor: "#004C64", buttonColor: "#0084A0", paymentMethod:PayChannel.card, PayChannel.account, PayChannel.transfer, PayChannel.momo , confetti: false , logo: "logo_url or base64") |
onSuccess | Method |
Optional | None | Callback method if transaction was successful |
onCancel | Method |
Optional | None | Callback method if transaction was cancelled |
Usage
import 'package:flutter/material.dart';
import 'package:seerbit_flutter/seerbit_flutter.dart';
class CheckOut extends StatelessWidget {
const CheckOut({Key? key}) : super(key: key);
SeerbitMethod SeerBit = new SeerbitMethod();
@override
Widget build(BuildContext context) {
return Container(
color: Colors.white,
height: 1000,
width: 500,
child: Center(
child: TextButton(
onPressed: () => paymentStart(context),
child: Text(
"Checkout",
style: TextStyle(color: Colors.red),
),
),
),
);
}
paymentStart(context){
PayloadModel payload = PayloadModel(
currency: 'NGN',
email: "hellxo@gmxail.com",
description: "Sneakers",
fullName: "General ZxXXod",
country: "NG",
amount: "102",
transRef: Random().nextInt(2000).toString(),
publicKey: "merchant*public_key",
pocketRef: "",
vendorId: "vendorId",
closeOnSuccess: false,
closePrompt: false,
setAmountByCustomer: false,
tokenize: false,
planId: "",
customization: CustomizationModel(
borderColor: "#000000",
backgroundColor: "#004C64",
buttonColor: "#0084A0",
paymentMethod: [PayChannel.account, PayChannel.transfer, PayChannel.card, PayChannel.momo],
confetti: false,
logo: "logo_url || base64",
)
);
SeerBit.startPayment(
context,
payload: payload,
onSuccess: (*) { print(*);},
onCancel: (_) { print('_' _ 400);}
);
}
}
onSuccess
you will recieve a Map containing the response from the payment request.
During the payment process you can simply end the process by calling
SeerbitMethod.endPayment(context);
This ends the payment and removes the checkout view from the screen.
Libraries
- display/seerbit_screen
- display/seerbit_snack
- new/customization
- new/methods
- new/payload
- Model for the Payload that takes in all the needed payment data
- new/req
- new/state
- new/webViewOne
- new/webViewSwitcher
- new/webViewTwo
- seerbit_flutter