Request/Response Parameters | Cart Amount (cart_amount)

Modified on Wed, Jan 4, 2023 at 6:10 PM

This article is not available in Arabic, view it in English

Paytabs provides you with a collection of API endpoints which used to process all payments, regardless of if they are through either your own payment pages, the managed payment pages, or if you are using the hosted payment pages.

This article is dedicated to the clarification of the Cart Amount (cart_amount) parameter. "cart_amount" is one of the mandatory parameters that the request should have, which Indicates the amount the customer is about to charge.

Specifications

The Parameter Tag/Name	cart_amount
JSON Example	{ "cart_amount": 500 }
Data Type	DECIMAL
Required	✔
Validation Rules	Both min and max values are subjected to the merchant transaction limits
Min Length	0.01
Max Length	9999999999.99

Usage Workflow

Along with the required parameters mentioned in our Step 3 - PT2 API Endpoints | Initiating the payment solution article, you will need to set the "cart_amount" as shown below:

You can notice that the passed "cart_amount" parameter is already included within the response object.

Sample Request Payload

{
    "profile_id": "987654",
    "tran_type": "sale",
    "tran_class": "ecom",
    "cart_id": "CART#1001",
    "cart_currency": "USD",

    "cart_amount": 500,

    "cart_description": "Description of the items/services",
}

Sample Response Payload

{
    "tran_ref": "TST2231101374414",
    "tran_type": "Sale",
    "cart_id": "CART#1001",
    "cart_description": "Description of the items/services",
    "cart_currency": "USD",

    "cart_amount": "500.00",

    "redirect_url": "https://secure-egypt.paytabs.com/payment/page/599B792482E5A2AB2A3E8373265BA2963700A06113BC510285887ED7",
    "serviceId": 2,
    "profileId": 987654,
    "merchantId": 123456,
    "trace": "PMNT0404.6368BC3D.000BAF4C"
}