Introduction

Before diving into the development process, it's essential to establish the prerequisites and criteria necessary for a successful build. In this step, we'll outline the specific iOS/Android requirements, including the minimum SDK version and other important details you need to consider. Let's ensure your project is set up for success from the very beginning.

Sample Demo

Step 1: Requirements

• We support from iOS 13.0+
• Java version 11
• A minimum Android SDK/API level of 24
• In order to be able to use card scanner functionality, please make sure you added the correct permission key-value in the iOS project info.plist.
  dart

  - <key>NSCameraUsageDescription</key>  
    <string>Card SDK needs it for scanner functionality</string>
  

• in order to accept online payments on your application, you will need to add at least the Internet permission in the manifest file.
  <uses-permission android:name="android.permission.INTERNET" /> //get internet access to complete online payments

📘

Note, for IOS, you do not need to add a permission to access the Internet. And for Android no permission is required to access the Camera!

Step 2: Get Your Public Keys

While you can certainly use the sandbox keys available within our sample app which you can get by following the installation process, however, we highly recommend visiting our onboarding page, there you'll have the opportunity to register your package name and acquire your essential Tap Key for activating Card-Flutter integration. If you will support both iOS and Android, you will need to have two different keys for each app.

🚧

To support both iOS and Android platforms, please contact Tap and share the bundle IDs related to your application, in order to generate separate API keys for each one. This is due to the distinct development environments and requirements for each platform!

Step 3: Installation

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:

card_flutter: 1.0.6

In your library add the following import:

import 'package:card_flutter/card_flutter.dart';

👍

Please note that the 'pod' tool is exclusively utilized for installing dependencies in the iOS project and does not have any relevance to Android.

Step 4: Integrating Card-Flutter

This integration offers two distinct options: a simple integration designed for rapid development and streamlined merchant requirements, and an advanced integration that adds extra features for a more dynamic payment integration experience.

Integration Flow

Noting that in Flutter, you will use our card form like any other widget. While creating, the widget you will also need to pass the parameters & listen to the callbacks based on your needs.

1. You will have to create a variable of type TapCardViewWidget
2. While intialising the widget:
   • Pass the parameters to the widget.
   • Implement the provided interfaces/callbacks
3. Our card widget is a stateful one, depends on stateful variable to generate the token. More to follow.
4. Start tokenizing a card on demand.

Using Code to create the TapCardViewWidget

• Creating the TapCardViewWidget from code

1. Head to your controller where you want to display the TapCardViewWidget as a widget.
2. Import Card-Flutter as follows import 'package:card_flutter/models/models.dart.
3. In the coming code sample, we will show how to embed the card form within your widget tree.

sdkConfiguration: const {}, generateToken: false // More on this later),   

📘

Since our card widget is a stateful one, it will depend on a stateful variable to generate the token.

Simple Integration

Here, you'll discover a comprehensive table featuring the parameters applicable to the simple integration. Additionally, you'll have to follow the configuration code to implement the SDK. Furthermore, you'll gain insights into card tokenization and learn how to receive the callback notifications.

Parameters

Each parameter is linked to the reference section, which provides a more in depth explanation of it.

Configuring the Card-Flutter SDK

While creating the widget as previously mentioned, it is time to pass the parameters needed for the SDK to work as expected and serve your need correctly.

1. Creating the parameters
   To allow flexibility and to ease the integration, your application will only have to pass the parameters as a Dictionary[String:Any].

   First, let us create the required parameters:

   Dart

   Map<String,dynamic> parameters  = {
      "customer":{
         "name":[
            {
               "first":"TAP",
               "middle":"",
               "lang":"en",
               "last":"PAYMENTS"
            }
         ],
         "contact":{
            "email":"[email protected]",
            "phone":{
               "countryCode":"+965",
               "number":"88888888"
            }
         }
      },
      "purpose":"Charge",
      "operator":{
         "publicKey":"pk_test_YhUjg9PNT8oDlKJ1aE2fMRz7"
      },
      "scope":"Token",
      "order":{
         "description":"",
         "currency":"SAR",
         "amount":1.0
      }
   }
    
   

