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.
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.
To perform such, you will need to handle events callback as shown below:
iOS:
Implement the IPaymentCallback interface to handle the payment details & events callback.
public partial class ViewController : IPaymentCallback { [Export("paymentManagerWithDidFinishTransaction:error:")] public void PaymentManagerWithDidFinishTransaction(PaymentTransactionDetails transactionDetails, NSError error) { if (error == null) { string result = "Transaction Details:"; result += "\nResponseCode: " + transactionDetails.PaymentResult.ResponseCode; result += "\nResponseMessage: " + transactionDetails.PaymentResult.ResponseMessage; result += "\nTransactionReference: " + transactionDetails.TransactionReference; if (transactionDetails.Token != null) { result += "\nToken: " + transactionDetails.Token; } Console.WriteLine(result); } else { Console.WriteLine(error.LocalizedDescription); } } [Export("paymentManagerWithDidCancelPayment:")] public void PaymentManagerWithDidCancelPayment(NSError error) { Console.WriteLine("Cancel Event Handled"); } [Export("paymentManagerWithDidStartPaymentTransaction:")] public void PaymentManagerWithDidStartPaymentTransaction(UIViewController rootViewController) { Console.WriteLine("Payment Proccess Started"); } }
If the transaction is not successful you should check for the corresponding failure code you will receive the code in transactionDetails.PaymentResult.ResponseCode .. all codes can be found in Payment Response Codes.
Android:
Implement the ICallbackPaymentInterface interface to handle the payment details & events callback.
public class MainActivity : AppCompatActivity, ICallbackPaymentInterface { public void OnError(PaymentSdkError error) { Console.WriteLine(error.Msg); } public void OnPaymentCancel() { Console.WriteLine("OnPaymentCancel"); } public void OnPaymentFinish(PaymentSdkTransactionDetails paymentSdkTransactionDetails) { Console.WriteLine(paymentSdkTransactionDetails); } }
If the transaction is not successful you should check for the corresponding failure code you will receive the code in ResponseCode .. all codes can be found in Payment Response Codes.
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 Xamarin 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 | 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 | Indicate the message/description of the performed transaction. | ||
transactionTime | String | Indicate the exact time that transaction is completed | ||
paymentInfo | PaymentInfoViewModel 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 | PaymentBillingDetails 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 | PaymentShippingDetails 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. |
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.
⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The Xamarin (Bridge) 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.