Step 5 - Native Android SDK | Handle the payment response : PayTabs Support Portal

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 handle the payment response after performing it. Handling the response right will prevent your application from crashing on any unhandled response status or any missing case.

To perform such, you will need to navigate to your "CallbackPaymentInterface" inherited activity/fragment instance and start building your business case as shown in the below example:

override fun onError(error: PaymentSdkError) {
          // Implement according to your business needs
}

override fun onPaymentFinish(PaymentSdkTransactionDetails: PaymentSdkTransactionDetails) {
         // Use the checkers here according to your business needs
}

override fun onPaymentCancel() {
             // Implement according to your business needs
}

As you may be noticed in the example, within the delegate, you will override our event handlers' functions to handle the payment response accordingly:

onPaymentFinish()
OnError()
onPaymentCancel()

It is important that you MUST validate that the response you received from our end in the below PaymentSdkTransactionDetails object is genuine by comparing it to the order/cart details stored already on your server-side in order to ensure that the original data that has been sent through the Mobile Application (client-side) has not been manipulated/intercepted.

onPaymentFinish()

Via this event handler, you will handle the payment response. Through the PaymentSdkTransactionDetails object, you will receive the PayTabs response that should be handled from your side according to your business needs depending on the sent information/parameters as clarified below:

override fun onPaymentFinish(PaymentSdkTransactionDetails: PaymentSdkTransactionDetails)

PaymentSdkTransactionDetails Properties

Property	Data Type	Usage
token	String	The sent token for the tokenized payment requests. This field is required for creating tokenized (recurring) transactions. To know more, please check our sss solution article.
transactionReference	String	The unique key for the transaction generated by the PayTabs. This field is required for creating tokenized (recurring) transactions.
transactionType	String	The identification of the type of transaction. To know more about these types, please check our What is the "tran_type" (transaction type)? solution article. To know more about the only types that are supported in this SDK, please check our 2.3 Native IOS SDK \| Enums solution article. The default passed value is ".sale".
cartID	String	Indicates the cart/order id at the merchant end to easily relate the transaction to
cartDescription	String	Indicates the cart/order description at the merchant end to easily relate the transaction to.
cartCurrency	String	Indicates the transaction currency, which the customer will be charged with. Noting that this currency must be configured first on your PayTabs account to accept payment with.
cartAmount	String	Indicates the amount of this transaction the customer is about to be charged.
paymentResult	PaymentSDK.PaymentResultViewModel Object	responseStatus	String	Indicates the status of the performed transaction, which will be one from the list clarified in our What is: Response_code vs the Response_status? solution article.
		responseCode	String	Indicates the code of the performed transaction, which will be one from the list clarified in our What is: Response_code vs the Response_status? solution article.
		responseMessage	String
		transactionTime	String
		acquirerMessage	String
		acquirerRRN	String
paymentInfo	PaymentSDK.PaymentInfoViewModel Object	cardType	String
		cardScheme	String
		paymentDescription	String
billingDetails	PaymentSDK.PaymentSDKBillingDetails Object	name	String
		email	String
		phone	String
		addressLine	String
		city	String
		state	String
		countryCode	String
		zip	String
shippingDetails	PaymentSDK.PaymentSDKShippingDetails Object	name	String
		email	String
		phone	String
		addressLine	String
		city	String
		state	String
		countryCode	String
		zip	String

We also provide within the same PaymentSdkTransactionDetails object multiple checkers that can assist you through your system/business flow, as shown below, which highly recommend using them to handle the response in the PaymentManagerDelegate class:

isAuthorized()
isPending()
isOnHold()
isSuccess()
isProcessed()

It worth mentionting, that all the responses and statuses the following checkers relies on are the official supported one listed in our What is: Response_code vs the Response_status? solution article.

isAuthorized()

This function aims to check for you whether the payment status is "A", which indicates that the payment is successfully operated, authenticated, and registered on your PayTabs dashboard for both PayTabs and the acquirer bank/processor.

if the transaction is not successful then you will have to check for the corresponding failure code which you will receive in the transactionDetails?.paymentResult?.responseCode attribute.