2. Pass these parameters to the TapCardViewWidget widget

   Dart

   TapCardViewWidget(sdkConfiguration: parameters, generateToken: generateToken,) // This generate token is a stateful variable, if set to true token will be generated   
   

Full code snippet for creating the parameters, passing it to the TapCardViewWidget variable and Listening to callbacks

   import 'package:card_flutter/card_flutter.dart';  
   import 'package:flutter/cupertino.dart';  
   import 'package:flutter/material.dart';  
   import 'config_settings_screen.dart';  
  
class CardViewScreen extends StatefulWidget {  
  final Map<String, dynamic> dictionaryMap;  
  
  const CardViewScreen({  
  super.key,  
    required this.dictionaryMap,  
  });  
  
  @override  
  State<CardViewScreen> createState() => _CardViewScreenState();  
}  
  
class _CardViewScreenState extends State<CardViewScreen> {  
  dynamic mCardSDKResponse;  
  
  bool generateToken = false;  
  
  bool showTapTokenButton = false;  
 
  
  @override  
  Widget build(BuildContext context) {  
  return Scaffold(  
       appBar: AppBar(  
       title: const Text('Plugin example app'),  
       leading: IconButton(  
       onPressed: () {  
           Navigator.pushAndRemoveUntil(  
                  context,  
                MaterialPageRoute(  
                  builder: (context) => const ConfigSettingsScreen(),  
                ),  
                (route) => false);  
          },  
          icon: const Icon(  
             CupertinoIcons.back,  
          ),  
        ),  
      ),  
      body: Column(  
        mainAxisSize: MainAxisSize.min,  
        children: [  
          TapCardViewWidget(  
            sdkConfiguration: widget.dictionaryMap,  
            onReady: () {  
              debugPrint("onReady Callback >>>>>");  
  
              setState(() {  
               showTapTokenButton = true;  
              });  
            },  
            onFocus: () {  
              debugPrint("onFocus Callback >>>>>");  
  
              setState(() {  
                generateToken = false;  
              });  
            },  
            onSuccess: (String? success) {  
               setState(() {  
                mCardSDKResponse = success.toString();  
                generateToken = false;  
              });  
            },  
            onValidInput: (String? validInput) {  
               setState(() {  
                mCardSDKResponse = validInput.toString();  
                generateToken = false;  
              });  
            },  
            onHeightChange: (String? heightChange) {  
               setState(() {  
                mCardSDKResponse = heightChange.toString();  
              });  
            },  
            onBinIdentification: (String? bindIdentification) {  
       debugPrint(  
                   "onBinIdentification Callback >>>>> $bindIdentification");  
              setState(() {  
                mCardSDKResponse = bindIdentification.toString();  
              });  
            },  
            onChangeSaveCard: (String? saveCard) {  
             setState(() {  
                  mCardSDKResponse = saveCard.toString();  
              });  
            },  
            onError: (String? error) {  
             setState(() {  
                mCardSDKResponse = error.toString();  
                generateToken = false;  
              });  
            },  
            generateToken: generateToken,  
            cardNumber: "5123450000000008",  
            cardExpiry: "01/39",  
          ),  
          const SizedBox(height: 10),  
          Visibility(  
            visible: showTapTokenButton,  
            child: Padding(  
            padding: const EdgeInsets.symmetric(horizontal: 12),  
              child: FilledButton(  
                  onPressed: () {  
                     setState(() {  
                      generateToken = true;  
                  });  
                },  
                style: FilledButton.styleFrom(  
                fixedSize: Size(  
                      MediaQuery.sizeOf(context).width * 0.96,  
                    50,  
                  ),  
                  shape: RoundedRectangleBorder(  
                      borderRadius: BorderRadius.circular(8),  
                  ),  
                ),  
                onHover: (bool? value) {},  
                child: const Text(  
                    "Get Tap Token",  
                ),  
              ),  
            ),  
          ),  
          const SizedBox(height: 10),  
          Expanded(  
            child: Padding(  
            padding: const EdgeInsets.all(16.0),  
            child: SingleChildScrollView(  
                    child: Text(  
                             mCardSDKResponse == null  
                             ? ""  
                             : "SDK RESPONSE : $mCardSDKResponse",  
                  textAlign: TextAlign.center,  
                  style: const TextStyle(  
                  color: Colors.black,  
                  fontSize: 12,  
                  ),  
                ),  
              ),  
            ),  
          ),  
        ],  
      ),  
    );  
  }  
}

