Welcome to Zuora Product Documentation

Explore our rich library of product information

Level 2 and Level 3 data processing on the custom payment gateway integration

This guide explains how to enable Level 2 and Level 3 data processing on the UPC Token Gateway, including field mappings, constraints, and configuration requirements for custom fields in Zuora.

The Universal Payment Connector (UPC) service provides you the flexibility to submit Level 2 and Level 3 data. This information might result in lower interchange rates on eligible commercial, corporate, and purchasing cards. You need to manage the additional Level 2 and Level 3 parameters to evaluate whether the gateway can accept them and decide whether to include them in the request.

This article provides instructions on enabling the support for submitting Level 2 and Level 3 data through the UPC Token Gateway integration. It also describes the field mappings and constraints.

Prerequisites

In Zuora, configure the following custom fields:

  • On the Product Rate Plan Charge object, configure the following custom fields:

    • CommodityCode

    • ProductCode

  • On the Account object, configure the ShipFromPostalCode custom field.

When configuring a payment gateway instance, the API names (without "__c") of these custom fields are required to enable Level 2 and Level 3 data processing.

For more information about custom fields, see Custom object definitions.

Enable Level 2 and Level 3 data submission

To enable the support for sending Level 2 card data, Level 3 card data, or both through the UPC Token Gateway instance, configure the following settings on the configuration page of the UPC Token Gateway instance:

  • Enable Level 2 Processing : If you want to enable Level 2 card data processing, select this checkbox.

  • Enable Level 3 Processing : If you want to enable Level 3 card data processing, select this checkbox.

  • ShipFrom Postal Code Custom Field API Name : To send the shipFromPostalCode field to the gateway, enter the API name of the ShipFromPostalCode custom field without the __c suffix.

  • ProductCode Custom Field API Name : To send the ProductCode field to the gateway, enter the API name of the ProductCode custom field without the __c suffix.

  • CommodityCode Custom Field API Name : To send the CommodityCode field to the gateway, enter the API name of the CommodityCode custom field without the __c suffix.

For more information about configuring the UPC Token Gateway instance, see Set up a custom payment gateway .

Example of JSON structure for UPC Level 2 and Level 3 data

{
    "shipToCity": "Test City",
    "shipToAddressLine1": "Test Address Line 1",
    "shipToAddressLine2": "Test Address Line 2",
    "shipToStateProvinceCode": "California",
    "shipToPostalCode": "95016",
    "shipToCountryCode": "USA",
    "shipFromPostalCode": "1234567",
    "totalTaxAmount": "16.936803668",
    "lineItems": [
        {
            "quantity": "10",
            "unitPrice": "1000",
            "totalAmount": 11095,
            "discountAmount": "0",
            "unitOfMeasure": "Eac",
            "productCode": "TestPCode",
            "commodityCode": "SampleCCode",
            "taxAmount": "1095",
            "taxRate": "0.11",
            "discountIndicator": "N",
            "discountRate": "0",
            "taxCode": "Test",
            "grossNetIndicator": "Y"
        },
        {
            "quantity": "1",
            "unitPrice": "1000",
            "totalAmount": 1000,
            "discountAmount": "100",
            "productCode": "TestPCode",
            "commodityCode": "SampleCCode",
            "description": "Test Rate Plan Description",
            "taxAmount": "0",
            "taxRate": "0",
            "discountIndicator": "Y",
            "discountRate": "0.1",
            "taxCode": "null",
            "grossNetIndicator": "N"
        }
    ],
    "freightAmount": 0,
    "discountAmount": "0.8336807",
    "orderDate": "211124",
    "dutyAmount": 0
}