The Android SDK to integrate to the cyberpay payment gateway The Cyberpay SDK makes it quick and easy to build seamless payment into your android app. The SDK contains custom views, and helps in managing the Cyberspace API.
The SDK provides custom native UI elements to get you started easily without having to design the elements yourself.
The Cyberpay Android SDK is compatible with Android Apps supported from Android 4.1 (Jelly Bean).
- Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}- Add the dependency
dependencies {
implementation 'com.github.cyberspace-ltd:cyberpay-android:1.5'
}
Step 1: Configure API Keys After installation of the Cyberpay SDK, configure it with your API Integration Key gotten from your merchant dashboard, for test and production
public class App extends Application{
@Override
public void onCreate() {
super.onCreate();
CyberPaySDK.initializeTestEnvironment("TEST_API_KEY");
//CyberPaySDK.initializeLiveEnvironment("LIVE_API_KEY");
}
}Note : Ensure when going live, you initialize the Live API key CyberPaySDK.initializeLiveEnvironment("LIVE_API_KEY") instead of the Test API key CyberPaySDK.initializeTestEnvironment("TEST_API_KEY"). This key can be gotten from the merchant
dashboard on the cyberpay merchant portal
Step 2: Collect Credit Card Information.
public class MainActivity extends AppCompatActivity {
Charge charge;
Transaction transaction;
private void initializeParameters(){
transaction = new Transaction();
transaction.setAmountInKobo(10000.00);
transaction.setDescription("Test transaction from Android SDK");
//transaction.setMerchantReference("CUSTOM_REF");
charge = new Charge();
charge.setCardNameHolder("Sample David");
charge.setCardExpiryMonth("04");
charge.setCardExpiryYear("30");
charge.setCardNumber(editText_Card_Number.getText().toString());
charge.setCardCvv(editText_Card_cvv.getText().toString());
}
}
Step 3 : Initialise the transaction
//The SetTransaction method returns a transaction Reference in the `onSuccess()` callback. Assign this transaction reference to the `transactionParameter` provided in the previous
//step and call the charge card method
CyberPaySDK.getInstance().SetTransaction(transaction, new CyberPaySDK.TransactionCallback() {
@Override
public void onSuccess(String transactionReference) {
progressDialog.dismiss();
ChargeCard();
}
@Override
public void onOtpRequired(Transaction transaction) {
//not needed for set transaction
}
@Override
public void onSecure3dRequired(Transaction transaction) {
//not needed for set transaction
}
@Override
public void onSecure3DMpgsRequired(Transaction transaction) {
//not needed for set transaction
}
@Override
public void onError(Throwable error, Transaction transaction) {
Toast.makeText(CyberPayActivty.this, "Error: " + error, Toast.LENGTH_LONG).show();
}
@Override
public void onBank(List<BankResponse> bankResponses) {
//not needed for set transaction
}
});Step 4: Charge Card providing the Card Parameters provided in Step 2
CyberPaySDK.getInstance().ChargeCard(charge, new CyberPaySDK.TransactionCallback() {
@Override
public void onSuccess(String transactionReference) {
//This is called only when a transaction is successful
// Toast.makeText(CyberPayActivty.this, "Transaction successful: Transaction Ref: " + transaction.getTransactionReference(), Toast.LENGTH_LONG).show();
}
@Override
public void onOtpRequired(Transaction transaction) {
// This is called only when otp is required
// Toast.makeText(CyberPayActivty.this, "Otp Required Transaction Ref: " + transaction.getTransactionReference(), Toast.LENGTH_LONG).show();
// Intent intent = new Intent(CyberPayActivty.this, OtpActivity.class);
// intent.putExtra(OtpActivity.PARAM_TRANSACTION, transaction);
// startActivity(intent);
}
@Override
public void onSecure3dRequired(Transaction transaction) {
//Certain cards require using secure 3ds environments, which will be redirected to a 3d secure environment.
Intent intent = new Intent(CyberPayActivty.this, MakePaymentActivity.class);
intent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
intent.putExtra(MakePaymentActivity.PARAM_TRANSACTION, transaction.getReturnUrl());
startActivity(intent);
finish();
}
@Override
public void onSecure3DMpgsRequired(Transaction transaction) {
//Certain cards require using secure 3ds environments, which will be redirected to a 3d secure environment.
Intent intent = new Intent(CyberPayActivty.this, MakePaymentActivity.class);
intent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
intent.putExtra(MakePaymentActivity.PARAM_TRANSACTION, transaction.getReturnUrl());
startActivity(intent);
finish();
}
@Override
public void onError(Throwable error, Transaction transaction) {
Toast.makeText(CyberPayActivty.this, "Error: " + error, Toast.LENGTH_LONG).show();
}
@Override
public void onBank(List<BankResponse> bankResponses) {
Toast.makeText(CyberPayActivty.this, "Transaction successful: Transaction Ref: " + transaction.getTransactionReference(), Toast.LENGTH_LONG).show();
}
});Note: The chargeCard() method returns 3 callbacks: onSuccess(), which means your transaction was successful and returns the transaction Reference, onOtpRequired(), which means an otp is required to verify this transaction,
and also returns the transaction reference, onError(), which returns an error message, when chargeCard() fails.
Step 5 : Verify OTP
When a verification is required, the Otp verification method is called.
The onOtpRequired() method from Step 4 returns a Transaction Object. You can send this same Transaction Object to the VerifyOtp Otp Method.
CyberPaySDK.getInstance().VerifyOtp(transaction, new CyberPaySDK.TransactionCallback() {
@Override
public void onSuccess(String transactionReference) {
//This is called when a transaction is successful
}
@Override
public void onOtpRequired(Transaction transaction) {
// Not needed in this method
}
@Override
public void onError(Throwable error, Transaction transaction) {
//This is called only when an error occurs
}
});Note: Other methods for the cyberpay SDK exist which include verification of transaction by the merchant reference, and also by the transaction Reference.
After running the app, We have provided a test card to test the OTP flow instead of using live cards.
Card Number: 5399830000000008,
Exp. Date: 05/30,
CVV: 000,
OTP:123456