Tokenise the card

📘

A token is like a secret code that stands in for sensitive info, like credit card data. Instead of keeping the actual card info, we use this code. Tokens are hard for anyone to understand if they try to peek, making it a safer way to handle sensitive stuff.

Following the above code sample, once the TapCardViewWidget now has a valid input, you will be able to start the tokenization process by changing the stateful variable generateToken to true as we declared above, which you can find by following Step 5 - Tokenize the card.

Advanced Integration

The advanced configuration for the Card-Flutter integration not only has all the features available in the simple integration but also introduces new capabilities, providing merchants with maximum flexibility. You can find a code below, where you'll discover comprehensive guidance on implementing the advanced flow as well as a complete description of each parameter.

Parameters

Each parameter is linked to the reference section, which provides a more in depth explanation of it.

Initialization of the input

You can use a Map<String,dynamic> to send data to our SDK. The benefit is that you can generate this data from one of your APIs. If we make updates to the configurations, you can update your API, avoiding the need to update your app on the App/Play Store.

{  
  "features": {  
  "customerCards": {  
      "saveCard": true,  
      "autoSaveCard": true  
       },  
  "alternativeCardInputs": {  
      "cardScanner": true,  
      "cardNFC": false,  
      },  
  "acceptanceBadge": true,  
  },  
  "post": const {"url": ""},  
  "customer": {  
  "id": customerIdController.text,  
      "name": const [  
    {  
        "first": "TAP",  
        "middle": "",  
        "lang": "en",  
        "last": "PAYMENTS"  
    }  
  ],  
    "editable": true,  
    "contact": const {  
     "email": "[email protected]",  
        "phone": {  
           "countryCode": "+965",  
           "number": "88888888"  
     }  
  },  
    "nameOnCard": "",  
  },  
  "fieldVisibility": {  
   "card": {  
      "cardHolder": true,  
      "cvv": true,  
    }  
  },  
  "merchant": {"id": ""},  
  "interface": {  
    "colorStyle": "colored",  
    "theme": "light",  
    "locale": "en",  
    "edges": "curved",  
    "cardDirection": "dynamic",  
    "loader": true  
  },  
  "purpose": "Charge",  
  "operator": {  
  "publicKey": "pk_test_YhUjg9PNT8oDlKJ1aE2fMRz7",  
  },  
  "scope": "Token",  
  "order": {  
  "description": "",  
    "currency": "SAR",  
    "amount": 1.0,  
    "id": "",  
    "reference": "",  
    "metadata": const {"a": "abc"}  
  },  
  "acceptance": {  
    "supportedPaymentAuthentications":  
                ["3DS"],  
    "supportedFundSource": ["CREDIT","DEBIT"],  
    "supportedSchemes": [ "AMERICAN_EXPRESS", "MADA", "MASTERCARD", "VISA", "OMANNET"],  
  },  
 },
 },
}   

Receiving Callback Notifications (Advanced Version)

The below will allow the integrators to get notified from events fired from the TapCardViewWidget.

TapCardViewWidget(  
  sdkConfiguration: widget.dictionaryMap,  
  onReady: () {  
  },  
  onFocus: () {  
  },  
  onSuccess: (String? success) {  
  },  
  onValidInput: (String? validInput) {   
  },  
  onHeightChange: (String? heightChange) {  
  },  
  onBinIdentification: (String? bindIdentification) {  
  },  
  onChangeSaveCard: (String? saveCard) {  

  },  
  onError: (String? error) {  
  },  
  generateToken: true,  
  cardNumber: "51234500********",  
  cardExpiry: "01/39",  
),   

Step 5: Tokenize the Card

The Card-Flutter SDK provides a stateful variable, that allows you to instruct it to start the tokenization process on demand or whenever you see convenient, in your logic flow. As a guidance we would only recommend calling this interface after getting onValidInput with data true callback as described above and shown in the code block below.

