bitnob

Description:

bitnob

Bitnob SDK #
Bitnob SDK equips online businesses using react native with the ability to integrate our API features easily. Example are;

Checkout: Accept and process bitcoin payments via on-chain or lightning seamlessly
Oauth: Allows you to access Bitnob user details
Transfers: Allows businesses to transfer funds to a Bitnob customer, or local mobile money and bank accounts in supported African countries

Platform Support #



Android
iOS




✔️
✔️



⚙️ Android Setup #
No requirement
copied to clipboard
⚙️ Ios Setup #
No requirement
copied to clipboard
Getting Started #

Open a command line and cd to your projects root folder
In your pubspec, add an entry for bitnob to your dependencies (example below)
pub install

Installation #
You just need to add bitnob as a dependency in your pubspec.yaml file.
dependencies:
bitnob: ^0.1.1
copied to clipboard
-Run flutter packages get to install the package
How to Use #
import 'package:bitnob/bitnob.dart';
copied to clipboard
final BitNob _bitNob = BitNob();
copied to clipboard
How to get "publicKey" to use bitnob SDK? #

Create a Sandbox or Production Account, See the keys at Setting > Developers tab, See Documentation for more.

Checkout Example #
await _bitNob.initiateCheckout(
mode: "set mode(sandbox or production)",
description: "test",
callbackUrl: "test",
successUrl: "",
notificationEmail: "[email protected]",
customerEmail: "[email protected]",
satoshis: 2000,
reference: "test",
publicKey: "your public key",
context: context,
failCallback: (fail) {
//fail callBack
},
successCallback: (success) {
//success callBack
},
closeCallBack: (close) {
//close callBack
},
);
copied to clipboard
Note: successUrl keep blank.
copied to clipboard
How to get cliendID, scope, state to use bitnob OAuth? #

From your dashboard, create an App in Settings > Developers > Oauth apps to get them, See more in our OAuth Documentation.

OAuth Example #
await _bitNob.initiateOauth(
mode: "set mode(sandbox or production)",
clientId: "your clientId",
scope: [
"user:custom_ln_address",
"user:verification_level",
"user:email",
"user:username",
"user:ln_address"
],
state: "bbdbbbjjk",
redirectUrl: "your redirect url",
failCallback: (fail) {
if (kDebugMode) {
print("Fail=============> " + fail.toString());
}
},
successCallback: (success) {
if (kDebugMode) {
print("Success=============> " + success.toString());
}
},
closeCallBack: (close) {
if (kDebugMode) {
print("Close=============> " + close.toString());
}
},
context: context,
);
copied to clipboard
How to get "publicKey" to use bitnob SDK? #

Create a Sandbox or Production Account, See the keys at Setting > Developers tab, See Documentation for more.

Transfer Example #
await _bitNob.bitnobTransfer(
mode: Mode.sandbox,
redirectUrl: "your redirect url",
failCallback: (fail) {
if (kDebugMode) {
print("Fail=============> " + fail.toString());
}
},
successCallback: (success) {
if (kDebugMode) {
print("Success=============> " + success.toString());
}
},
closeCallBack: (close) {
if (kDebugMode) {
print("Close=============> " + close.toString());
}
},
context: context,
publicKey: 'your public key',
senderName: 'sender name',
);
copied to clipboard
📷 Checkout Screenshots #



Platform
Screenshot




Android



iOS




📷 OAuth Screenshots #



Platform
Screenshot




Android



iOS




📷 Transfer Screenshots #



Platform
Screenshot




Android



iOS




License #
MIT License

Copyright (c) 2022 bitnob

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
copied to clipboard