Hosted Payment Page Customisation

This page describes features that affect how information is presented to the customer during checkout.

Order Summary Customization

Categorised Order Summary

You can group order items by category in the order summary displayed on the Hosted Payment Page.

When enabled, items are organized into sections based on the category assigned to each item. This provides a clearer breakdown of purchases, especially for orders containing multiple product types.

Enable Categorised Summary

To enable categorised display, set the following field in the Create Order request:

"categorizedOrderSummary": true

Item Requirements

When categorised display is enabled, each item should include a category field.

If no category is provided, the item is displayed in the default list without grouping.

Example Order Summary

"orderSummary": {
  "shipping": {
    "currencyCode": "AED",
    "value": 0
  },
  "tax": {
    "currencyCode": "AED",
    "value": 0
  },
  "total": {
    "currencyCode": "AED",
    "value": 60
  },
  "items": [
    {
      "category": "Category 1",
      "description": "Item 1",
      "quantity": 1,
      "totalPrice": {
        "currencyCode": "AED",
        "value": 20
      }
    },
    {
      "category": "Category 2",
      "description": "Item 2",
      "quantity": 1,
      "totalPrice": {
        "currencyCode": "AED",
        "value": 20
      }
    },
    {
      "category": "Category 1",
      "description": "Item 3",
      "quantity": 1,
      "totalPrice": {
        "currencyCode": "AED",
        "value": 20
      }
    }
  ]
}

Behaviour

• Items are grouped by category on the Hosted Payment Page
• Categories appear as section headings in the order summary
• Totals, tax, and shipping values remain unchanged
• The feature affects display only and does not impact payment processing

Portal-Based Customisation

Some visual elements of the Hosted Payment Page (such as branding messages) are configured in the merchant portal and are not controlled through the API.