📘

Tokenize the Card

What is a Token?

A token is like a secret code that stands in for sensitive info, like credit card data. Instead of keeping the actual card info, we use this code. Tokens are hard for anyone to understand if they try to peek, making it a safer way to handle sensitive stuff.

What is Tokenization of a Card?

Card tokenization is like changing your credit card into a secret code. You can use this code safely without showing your actual card info. It's a common practice in payments to keep things secure and prevent your card details from being seen by others.

Why Do I Need to Tokenize a Card?

There are several reasons to tokenize a card:

• Security
  Tokenization helps protect sensitive card data, reducing the risk of data breaches or unauthorized access.
• Compliance
  Many regulations and industry standards, like PCI DSS, require the use of tokenization to safeguard cardholder data.
• Recurring Payments
  Tokens are useful for recurring payments, as they allow you to charge a customer's card without storing their actual card details.
• Convenience
  Tokens simplify payment processing, as you only need to deal with tokens instead of card numbers.

To successfully complete the tokenization process, follow these key steps:

1. Declare a boolean variable in your stateful widget.
2. This variable will be passed to the TapCardViewWidget while initializing as shown below.
3. Whenever you need, change the variable generateToken to true to trigger the tokenization status in the TapCardViewWidget, as displayed in the below code block.

👍

Also, once you correctly trigger the interface, you should expect to hear back from the SDK in one of two callbacks, onSuccess or onError.

Parameters Reference

Below you will find more details about each parameter shared in the above tables that will help you easily integrate Card-Flutter SDK.

operator

