Request: Card Details (card_details)

Warning

This parameter ONLY working with those integration types (Own Form).

The Card details object is one of the required parameters that you must use exclusively with the Own Form integration. It identifies the customer bank card credentials like card number and the expiration date.


Next, we can delve into the specifics of how to implement the card_details object in your requests.

---

How this parameter could benefit you?

Here are some scenarios to help you understand when to use the Card details feature:

• Direct handling with the customer card details: This will allow you to generate your own payment form to collect the customer bank card details.
  
  

---

Limitations

• You must be PCI certified:
  Own Form Integration Type is suitable for Merchants with a PCI certified to a minimum of SAQ D-Merchant. This is because the card details will be handled by the merchant system.
  You can know more about the PCI DSS merchant requirements for this SAQ D-Merchant level from our What is PCI DSS? and What are the Merchant Requirements? solution article..

---

How to Use?

In order for you to start use the card_details object parameter, you kindly need to follow the below simple steps:

• Within the initiation of the request payload of the payment in Step 3 via ONLY the Own Form integration, you will use the object card_details within the main request payload itself as shown below:
  
  

  {
      "card_details": {
         "pan": "4111111111111111",
         "cvv": "123",
         "expiry_month": 12,
         "expiry_year": 2025
      }
  }


• Once you post your request, you will receive a response that includes the payment_info along with a redirect URL like the following:
  
  

  {
     ...
     "redirect_url": "https://secure.paytabs.com/payment/page/599458B182E5B6B********************B4818688",
     "payment_info": {
             "card_type": "Credit",
             "card_scheme": "Visa",
             "payment_description": "4111 11## #### 1111"
         }
     ....
  }
  
  
• Finally you will need navigate/redirect your customer to the the previous mentioned link as this is crucial for your customer to proceed through the payment 3Ds to authenticate the cardholder. You may need to check the customer experience after in the coming Expected Payment Flow Behavior.

---

Parameter Specifications

• tran_type
  
  No parameters found for manual hpp with filter card_details.

---

Request & Response Payloads Samples

Own Form

The below sample request payload will show you how you can pass the above-mentioned object, which are needed to be passed with valid values to perform a request. Along with the response payload received after using this request payload.

Request Sample Payload

{
    "profile_id": {{profile_id}},
    "tran_type": "sale",
    "tran_class": "ecom",
    "cart_description": "Description of the items/services",
    "cart_id": "Unique order reference00",
    "cart_amount": 25000.2,
    "cart_currency": "SAR",
    "customer_details": {
       "name": "Technical Support",
       "email": "[email protected]",
       "phone": "+966 55 xxxxxx6",
       "street1": "address street",
       "city": "Jeddah",
       "state": "Makkah",
       "country": "SA",
       "ip": "86.111.XXX.X"
    },
    "card_details": {
        "pan": "4111111111111111",
        "cvv": "123",
        "expiry_month": 12,
        "expiry_year": 2022
    }
}

Response Sample Payload

{
    "tran_ref": "TST203360001XXX",
    "tran_type": "Sale",
    "cart_id": "Unique order reference00",
    "cart_description": "Description of the items/services",
    "cart_amount": 25000.2,
    "cart_currency": "SAR",
    "redirect_url": "https://secure.PayTabs.com/payment/page/00C5499B82E406E003415A157D77D5FD9CBCCE3E537AD06E5XXXXX/redirect",
    "customer_details": {
        "name": "first last",
        "email": "[email protected]",
        "phone": "+966 55 xxxxxx6",
        "street1": "address street",
        "city": "Jeddah",
        "state": "Makkah",
        "country": "SA",
        "ip": "86.111.XXX.X"
    },
    "payment_info": {
        "card_type": "Credit",
        "card_scheme": "Visa",
        "payment_description": "4111 11## #### 1111"
    }
}

---

Expected Payment Flow Behavior

Own Form

//TODO