Step 5 -Flutter 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 use the callback event within any payment method to get the response (PaymentSdkTransactionDetails object) then you can handle the transaction details data and start building your business case as shown in the below example:

FlutterPaytabsBridge.startCardPayment(configuration, (event) {
      setState(() {
        if (event["status"] == "success") {
          // Handle transaction details here.
          var transactionDetails = event["data"];
          print(transactionDetails);
          
          if (transactionDetails["isSuccess"]) {
            print("successful transaction");
          } else {
            print("failed transaction");
          }
        } else if (event["status"] == "error") {
          // Handle error here.
        } else if (event["status"] == "event") {
          // Handle events here.
        }
      });
    });

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 (event["status"] == "success")

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 Flutter 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
		email	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
		email	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 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 event:

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

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.