Integrating Pay-Button-Android SDK in your application
Before diving into the development process, it's essential to establish the prerequisites and criteria necessary for a successful build. In this step, we'll outline the specific Android requirements, including the minimum SDK version and other important details you need to consider. Let's ensure your project is set up for success from the very beginning.
- We support from Android minSdk 24
- Kotlin support version 1.8.0+
While you can certainly use the sandbox keys available within our sample app which you can get by following installation page, however, we highly recommend visiting our onboarding page, there you'll have the opportunity to register your package name and acquire your essential Tap Key for activating PayButton integration.
in project module gradle
allprojects {
repositories {
google()
jcenter()
maven { url 'https://jitpack.io' }
}
}Then get latest dependency in your app module gradle
dependencies {
implementation 'com.github.Tap-Payments:Pay-Button-Android:'
}This integration offers two distinct options: a simple integration designed for rapid development and streamlined merchant requirements, and an advanced integration that adds extra features for a more dynamic payment integration experience.
Noting that in Android, you have the ability to create the UI part of the PayButton-Android by creating it as normal view in your XML then implement the functionality through code or fully create it by code. Below we will describe both flows:
You will have to create a variable of type Pay-Button-Android, which can be done in one of two ways:
- Created in the XML and then linked to a variable in code.
- Created totally within the code. Once you create the variable in any way, you will have to follow these steps:
- Create the parameters.
- Pass the parameters to the variable.
- Implement PayButtonStatusDelegate interface, which allows you to get notified by different events fired from within the Pay-Button-Android SDK, also called callback functions.
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:orientation="vertical"
android:layout_height="match_parent"
tools:context=".main_activity.MainActivity">
<company.tap.tappaybutton.TapPayButton
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="@dimen/_20sdp"
android:id="@+id/redirect_pay"
/>
</LinearLayout>
lateinit var payButton: PayButton
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
payButton = findViewById<PayButton>(R.id.paybutton)
}
lateinit var payButton: PayButton
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val linearLayoutParams = LinearLayout.LayoutParams(
LinearLayout.LayoutParams.WRAP_CONTENT, LinearLayout.LayoutParams.WRAP_CONTENT
)
/** create dynamic view of PayButton view **/
payButton = PayButton(this)
payButton.layoutParams = linearLayoutParams
/** refrence to parent layout view **/
this.findViewById<LinearLayout>(R.id.linear_layout).addView(payButton)
}Here, you'll discover a comprehensive table featuring the parameters applicable to the simple integration. Additionally, you'll explore the various methods for integrating the SDK, either using xml to create the layout and then implementing the interface functionalities by code, or directly using code. Furthermore, you'll gain insights into how to receive the callback notifications.
Each parameter is linked to the reference section, which provides a more in depth explanation of it.
| Parameters | Description | Required | Type | Sample |
|---|---|---|---|---|
| operator | It has the key obtained after registering your package name, also known as Public key. Also, the hashString value which is used to validate live charges | True | String | var operator=HashMap<String,Any>(),operator.put("publicKey","pk_test_YhUjg9PNT8oDlKJ1aE2fMRz7"),operator.put("hashString","") |
| intentid | Intent id received | False | String | configuration.put("intent",'intentID") |
After creating the UI using any of the previously mentioned ways, it is time to pass the parameters needed for the SDK to work as expected and serve your need correctly.
To allow flexibility and to ease the integration, your application will only has to pass the parameters as a HashMap<String,Any> . First, let us create the required parameters:
val publicKey = "pk_test_XXXXXXXXXXXXXX"
val jsonObject = JSONObject()
jsonObject.put("scope", scope)
jsonObject.put("purpose", charge)
jsonObject.put("statement_descriptor", "statement_descriptor")
jsonObject.put("description", "sd")
jsonObject.put("reference","uuid_testabcdfgkgdgd121992")
jsonObject.put("customer_initiated", true)
jsonObject.put("hash_string", "")
jsonObject.put("idempotent", "")
val merchant = JSONObject()
val terminal = JSONObject()
terminal.put("id","")
val terminaldevice = JSONObject()
terminaldevice.put("id","")
terminal.put("terminal_device",terminaldevice)
val medata = JSONObject()
medata.put("uud","qq")
medata.put("uud2","222")
val operator = JSONObject()
operator.put("id","")
val device= JSONObject()
device.put("id","")
operator.put("device",device)
merchant.put("id",intent.getStringExtra("merchantId"))
merchant.put("terminal",terminal)
merchant.put("operator",operator)
val paymentprovider = JSONObject()
val technology= JSONObject()
technology.put("id","")
val institution= JSONObject()
institution.put("id","")
paymentprovider.put("technology",technology)
paymentprovider.put("institution",institution)
val ddevelopmenthouse= JSONObject()
ddevelopmenthouse.put("id","")
val platform= JSONObject()
platform.put("id","")
merchant.put("payment_provider",paymentprovider)
merchant.put("institution",institution)
merchant.put("development_house",ddevelopmenthouse)
merchant.put("platform",platform)
jsonObject.put("merchant", merchant)
val authenticate = JSONObject()
authenticate.put("id","")
authenticate.put("required",true)
jsonObject.put("authenticate", authenticate)
val transaction = JSONObject()
val cardholderlogin = JSONObject()
cardholderlogin.put("type", "GUEST")
cardholderlogin.put("timestamp", "123213213")
val payment_agreement = JSONObject()
// val contract = JSONObject()
// contract.put("id","")
// payment_agreement.put("id","")
// payment_agreement.put("contract",contract)
// transaction.put("card_holder_login",cardholderlogin)
// transaction.put("metadata",medata)
// transaction.put("reference","TEST")
// transaction.put("payment_agreement",payment_agreement)
// jsonObject.put("transaction", transaction)
val invoice = JSONObject()
invoice.put("id","")
jsonObject.put("invoice", invoice)
val descriptiom = JSONObject()
descriptiom.put("text", "name ")
descriptiom.put( "lang", "en ")
val reference = JSONObject()
reference.put("sku", "stock keeping unit ")
reference.put( "gtin", "global trade item number ")
reference.put("code", "00dfd ")
reference.put("financial_code", "0022343")
val descArray = JSONArray()
descArray.put(descriptiom)
val product = JSONObject()
product.put("id","")
product.put("amount",intent.getStringExtra("amountKey")?.toDouble())
product.put("name",descArray)
product.put("description",descArray)
product.put("metadata",medata)
product.put("category","PHYSICAL_GOODS")
product.put("reference",reference)
val itemsList = JSONObject()
itemsList.put("id", " ")
itemsList.put("quantity", 1)
itemsList.put("pickup", false)
itemsList.put("product", product)
val itemsArry = JSONArray()
itemsArry.put(itemsList)
val items = JSONObject()
items.put("count",1)
items.put("list",itemsArry)
val order = JSONObject()
order.put("amount",(intent.getStringExtra("amountKey")?.toDouble()))
// order.put("amount",3)
order.put("currency",intent.getStringExtra("orderCurrencyKey"))
order.put("description",descArray)
order.put("reference",intent.getStringExtra("orderRefrenceKey"))
order.put("items",items)
val discount = JSONObject()
discount.put("type","F")
discount.put("value",1)
val tax = JSONObject()
tax.put( "name", "VAT")
tax.put( "description", "test")
tax.put( "type", "F")
tax.put( "value", 1)
val taxarry= JSONArray()
taxarry.put(tax)
val adddress = JSONObject()
adddress.put("type","home ")
adddress.put("line1", "sdfghjk ")
adddress.put("line2", "oiuytr ")
adddress.put("line3", "line3 ")
adddress.put("line4","line4 ")
adddress.put( "apartment", " ")
adddress.put("building", " ")
adddress.put("street", " ")
adddress.put("avenue", " ")
adddress.put("block", " ")
adddress.put("area"," ")
adddress.put("city", "salmyia")
adddress.put("state", "kuwait")
adddress.put("country", "KW")
adddress.put("zip_code","30003")
adddress.put("postal_code", " ")
val provider = JSONObject()
provider.put("id","")
val shippigobject = JSONObject()
shippigobject.put("amount",1)
shippigobject.put("description",descArray)
shippigobject.put("recipient_name",descArray)
shippigobject.put("address",adddress)
shippigobject.put("provider",provider)
shippigobject.put("metadata",medata)
// order.put("tax",taxarry)
// order.put("discount",discount)
// order.put("shipping",shippigobject)
order.put("metadata",medata)
jsonObject.put("order",order)
val name = JSONObject()
name.put("first", "OSAMA ")
name.put("last", "Ahmed ")
name.put("middle", " ")
name.put("title","MR ")
val nameList = JSONArray()
nameList.put(name)
val nameCard = JSONObject()
nameCard.put("content", "OSAMA AHMED ")
nameCard.put("editable",true)
val phone = JSONObject()
phone.put("country_code","965")
phone.put("number","55683784")
val contact = JSONObject()
contact.put("email","tap.test@company")
contact.put("phone",phone)
val customer = JSONObject()
customer.put("id",intent.getStringExtra("customerIdKey"))
customer.put("name",nameList)
customer.put("name_on_card",nameCard)
customer.put("contact",contact)
customer.put("address",adddress)
jsonObject.put("customer",customer)
val receipt = JSONObject()
receipt.put("email", false)
receipt.put("sms", false)
jsonObject.put("receipt", receipt)
val configOb = JSONObject()
configOb.put("initiator","MERCHANT")
configOb.put("type","BUTTON")
val features = JSONObject()
features.put("acceptance_badge",true)
features.put("order",true)
features.put("multiple_currencies",true)
val currency_conversions = JSONObject()
currency_conversions.put("dynamic", true)
currency_conversions.put("location", true)
currency_conversions.put("payment", true)
currency_conversions.put("cobadge", true)
val alternative_card_inputs = JSONObject()
alternative_card_inputs.put("card_scanner", true)
alternative_card_inputs.put("card_nfc ", true)
val customer_cards = JSONObject()
customer_cards.put("save_card", true)
customer_cards.put("auto_save_card", true)
customer_cards.put("display_saved_cards", true)
val payments = JSONObject()
payments.put("card", true)
payments.put("device", true)
payments.put("wallet", true)
payments.put("bnpl", true)
payments.put("mobile", true)
payments.put("cash", true)
payments.put("redirect", true)
features.put("currency_conversions",currency_conversions)
features.put("payments",payments)
features.put("alternative_card_inputs",alternative_card_inputs)
features.put("customer_cards",customer_cards)
val acceptance = JSONObject()
val supported_regions = JSONArray()
supported_regions.put("LOCAL")
supported_regions.put("REGIONAL")
supported_regions.put("GLOBAL")
val supported_countries = JSONArray()
supported_countries.put("AE")
supported_countries.put("SA")
supported_countries.put("KW")
supported_countries.put("EG")
val supported_currencies = JSONArray()
supported_currencies.put("KWD")
supported_currencies.put( "SAR")
supported_currencies.put("AED")
supported_currencies.put("OMR")
supported_currencies.put("QAR")
supported_currencies.put("BHD")
supported_currencies.put("EGP")
supported_currencies.put("GBP")
supported_currencies.put("USD")
supported_currencies.put("EUR")
supported_currencies.put("AED")
val supported_payment_methods = JSONArray()
supported_payment_methods.put("BENEFITPAY")
/*val supported_payment_types = JSONArray()
// supported_payment_methods.put ("CARD")
supported_payment_types.put("DEVICE")
supported_payment_types.put("WEB")*/
val supported_schemes = JSONArray()
// supported_schemes.put("CARD")
supported_schemes.put( "MADA")
supported_schemes.put("OMANNET")
supported_schemes.put("VISA")
supported_schemes.put( "MASTERCARD")
supported_schemes.put("AMEX")
supported_schemes.put("BENEFIT_CARD" )
val defaultHash = hashSetOf("VISA","AMEX","MASTERCARD","BENEFIT_CARD","OMANNET","MADA")
val defaultFundHash = hashSetOf("CREDIT","DEBIT")
println("defaultHash"+defaultHash)
val supported_fund_source = JSONArray()
// supported_fund_source.put("CARD")
supported_fund_source.put("DEBIT")
supported_fund_source.put("CREDIT")
val supported_payment_flows = JSONArray()
//supported_payment_flows.put("CARD")
supported_payment_flows.put("POPUP")
supported_payment_flows.put( "PAGE")
val supported_payment_authentications = JSONArray()
supported_payment_authentications.put("3DS")
supported_payment_authentications.put( "EMV")
supported_payment_authentications.put( "PASSKEY")
// acceptance.put("supported_regions",supported_regions)
// acceptance.put("supported_countries",supported_countries)
// acceptance.put("supported_payment_types",supported_payment_types)
// acceptance.put("supported_currencies",supported_currencies)
val paymethods = getPrefStringValue("buttonKey","KNET")
val arry = JSONArray()
arry.put(paymethods)
acceptance.put("supported_payment_methods",arry)
acceptance.put("supported_schemes",
JSONArray(getPrefs().getStringSet("supportedSchemesKey", defaultHash.toHashSet()))
)
acceptance.put("supported_fund_source",
JSONArray(getPrefs().getStringSet("supportedFundSourceKey", defaultFundHash.toHashSet()))
)
acceptance.put("supported_payment_authentications",supported_payment_authentications)
acceptance.put("supported_payment_flows",supported_payment_flows)
val interfacee = JSONObject()
interfacee.put("locale",intent.getStringExtra("selectedlangKey") ?: "EN")
interfacee.put("theme",intent.getStringExtra("selectedthemeKey") ?: "LIGHT")
interfacee.put("edges",intent.getStringExtra("selectedcardedgeKey") ?: "CURVED")
interfacee.put("color_style",intent.getStringExtra("selectedcolorstyleKey") ?:"COLORED")
interfacee.put("user_experience","POPUP")
interfacee.put("card_direction","DYNAMIC")
interfacee.put("loader", true)
interfacee.put("powered", true)
val fieldvisibility = JSONObject()
val card = JSONObject()
card.put( "number",true)
card.put("expiry",true)
card.put("cvv",true)
card.put("cardholder", true)
val conatct = JSONObject()
conatct.put("email", true)
conatct.put("number", true)
val shipping = JSONObject()
shipping.put("address", true)
fieldvisibility.put("name",true)
fieldvisibility.put("card",card)
fieldvisibility.put("contact",conatct)
// fieldvisibility.put("shipping",shipping)
configOb.put("features",features)
configOb.put("acceptance",acceptance)
configOb.put("field_visibility",fieldvisibility)
configOb.put("interface",interfacee)
val checkout = JSONObject()
checkout.put("auto", true)
checkout.put("metadata", medata)
val post = JSONObject()
post.put("url","osama.cm")
val redirect = JSONObject()
redirect.put("url","osama.cm")
val domain = JSONObject()
domain.put("url","demo.tap.PayButtonSDK")
jsonObject.put("config", configOb)
jsonObject.put("domain",domain)
jsonObject.put("redirect",redirect)
jsonObject.put("post",post)
jsonObject.put("checkout",checkout)
val intentObjc: HashMap<String, Any> = Gson().fromJson(
jsonObject.toString(), object : TypeToken<HashMap<String?, Any?>?>() {}.type
)
/**
* configureWithPayButtonDictionary and calling the PayButton SDK
*/
if(intentId==null){
PayButtonConfiguration.configureWithPayButtonDictionary(
this,
publicKey,
null,
findViewById(R.id.redirect_pay),
intentObjc,
this)
}else{
PayButtonConfiguration.configureWithPayButtonDictionary(
this,
publicKey,
intentId,
findViewById(R.id.redirect_pay),
null,
this)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val publicKey = "pk_test_XXXXXXXXX"
/**
* operator
*/
val operator = HashMap<String,Any>()
operator.put("publicKey",publicKey.toString())
/**
* intent
*/
val intentObj = HashMap<String,Any>()
if (intentId != null) {
intentObj.put("intent",intentId)
}
/**
* configuration
*/
val configuration = LinkedHashMap<String,Any>()
configuration.put("operator",operator)
configuration.put("intent",intentObj)
/**
* configureWithPayButtonDictionary and calling the PayButton SDK
*/
PayButtonConfiguration.configureWithPayButtonDictionary(
this,
findViewById(R.id.redirect_pay),
configuration,
this)
}Now we have created the UI and the parameters required to to correctly display PayButton form. For the best experience, your class will have to implement PayButtonStatusDelegate interface, which is a set of optional callbacks, that will be fired based on different events from within the payButton button. This will help you in deciding the logic you need to do upon receiving each event. Kindly follow the below steps in order to complete the mentioned flow:
- Go back to Activity file you want to get the callbacks into.
- Head to the class declaration line
- Add PayButtonStatusDelegate
- Override the required callbacks as follows:
object : PayButtonStatusDelegate {
override fun onPayButtonSuccess(data: String) {
Log.i("onSuccess",data)
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onSuccess>>>> $data"
findViewById<TextView>(R.id.text).movementMethod = ScrollingMovementMethod()
Toast.makeText(this, "onSuccess $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonClick() {
Toast.makeText(this, "onClick", Toast.LENGTH_SHORT).show()
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onClick "
}
override fun onPayButtonChargeCreated(data: String) {
Log.e("data",data.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onChargeCreated $data"
Toast.makeText(this, "onChargeCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonOrderCreated(data: String) {
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onOrderCreated >> $data"
Log.e("mainactv", "onPayButtonOrderCreated: "+data )
Toast.makeText(this, "onOrderCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtoncancel() {
Toast.makeText(this, "Cancel ", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonError(error: String) {
Log.e("error",error.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onError $error"
Toast.makeText(this, "onError $error ", Toast.LENGTH_SHORT).show()
}
}The advanced configuration for the PayButton-Android integration not only has all the features available in the simple integration but also introduces new capabilities, providing merchants with maximum flexibility. You can find a code below, where you'll discover comprehensive guidance on implementing the advanced flow as well as a complete description of each parameter.
Each parameter is linked to the reference section, which provides a more in depth explanation of it.
| Parameters | Description | Required | Type | Sample |
|---|---|---|---|---|
| operator | It has the key obtained after registering your package name, also known as Public key. Also, the hashString value which is used to validate live charges | True | String | var operator=HashMap<String,Any>(),operator.put("publicKey","pk_test_YhUjg9PNT8oDlKJ1aE2fMRz7"),operator.put("hashString","") |
| intentid | Intent id received | False | String | configuration.put("intent",'intentID") |
You can use a Hashmap to send data to our SDK. The benefit is that you can generate this data from one of your APIs. If we make updates to the configurations, you can update your API, avoiding the need to update your app on the Google play Store.
val publicKey = "pk_test_XXXXXXXXXXXX"
/**
* operator
*/
val operator = HashMap<String,Any>()
operator.put("publicKey",publicKey.toString())
/**
* intent
*/
val intentObj = HashMap<String,Any>()
if (intentId != null) {
intentObj.put("intent",intentId)
}
/**
* configuration
*/
val configuration = LinkedHashMap<String,Any>()
configuration.put("operator",operator)
configuration.put("intent",intentObj)
The below will allow the integrators to get notified from events fired from the PayButton.
override fun onPayButtonReady() {
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onReady"
Toast.makeText(this, "onReady", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonSuccess(data: String) {
Log.i("onSuccess",data)
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onSuccess>>>> $data"
findViewById<TextView>(R.id.text).movementMethod = ScrollingMovementMethod()
Toast.makeText(this, "onSuccess $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonClick() {
Toast.makeText(this, "onClick", Toast.LENGTH_SHORT).show()
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onClick "
}
override fun onPayButtonBindIdentification(data: String) {
Toast.makeText(this, "onBindIdentification", Toast.LENGTH_SHORT).show()
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onBindIdentification $data "
}
override fun onPayButtonChargeCreated(data: String) {
Log.e("data",data.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onChargeCreated $data"
Toast.makeText(this, "onChargeCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonOrderCreated(data: String) {
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onOrderCreated >> $data"
Log.e("mainactv", "onPayButtonOrderCreated: "+data )
Toast.makeText(this, "onOrderCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtoncancel() {
Toast.makeText(this, "Cancel ", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonError(error: String) {
Log.e("error",error.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onError $error"
Toast.makeText(this, "onError $error ", Toast.LENGTH_SHORT).show()
}Once all of the above steps are successfully completed, your Activity file should look like this:
class MainActivity : AppCompatActivity() ,PayButtonStatusDelegate{
lateinit var payButton: PayButton
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
configureSdk()
}
fun configureSdk(intentId:String?) {
val publicKey = "pk_test_J2OSkKAFxu4jghc9zeRfQ0da"
/**
* operator
*/
val operator = HashMap<String,Any>()
operator.put("publicKey",publicKey.toString())
/**
* intent
*/
val intentObj = HashMap<String,Any>()
if (intentId != null) {
intentObj.put("intent",intentId)
}
/**
* configuration
*/
val configuration = LinkedHashMap<String,Any>()
configuration.put("operator",operator)
configuration.put("intent",intentObj)
/**
* configureWithPayButtonDictionary and calling the PayButton SDK
*/
PayButtonConfiguration.configureWithPayButtonDictionary(
this,
findViewById(R.id.redirect_pay),
configuration,
this)
}
override fun onPayButtonReady() {
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onReady"
Toast.makeText(this, "onReady", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonSuccess(data: String) {
Log.i("onSuccess",data)
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onSuccess>>>> $data"
findViewById<TextView>(R.id.text).movementMethod = ScrollingMovementMethod()
Toast.makeText(this, "onSuccess $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonClick() {
Toast.makeText(this, "onClick", Toast.LENGTH_SHORT).show()
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onClick "
}
override fun onPayButtonChargeCreated(data: String) {
Log.e("data",data.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onChargeCreated $data"
Toast.makeText(this, "onChargeCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonOrderCreated(data: String) {
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onOrderCreated >> $data"
Log.e("mainactv", "onPayButtonOrderCreated: "+data )
Toast.makeText(this, "onOrderCreated $data", Toast.LENGTH_SHORT).show()
}
override fun onPayButtoncancel() {
Toast.makeText(this, "Cancel ", Toast.LENGTH_SHORT).show()
}
override fun onPayButtonError(error: String) {
Log.e("error",error.toString())
findViewById<TextView>(R.id.text).text = ""
findViewById<TextView>(R.id.text).text = "onError $error"
Toast.makeText(this, "onError $error ", Toast.LENGTH_SHORT).show()
}
}Below you will find more details about each parameter shared in the above tables that will help you easily integrate PayButton-Android SDK.
- Definition: It links the payment gateway to your merchant account with Tap, in order to know your business name, logo, etc...
- Type: string (required)
- Fields:
- publicKey :
- Definition: This is a unique public key that you will receive after creating an account with Tap which is considered a reference to identify you as a merchant. You will receive 2 public keys, one for sandbox/testing and another one for production.
- publicKey :
- Example:
val operator = HashMap<String,Any>() operator.put("publicKey","publickKeyValue")
- Definition: The intent Id generated by intent API.
- Type: string (optional)
- values:
- charge :
- Definition: The scope/intention of the current order to charge the customer. Default
- authorize :
- Definition: The scope/intention of the current order to authorize an amount from the customer.
- charge :
- Example:
intentObj.put("intent",intentId)
1.BenefitPay
2.Knet
3.Benefit
4.Fawry
5.Paypal
6.Tabby
7.GooglePay
8.SamsungPay
9.STCPay
10.QPay
- Import the Crypto
import javax.crypto.Mac
import javax.crypto.spec.SecretKeySpec
import java.util.Formatter- Copy this helper singleton class
/// Create a singleton class where you can use as a helper to generate hash strings
object TapHmac {
/**
This is a helper method showing how can you generate a hash string when performing live charges
- Parameter publicKey: The Tap public key for you as a merchant pk_.....
- Parameter secretKey: The Tap secret key for you as a merchant sk_.....
- Parameter amount: The amount you are passing to the SDK, ot the amount you used in the order if you created the order before.
- Parameter currency: The currency code you are passing to the SDK, ot the currency code you used in the order if you created the order before. PS: It is the capital case of the 3 iso country code ex: SAR, KWD.
- Parameter post: The post url you are passing to the SDK, ot the post url you pass within the Charge API. If you are not using postUrl please pass it as empty string
- Parameter transactionReference: The reference.trasnsaction you are passing to the SDK(not all SDKs supports this,) or the reference.trasnsaction you pass within the Charge API. If you are not using reference.trasnsaction please pass it as empty string
*/
fun generateTapHashString(publicKey:String, secretKey:String, amount:Double, currency:String, postUrl:String = "", transactionReference:String = ""): String {
// Let us generate our encryption key
val signingKey = SecretKeySpec(secretKey.toByteArray(), "HmacSHA256")
val mac = Mac.getInstance("HmacSHA256")
mac.init(signingKey)
// For amounts, you will need to make sure they are formatted in a way to have the correct number of decimal points. For BHD we need them to have 3 decimal points
val formattedAmount:String = String.format("%.3f", amount)
// Let us format the string that we will hash
val toBeHashed = "x_publickey${publicKey}x_amount${formattedAmount}x_currency${currency}x_transaction${transactionReference}x_post$postUrl"
// let us generate the hash string now using the HMAC SHA256 algorithm
val bytes = mac.doFinal(toBeHashed.toByteArray())
return format(bytes)
}
private fun format(bytes: ByteArray): String {
val formatter = Formatter()
bytes.forEach { formatter.format("%02x", it) }
return formatter.toString()
}
}- Call it as follows:
val hashString:String = TapHmac.generateTapHashString(publicKey, secretKey, amount, currency, postUrl)- Pass it within the operator model
val operator = HashMap<String,Any>()
operator.put("publicKey","publickKeyValue")