1. Definition: It links the payment gateway to your merchant account with Tap, in order to know your business name, logo, etc...
2. Type: Map (required)
3. Fields:
   • publicKey
     Definition: This is a unique public key that you will receive after creating an account with Tap which is considered a reference to identify you as a merchant. You will receive 2 public keys, one for sandbox/testing and another one for production.
     Example:
     Dart

     {"operator": {"publicKey": "pk_test_YhUjg9PNT8oDlKJ1aE2fMRz7"}
     

scope

1. Definition: This is used in order to identify the type of token you want to generate. A token is created in order to save the card details after submitting the form in a more secure way.
2. Type: string (required)
3. Possible Values:

• Token
  Definition: Created before the payment in complete, in order to save the card and do a charge later
  Example:
  String scope = "Token"
• AuthenticatedToken
  Definition: This is a token created and authenticated by the customer. Which means that the customer entered the card information and also passed the Authentication step (3DS) and got the token after.
  Example:
  String scope = "AuthenticatedToken"

purpose

1. Definition: This will identify the reason of choosing the type of token generated in the scope field, like if it will be used for a single transaction, recurring, saving the token, etc...
   Note: Only choose the option that suits your needs best.
2. Type: string (required)
3. Possible Values:

• Charge:
  Definition: In case the token will be used only for a single charge request.
  Example:
  String purpose = "Charge"
• Authorize
  Definition: Perform a hold on the amount. Example: String purpose = "Authorize"
• Save Token:
  Definition:_Save the card to use it afterwards in MITs.
  _Example:
  String purpose = "Save Token""

order

1. Definition: This defined the details of the order that you are trying to purchase, in which you need to specify some details like the id, amount, currency ...
2. Type: Map (required)
3. Fields:

• id
  Definition: Pass the order ID created for the order you are trying to purchase, which will be available in your database.
  Note: This field can be empty
• currency
  Definition: The currency which is linked to the order being paid.
• amount
  Definition: The order amount to be paid by the customer.
  Note: Minimum amount to be added is 0.1.
• description
  Definition: Order details, which defines what the customer is paying for or the description of the service you are providing.
• reference
  Definition: This will be the order reference present in your database in which the paying is being done for.

4. Example:

"order": {  
 "description": "",  
   "currency": "SAR",  
   "amount": 1.0,  
   "id": "",  
   "reference": "",  
   "metadata": const {"a": "abc"}  
 }  

merchant

1. Definition: It is the Merchant id that you get from our onboarding team. This will be used as reference for your account in Tap.
2. Type: Map (required)
3. Fields:

• id
  Definition: Generated once your account with Tap is created, which is unique for every merchant.
  Example:
  dart merchant = {"id":""}

customer

1. Definition: Here, you will collect the information of the customer that is paying using the token generate in the SDK.
2. Type: Map (required)
3. Fields:

• id
  Definition: This is an optional field that you do not have before the token is generated. But, after the token is created once the card details are added, then you will receive the customer ID in the response which can be handled in the onSuccess callback function.

• name
  Definition: Full Name of the customer paying.
  Fields:

  1. lang
     Definition: Language chosen to write the customer name.
  2. first
     Definition: Customer's first name.
  3. middle
     Definition: Customer's middle name.
  4. last
     Definition: Customer's last name.

• editable
  Definition: The customer's name on the card he is paying with, also known as cardholder name.
  Note: It is of type Boolean, and indicated whether or not the customer can edit the cardholder name already entered when the token got created.

• contact
  Definition: The customer's contact information like email address and phone number.
  Note: The contact information has to either have the email address or the phone details of the customers or both but it should not be empty.
  Fields:

  1. email
     Definition: Customer's email address
     Note: The email is of type string.
  2. phone
     Definition: Customer's Phone number details
     1. countryCode
     2. number

• nameOnCard
  Definition: Pre-fill the cardholder name already received once the payment form is submitted.

4. Example:

 "customer": {  
  "id": customerIdController.text,  
      "name": const [  
    {  
        "first": "TAP",  
        "middle": "",  
        "lang": "en",  
        "last": "PAYMENTS"  
    }  
  ],  
    "editable": true,  
    "contact": const {  
     "email": "[email protected]",  
        "phone": {  
           "countryCode": "+965",  
           "number": "88888888"  
     }  
  },  
    "nameOnCard": "",  
  }

features

1. Definition: Additional functionalities to be added in order to make the payment gateway experience more customisable for your needs, like showing the accepted card brands on the payment form, save card toggle button...
2. Type: Map (optional)
3. Fields:

• acceptanceBadge
  Definition: A boolean to indicate wether or not you want to display the list of supported card brands that appear beneath the card form itself.
• customerCards
  Definition: You will have the option to display either the toggle button that allows to save the card or the autosave card.
  Fields:
  1. saveCard
     Definition: A boolean to indicate wether or not you want to display the save card option to the customer.
     Must be used with a combination of these 2 scopes either SaveToken or SaveAuthenticatedToken.
  2. autoSave
     Definition: A boolean to indicate wether or not you want the save card switch to be on by default.
• alternativeCardInput
  Definition: You can also, either add the card information by scanning the card or by using NFC.
  Note: In order for that to work, you will need to add the Camera permission to your manifest file like so
  Fields:
  1. cardScanner
     Definition: A boolean to indicate whether or not you want to display the scan card icon.
     Note: In order for that to work, you will need to add the Camera usage description to your info.plist file like so
     xml <key>NSCameraUsageDescription</key> <string>Card SDK needs it for scanner functionality</string>
     • Fields:
       1.cardScanner
       Definition: A boolean to indicate whether or not you want to display the scan card icon.

1. Example:

   Dart

    "features": {  
     "customerCards": {  
         "saveCard": true,  
         "autoSaveCard": true  
          },  
     "alternativeCardInputs": {  
         "cardScanner": true,  
         "cardNFC": false,  
         },  
     "acceptanceBadge": true,  
     }
   

acceptance

1. Definition: This will help in controlling the supported payment schemes, like MasterCard and Visa, and the fund source either being debit or credit card and you will also be able to check if you want the customers to complete the 3DS phase (Authentication) or not.
2. Type: Dictionary (optional)
3. Fields:

• supportedSchemes
  Definition: A list to control which card schemes the customer can pay with, note that he can choose more than one card scheme.
  Possible Values:
  1. AMERICAN_EXPRESS
  2. VISA
  3. MASTERCARD
  4. MADA
  5. OMANNET
• supportedFundSource
  Definition: A list to control which card types are allowed by your customer.
  Possible Values:
  1. Debit
  2. Credit
• supportedPaymentAuthentications
  Definition: A list of what authentication techniques you want to enforce like 3DS authentication.
  Possible Values:
  1. 3DS

1. Example:
   Dart

   "acceptance": {  
      "supportedPaymentAuthentications":  
                  ["3DS"],  
      "supportedFundSource": ["CREDIT","DEBIT"],  
      "supportedSchemes": [ "AMERICAN_EXPRESS", "MADA", "MASTERCARD", "VISA", "OMANNET"],  
    }
   

fieldVisibility

1. Definition: A boolean to indicate wether or not you want to show/collect the card holder name.
2. Type: Map (optional)
3. Fields:

• card
  1. cardHolder
     Definition: The person that is paying using credit or debit card.
  2. cvv
     Definition: The CVV number of the card.Example:
  Dart

   fieldVisibility = {"card": {"cardHolder": true,"cvv": true,}} 
  

interface

1. Definition: This will help you control the layout (UI) of the payment form, like changing the theme light to dark, the language used (en or ar), ...
2. Type: Map (optional)
3. Fields:

• loader
  Definition: A boolean to indicate wether or not you want to show a loading view on top of the card form while it is performing api requests.
• locale
  Definition: The language of the card form. Accepted values as of now are:
  Possible Values:
  1. en(for english)
  2. ar(for arabic)
• theme
  Definition: The display styling of the card form. Accepted values as of now are:
  Options:
  1. light
  2. dark
  3. dynamic ( follow the device's display style )
• edges
  Definition: Control the edges of the payment form.
  Possible Values:
  1. curved
  2. flat
• cardDirection
  Definition: The layout of the fields (card logo, number, date & CVV) within the card element itself.
  Possible Values:
  1. ltr
     Definition: The fields will inflate from left to right.
  2. rtl
     Definition: The fields will inflate from right to left.
  3. dynamic
     Definition: The fields will inflate in the locale's direction.
• colorStyle
  Definition: How do you want the icons rendered inside the card form.
  Possible Values:
  1. colored
  2. monochrome

1. Example:
   Dart

   "interface": {  
       "colorStyle": "colored",  
       "theme": "light",  
       "locale": "en",  
       "edges": "curved",  
       "cardDirection": "dynamic",  
       "loader": true  
     }   
   

post

1. Definition: Here you can pass the webhook URL you have, in order to receive notifications of the results of each Transaction happening on your application.
2. Type: Map (optional)
3. Fields:

• url
  Definition: The webhook server's URL that you want to receive notifications on.
  Example:
  post = {"url":""} Expected Callbacks Responses
  
  
  
  

Sample Callback Responses

onBindIdentification

"bin": "557607", "bank": "COMMERCIAL INTERNATIONAL BANK (EGYPT) S.A.E.", "card_brand": "MASTERCARD", "card_type": "DEBIT", "card_category": "PLATINUM", "card_scheme": "MASTERCARD", "country": "EG", "address_required": false, "api_version": "V2", "issuer_id": "bnk_TS02A1320232208a5O41810531", "brand": "MASTERCARD"} 

onSuccess

The response here will differ based on the scope:

Token

"id": "tok_4WUP3423199C4Vp18rY9y554", "created": 1697656174554, "object": "token", "live_mode": false, "type": "CARD", "purpose": "Transaction", "source": "CARD-ENCRYPTED", "used": false, "card": {    
"id": "card_U8Wb34231992m7q185g9i558", "object": "card", "address": {},    
"funding": "CREDIT", "fingerprint": "gRkNTnMrJPtVYkFDVU485JtGPdhzQr%2FnmHGhlzLBvuc%3D", "brand": "VISA", "scheme": "VISA", "category": "", "exp_month": 2, "exp_year": 44, "last_four": "4242", "first_six": "424242", "first_eight": "42424242", "name": "AHMED", "issuer": {    
"bank": "", "country": "GB", "id": "bnk_TS05A3420232209Kp2j1810445" }    
 },    
 "save_card": false, "url": ""} 

