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 use the then() method within any payment method to get the response result (PaymentSdkTransaction object) then. The first parameter passed to the then function will be the handler if the transaction has operated, and the other parameter will be the function where you will handle the error.
You can handle the transaction details data and start building your business case as shown below. If the transaction is not successful, you should check for the corresponding failure code you will receive the code in responseCode:
RNPaymentSDKLibrary.startCardPayment(JSON.stringify(configuration)).then( result => { if(result["PaymentDetails"] != null) { // Handle transaction details let paymentDetails = result["PaymentDetails"] console.log(paymentDetails) } else if(result["Event"] == "CancelPayment") { // Handle events console.log("Cancel Payment Event") } }, function(error) { // Handle error console.log(error) });
You can use result["PaymentDetails"] to ensure a successful transaction.
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.
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.
if (result["PaymentDetails"] != null)
In this case, this means that your payment has been finished successfully, and you received a response from PayTabs. The next step for you is to 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:
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 React Native 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 | PaymentSdkPaymentResult 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 | Indicate the message/description of the performed transaction. | ||
transactionTime | String | Indicate the exact time that transaction is completed | ||
paymentInfo | PaymentSdkPaymentInfo Object | cardType | String | Indicates the card type (Credit, Debit, etc) |
cardScheme | String | Indicates the card Scheme (Visa, MasterCard, etc) | ||
paymentDescription | String | Indicates the card mask ("4000 00## #### 0002") | ||
billingDetails | PaymentSdkBillingDetails Object | name | String | Indicates the customer's/cardholder's valid name |
String | Indicates the customer's valid email address. Preferred not to pass the same email with every transaction, as blocking any for a fraud attempt will cause blocking your payments at all. | |||
phone | String | Indicates the customer's valid phone number | ||
addressLine | String | Indicates the customer's valid address | ||
city | String | Indicates the customer's valid city name. | ||
state | String | Indicates the customer's valid state name. Should be ISO 3166-1 alpha-2 code (two-letter state codes) | ||
countryCode | String | Indicates the customer's valid state name. Should be ISO 3166-1 alpha-2 code (two-letter state codes) | ||
zip | String | Indicates the customer's valid zip code. | ||
shippingDetails | PaymentSdkShippingDetails Object | name | String | Indicates the customer's valid name |
String | Indicates the customer's valid email address. | |||
phone | String | Indicates the customer's valid phone number | ||
addressLine | String | Indicates the customer's valid address | ||
city | String | Indicates the customer's valid city name. | ||
state | String | Indicates the customer's valid state name. Should be ISO 3166-1 alpha-2 code (two-letter state codes) | ||
countryCode | String | Indicates the customer's valid state name. Should be ISO 3166-1 alpha-2 code (two-letter state codes) | ||
zip | String | Indicates the customer's valid zip code. |
We also provide within the same PaymentSdkTransactions 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 event:
isAuthorized()
This 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.
It acts as like as shown below:
event["data"]["isAuthorized"]
isPending()
This aims to check for you whether the payment status is "P", which indicates that the payment is successfully operated and registered on your PayTabs dashboard. However, its status on the acquirer bank/processor is pending. For example, cash payment, such as exists in the Aman payment method, will be marked as pending until the customer pays the transaction at one of the Aman machines.
It acts as like as shown below:
event["data"]["isPending"]
isOnHold()
This aims to check for you whether the payment status is "H", which indicates that the payment is successfully operated/authenticated and registered on your PayTabs dashboard. However, its status on the acquirer bank/processor is on hold. For example, refunds that are operated manually by the Knet team will be marked as on hold.
It acts as like as shown below:
event["data"]["isOnHold"]
isSuccess()
This aims to check for you whether the payment has been performed successfully, which means its status will be either "H", "P", or "A", which indicates that the payment is successfully operated/authenticated and registered on your PayTabs dashboard accordingly to each status clarification.
It acts as like as shown below:
event["data"]["isSuccess"]
isProcessed()
This aims to check for you whether the payment has been processed in the first place or not. In some very rare cases, the acquirer bank/protocol doesn't immediately initiate the payment due to several reasons (such as an internal server error on their side), which lead that the transaction itself will be authenticated and registered a while after performing it (up to several hours in some cases), in this case, and as PayTabs didn't receive the response from the acquirer, the object will be returned with null.
In such cases, you will be notified once the transaction registered on the dashboard ONLY if you configured an IPN, to know more about how to handle IPNs please check our How to configure Instant payment notification (IPN)? solution article.
It acts as like as shown below:
event["data"]["isProcessed"]
if (result["Event"] == "CancelPayment")
In this case, this means that the customer has canceled your payment reuest. You may handle the case according to your business needs, as shown below:
if(result["Event"] == "CancelPayment") { // Handle events console.log("Cancel Payment Event") }
Function(error)
Via this event handler function, you will handle your sent request only if the payment doesn't exceed the validation.
}, function(error) { // Handle error console.log(error) });
⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The React Native SDK Integration Manual" solution article.
⇦ And to navigate to the previous step in the integration process "Step 4 - Accepting the payment" kindly click here
⇨ Or you can navigate to the next step in the integration process " Step 6 - Handle the post-payment responses (notifications)" kindly click here.