Features
🎉Card Payment🎉
🎉Bank Transfer Payment🎉
🎉Mobile Money Payment🎉
Getting started
Before you run, do the following in your android/app/build.gradle
Update your compileSDKVersion to latest
android {
compileSdkVersion 32
}
Update your minSDKVersion to 19
defaultConfig {
minSdkVersion 19
}
Getting Started
Instructions
- Open a command line and cd to your projects root folder
- run the command flutter pub add korapay, korapay will be added to the list of plugin in your pubspec
Pubspec
dependencies:
korapay: ^0.0.3
Usage
Simply call the PayWithKora
class to start making payments with korapay. As simple as that. Please note that for reference its important you use a unique id. I recommend uuid. I have added it as part of the package. Please see example below to see how it is used.
Example
final uniqueTransRef = PayWithKora().generateUuidV4();
PayWithKora().now(
context: context,
secretKey: "sk_test_j9KBpCCF5Sz3i21YYYLswHe4DLKNLdvWZ.......",
customerEmail: "amadipromise07@gmail.com",
reference: uniqueTransRef,
currency: "NGN",
amount: 1000.00,
transactionCompleted: () {
print("Transaction Successful");
},
transactionNotCompleted: () {
print("Transaction Not Successful!");
},
paymentChannel: ["card", "bank_transfer", "pay_with_bank"],
customerName: 'Promise Amadi',
callbackUrl: 'https://www.korahq.com',
);
Definitions
context
To aid in routing to screens
secretKey
Provided by korapay
customerEmail
Email address of the user/customer trying to make payment for receipt purpose
customerName
Name of the user/customer trying to make payment for record purpose
reference
Unique ID to recognise this transaction in your korapay dashboard. I've added uuidv4 to help with that. Kindly see the example in the readme. Alternatively you can create your own unique id.
currency
Currency user/customer should be charged in
amount
Amount or value user/customer should be charged.
callbackUrl
URL to redirect to after payment is successful, this helps close the session. This is setup in the Dashboard of korapay and the same URL setup is then provided here by you again. This is very important for successful or failed transactions
paymentChannels
Payment Channels are provided to you by KoraPay and some may not be available based on your country and preferences set in your korapay dashboard. Example; ["card", "pay_with_bank", "bank_transfer"]
transactionCompleted
Execute a function when transaction is completed or is successful
transactionNotCompleted
Execute a function when transaction is not completed or is not successful
Screenshots
Additional information
For more information and bug reports, Contact me on github @Wizpna
📝 Contributing, 😞 Issues and 🐛 Bug Reports
The project is open to public contribution. Please feel very free to contribute. Experienced an issue or want to report a bug? Please, report it here. Remember to be as descriptive as possible.
Support my Work 🙏🏽
Buy me coffee here. Thank you!