Balance Inquiry with the SDK

Follow these steps to install the SDK, authenticate, and query your balance.

1. Install the SDK

<dependency>
    <groupId>com.pahappa.systems</groupId>
    <artifactId>comms-sdk</artifactId>
    <version>1.0.0</version>
</dependency>

pnpm install comms-sdk
# or: npm install comms-sdk
# or: yarn add comms-sdk

cargo add comms-sdk

implementation 'com.pahappa.systems:comms-sdk:1.0.0'

go get github.com/pahappa-ltd/[email protected]

pip install comms_sdk

dart pub add comms_sdk
flutter pub add comms_sdk

composer require pahappa-limited/comms-sdk:1.0.0

gem install comms_sdk -v 1.0.1

dotnet add package Comms.Sdk --version 1.0.0

2. Authenticate

Main.java

import com.pahappa.systems.commssdk.v1.CommsSDK;

// CommsSDK.useSandbox(); // Use this if you are using sandbox credentials.
String apiUsername = "api_username";
String apiKey = "api_key";
CommsSDK sdk = CommsSDK.authenticate(apiUsername, apiKey);

main.js

const { CommsSDK } = require('comms-sdk');

const apiUsername = "api_username";
const apiKey = "api_key";

// CommsSDK.useSandbox();
const sdk = CommsSDK.authenticate(apiUsername, apiKey);

main.rs

use comms_sdk::CommsSDK;

let api_username = "api_username";
let api_key = "api_key";

// CommsSDK::use_sandbox();
let sdk = CommsSDK::authenticate(api_username, api_key);

Main.kt

import com.pahappa.systems.commssdk.v1.CommsSDK

val apiUsername = "api_username"
val apiKey = "api_key"

// CommsSDK.useSandbox()
val sdk = CommsSDK.authenticate(apiUsername, apiKey)

main.go

import v1 "github.com/Pahappa-LTD/comms-go-sdk/v1"

apiUsername := "api_username"
apiKey := "api_key"

// v1.CommsSDK.UseSandbox()
sdk := v1.CommsSDK.Authenticate(apiUsername, apiKey)

main.py

from comms_sdk import CommsSDK

api_username = "api_username"
api_key = "api_key"

# CommsSDK.use_sandbox()
sdk = CommsSDK.authenticate(api_username, api_key)

main.dart

import 'package:commssdk/commssdk.dart';

const apiUsername = "api_username";
const apiKey = "api_key";

// CommsSDK.useSandbox();
final sdk = await CommsSDK.authenticate(apiUsername, apiKey);

main.php

use PahappaLimited\CommsSDK\v1\CommsSDK;

$apiUsername = "api_username";
$apiKey = "api_key";

// CommsSDK::useSandbox();
$sdk = CommsSDK::authenticate($apiUsername, $apiKey);

main.rb

require 'comms_sdk'

api_username = "api_username"
api_key = "api_key"

# CommsSDK.use_sandbox
sdk = CommsSDK.authenticate(api_username, api_key)

Program.cs

using Comms;

string apiUsername = "api_username";
string apiKey = "api_key";

// CommsSDK.UseSandbox();
var sdk = CommsSDK.Authenticate(apiUsername, apiKey);

3. Query balance

Main.java

/* sdk.getBalance() returns a double value. */
double balance = sdk.getBalance();

/* sdk.queryBalance() returns an ApiResponse object with more fields. */
ApiResponse balanceQuery = sdk.queryBalance();
System.out.println(balanceQuery.status + " and balance: " + balanceQuery.balance);

main.js

const balance = await sdk.getBalance();
console.log("Balance: " + balance);

const balanceQuery = await sdk.queryBalance();
console.log(balanceQuery.status + " and balance: " + balanceQuery.balance);

main.rs

let balance = sdk.get_balance().unwrap();
println!("Balance: {}", balance);

let balance_query = sdk.query_balance().unwrap();
println!("{} and balance: {}", balance_query.status, balance_query.balance);

Main.kt

val balance = sdk.getBalance()
println("Balance: $balance")

val balanceQuery = sdk.queryBalance()
println(balanceQuery.status.toString() + " and balance: " + balanceQuery.balance)

main.go

balance, _ := sdk.GetBalance()
fmt.Printf("Balance: %v\n", balance)

balanceQuery, _ := sdk.QueryBalance()
fmt.Printf("%v and balance: %v\n", balanceQuery.Status, balanceQuery.Balance)

main.py

balance = sdk.get_balance()
print("Balance: " + str(balance))

balance_query = sdk.query_balance()
print(str(balance_query.status) + " and balance: " + str(balance_query.balance))

main.dart

final balance = await sdk.getBalance();
print("Balance: $balance");

final balanceQuery = await sdk.queryBalance();
print("${balanceQuery.status} and balance: ${balanceQuery.balance}");

main.php

$balance = $sdk->getBalance();
echo "Balance: " . $balance . \"\\n\";

$balanceQuery = $sdk->queryBalance();
echo $balanceQuery->status . \" and balance: \" . $balanceQuery->balance . \"\\n\";

main.rb

balance = sdk.get_balance
puts "Balance: #{balance}"

balance_query = sdk.query_balance
puts "#{balance_query.status} and balance: #{balance_query.balance}"

Program.cs

double balance = sdk.GetBalance();
Console.WriteLine("Balance: " + balance);

var balanceQuery = sdk.QueryBalance();
Console.WriteLine(balanceQuery.Status + " and balance: " + balanceQuery.Balance);

note

For query-based methods, the returned object is of type ApiResponse. See ApiResponse.