AuthenticatedToken

"id": "auth_payer_MhIp23231913vYjl18nx94755", "object": "Authenticate", "live_mode": false, "api_version": "V2", "status": "AUTHENTICATED", "created": "1697656409282", "amount": 1, "currency": "KWD", "save_card": false, "provider": {
"name": "MPGS" },
"transaction": {
"timezone": "UTCZ", "created": "1697656409282" },
"response": {
"code": "000", "message": "Authentication Successful" },
"reference": {
"transaction": "tck_LV02G1720231634Xj51824647", "order": "ord_Tlh924231913OouS18vd9O487" },
"customer": {
"id": "", "name": [
{
"first_name": "test", "middle_name": "test", "last_name": "test", "locale": "en" }
],
"name_on_card": "Ahmed", "email": "[email protected]", "phone": {
"country_code": "+20", "number": "1099137777" }
},
"source": {
"id": "tok_RCiU23231913dWqQ18WV9Q18" },
"merchant": {
"id": "1124340" },
"card": {
"first_six": "424242", "scheme": "VISA", "brand": "VISA", "category": "", "last_four": "4242", "name": "AHMED", "expiry": {
"month": "02", "year": "44" },
"funding": "CREDIT" },
"authentication": {
"acsEci": "02", "card_enrolled": "Y", "authenticationToken": "jHyn+7YFi1EUAREAAAAvNUe6Hv8=", "transactionId": "h3q0bQzZNyBueA//+57RcpfPo6s=", "version": "3DS1", "channel": "PAYER_BROWSER", "purpose": "Transaction", "url": "https://authenticate.alpha.tap.company/redirect/auth_payer_MhIp23231913vYjl18nx94755",
"transStatus": "Y", "mode": "C" },
"redirect": {
"url": "" } 
} 

