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 function is depreciated and will be removed from the new SDK version in November 2024. For more details and workaround, please check out our solution article, Deprecated Payment via (SDK Saved Card)'s Workaround



This article is dedicated to walking you through how to initiate the payment/request payload using the configuration options and parameters that have already been clarified in the previous step, "Step 2 - Configure the integration method".


After making sure of configuring this SDK as you wish, you will need to import the SDK package classes in your code first to start, as shown below: 


import 'paytabs-ionic-native';
import { PaymentSDKBillingDetails, PaymentSDKShippingDetails, PaymentSDKConfiguration, PayTabsIonic } from 'paytabs-ionic-native';
import 'paytabs-ionic-native';import { PaymentSDKBillingDetails, PaymentSDKShippingDetails, PaymentSDKConfiguration, PayTabsIonic } from 'paytabs-ionic-native';
Generic


Implementing this option will enable you to initiate payments targeted to be paid using the supported types of credit cards such as Visa, MasterCard, Amex, .. etc. Furthermore, your SDK will save the card on your behalf to show it in a list of saved cards for any further payments. To be able to do this, please follow the below instructions: 


  1. Make sure you import PaymentSDKConfiguration class.

  2. 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 Ionic SDK | Manage Shipping and Billing details and 2.1 Ionic SDK | Configuration Options & Parameters solution articles. 
            
    let billingDetails: PaymentSDKBillingDetails = {
              name: 'John Smith',
              email: 'email@domain.com',
              phone: '+201111111111',
              addressLine: 'Address line',
              city: 'Dubai',
              state: 'Dubai',
              countryCode: 'AE',  //country ISO two characters code
              zip: '1234'
      };
    
      const shippingDetails: PaymentSDKShippingDetails = {
              name: 'John Smith',
              email: 'email@domain.com',
              phone: '+201111111111',
              addressLine: 'Address line',
              city: 'Dubai',
              state: 'Dubai',
              countryCode: 'AE',  //country ISO two characters code
              zip: '1234'
      };
    Generic



  3. Then create an object from PaymentSDKConfiguration and 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 Ionic SDK | Configuration Options & Parameters and 2.2 Ionic SDK | The PaymentSDKConfiguration Object solution articles.
    let configuration: PaymentSDKConfiguration = {
              profileID: '*profile ID*',
              serverKey: '*server key*',
              clientKey: '*client key*',
              cartID: '12345',
              currency: 'USD',
              cartDescription: 'Flowers',
              merchantCountryCode: 'ae',
              merchantName: 'Flowers Store',
              amount: 20,
              screenTitle:'Pay with Card',
              billingDetails,
              shippingDetails,
      };
    Generic



  4. Only then you will be ready to start/initiate the payment with the previously saved card by passing your PaymentSDKConfiguration object to the startPaymentWithSavedCards function  in which you await until the promise (returned response object) is settled to handle/alter the payment response. To know more about this please check our 2.2 Ionic SDK | The PaymentSDKConfiguration Object and Step 5 - Ionic SDK | Handle the payment response solution articles.
                    
    //note that the await should be used inside an async function or at the top level of a module
    
    const result = await PayTabsIonic.startPaymentWithSavedCards(configuration, support3DsBoolean);
    
     this.handleResult(result);
          handleResult(result: any) {
              if (result.status == 'success') {
                // Handle transaction details here.
                const 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 the error here with the code and message.
              } else if (result.status == 'event') {
                // Handle events here.
              }
            }
    Generic


    Only cards that has been saved through this startPaymentWithSavedCards function will be shown in the list.


    This would make the payment behavior like the one below, in which once your customers choose one of the saved cards, the payment will be performed directly if the support3DsBoolean was false or will be directed to the 3DS phase if it is true.










⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The Ionic 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.