PayTabs SDK makes the integration with the PayTabs payment gateway very easy by providing a ready-made payment screen that handles the card entry and, billing & shipping information and completes the missing details.
This article is dedicated to walking you through how to perform tokenized/recurring transactions using this SDK.
To enable tokenization (for recurring or any other services that depend on auto-detection from the customers instead of saving credit card details), please follow the below instructions:
- Request a token in creating any payment request by passing the "tokeniseType" along with the "tokenFormat" with the preferred type and format that suits your business needs within your PaymentSDKConfiguration, as shown below.
configuration.tokeniseType = cordova.plugins.CordovaPaymentPlugin.TokeniseType.userOptinoal
configuration.tokeniseFormat = cordova.plugins.CordovaPaymentPlugin.TokeniseFromat.hex32To know more about these parameters and what are the available values you can pass please check the "2.3 Cordova SDK | Enums" solution article.
Configure the billing & shipping information for this payment, noting that the shipping information is optional. To know more about this, please check our 3.1 Cordova SDK | Manage Shipping and Billing details and 2.1 Cordova SDK | Configuration Options & Parameters solution articles.
Then create an object from
PaymentSDKConfigurationand fill it out with your credentials and payment details. To know more about what is the exact values that should be passed here, please check our 2.1 Cordova SDK | Configuration Options & Parameters and 2.2 Cordova SDK | The PaymentSdkConfiguration Object solution articles.let configuration = new cordova.plugins.CordovaPaymentPlugin.PaymentSDKConfiguration();
configuration.profileID = "*your profile id*"
configuration.serverKey= "*server key*"
configuration.clientKey = "*client key*"
configuration.cartID = "545454"
configuration.currency = "AED"
configuration.cartDescription = "Flowers"
configuration.merchantCountryCode = "ae"
configuration.merchantName = "Flowers Store"
configuration.amount = 20
configuration.tokeniseType = cordova.plugins.CordovaPaymentPlugin.TokeniseType.userOptinoal
configuration.tokeniseFormat = cordova.plugins.CordovaPaymentPlugin.TokeniseFromat.hex32
configuration.screenTitle = "Pay with Card"
configuration.billingDetails = billingDetails
configuration.forceShippingInfo = false
configuration.tokeniseType = cordova.plugins.CordovaPaymentPlugin.TokeniseType.userOptinoal
configuration.tokeniseFormat = cordova.plugins.CordovaPaymentPlugin.TokeniseFromat.hex32Only then you will be ready to start/initiate the payment by passing your PaymentSDKConfiguration object to the
startCardPaymentfunction in which the callback event will handle/alter the payment response. To know more about this please check our 2.2 Cordova SDK | The PaymentSdkConfiguration Object and Step 5 - Cordova SDK | Handle the payment response solution articles.cordova.plugins.CordovaPaymentPlugin.startCardPayment(configuration, function (result) {
if (result["status"] == "success") {
// Handle transaction details here.
var transactionDetails = result["data"];
console.log("responseCode:" + transactionDetails.paymentResult.responseCode)
console.log("transactionTime:" + transactionDetails.paymentResult.transactionTime)
console.log("responseMessage:" + transactionDetails.paymentResult.responseMessage)
console.log("transactionReference:" + transactionDetails.transactionReference)
console.log("token:" + transactionDetails.token)
} else if (result["status"] == "error") {
// Handle error here the code and message.
} else if (result["status"] == "event") {
// Handle events here.
}
}, function (error) {
console.log(error)
});After this, you will receive the token along with the transaction reference (that generated this token) within the event callback in which you handled the payment response. You will need to save them for future usage.
- To perform any further recurring transaction according to your business needs by repeating steps 2 and 3 from this solution article, then directly start the tokenized card payment via the startTokenizedCardPayment function by passing the PaymentSDKConfiguration object along with the token and the transaction reference (saved from the previous step).
cordova.plugins.CordovaPaymentPlugin.startTokenizedCardPayment(configuration,
"Token",
"TransactionReference",
function (result) {
if (result["status"] == "success") {
// Handle transaction details here.
var transactionDetails = result["data"];
console.log("responseCode:" + transactionDetails.paymentResult.responseCode)
console.log("transactionTime:" + transactionDetails.paymentResult.transactionTime)
console.log("responseMessage:" + transactionDetails.paymentResult.responseMessage)
console.log("transactionReference:" + transactionDetails.transactionReference)
console.log("token:" + transactionDetails.token)
} else if (result["status"] == "error") {
// Handle error here the code and message.
} else if (result["status"] == "event") {
// Handle events here.
}
}, function (error) {
console.log(error)
});
⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The Cordova SDK Integration Manual" solution article.
⇦ And to navigate to the previous step in the integration process "Step 2 - Configure the integration method" click here.
⇦ And to get familiar with the rest of the steps regarding the current step "Step 3 - Initiating the payment" click here.
⇨ Or you can navigate to the next step in the integration process "Step 4 - Accepting the payment" kindly click here.