SaveAuthenticatedToken

If the user didn't enable the save token switch, it will be as the previous scope (AuthenticatedToken). Otherwise it will be:

{
  "id": "auth_payer_yhFr59231914mJvN18c79665",
  "object": "Authenticate",
  "live_mode": false,
  "api_version": "V2",
  "status": "AUTHENTICATED",
  "created": "1697656504329",
  "amount": 1,
  "currency": "KWD",
  "save_card": true,
  "provider": {
    "name": "MPGS"
  },
  "transaction": {
    "timezone": "UTCZ",
    "created": "1697656504329"
  },
  "response": {
    "code": "000",
    "message": "Authentication Successful"
  },
  "reference": {
    "transaction": "tck_LV02G1720231634Xj60014708",
    "order": "ord_Zu5d59231914gJa018lJ9b720"
  },
  "customer": {
    "id": "cus_TS01A1520232215Nx3n1810085",
    "name": [
      {
        "first_name": "test",
        "middle_name": "test",
        "last_name": "test",
        "locale": "en"
      }
    ],
    "name_on_card": "Ahmed",
    "email": "[email protected]",
    "phone": {
      "country_code": "+20",
      "number": "1099137777"
    }
  },
  "source": {
    "id": "tok_2AKI58231914GLWn18V69C147"
  },
  "merchant": {
    "id": "1124340"
  },
  "card": {
    "id": "card_rSWi582319149ys718hD9B151",
    "first_six": "424242",
    "scheme": "VISA",
    "brand": "VISA",
    "category": "",
    "last_four": "4242",
    "name": "AHMED",
    "expiry": {
      "month": "04",
      "year": "44"
    },
    "funding": "CREDIT"
  },
  "authentication": {
    "acsEci": "02",
    "card_enrolled": "Y",
    "authenticationToken": "jHyn+7YFi1EUAREAAAAvNUe6Hv8=",
    "transactionId": "FOdR5lit6PaxiidyOxmjSS9z1ls=",
    "version": "3DS1",
    "channel": "PAYER_BROWSER",
    "purpose": "Transaction",
    "url": "https://authenticate.alpha.tap.company/redirect/auth_payer_yhFr59231914mJvN18c79665",
    "transStatus": "Y",
    "mode": "C"
  },
  "payment_agreement": {
    "id": "payment_agreement_NDL3172319152Gck18109189",
    "type": "UNSCHEDULED",
    "contract": {
      "id": "card_rSWi582319149ys718hD9B151",
      "type": "SAVED_CARD"
    }
  },
  "redirect": {
    "url": ""
  }
}