Open the Portico Developer Guide site
PosGateway Schema
FleetDataType Complex Type
PosGateway Schema : FleetDataType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
FleetTaxDetails Element OilCompanyBrandName Element FleetDiscountAmtInfo Element FleetPromptData Element FuelSvcType Element FuelAmtInfo Element FuelQuantity Element FuelUnitOfMeasure Element FuelUnitPrice Element FuelProductCode Element All FleetDataType Complex Type
Overview
All
FuelProductCode optional FuelProductCodeType Simple Type

Three-digit code that identifies the fuel item purchased.

Valid values include: 001-070, 099

FuelUnitPrice optional amtTypeGlobal Simple Type

Unit price for the fuel item purchased.

FuelUnitOfMeasure optional FuelUnitOfMeasureType Simple Type

Unit of measure for the fuel item purchased (can include EV charging).

Valid values include:

  • 1 - Gallons
  • 2 - Liters
  • 3 - Pounds
  • 4 - Kilos
  • 5 - Imperial Gallons
  • 6 - Kilowatt hour
  • 7 - Minutes
  • 8 - Hours
FuelQuantity optional FuelQuantityType Simple Type

Quantity of the fuel item purchased.

FuelAmtInfo optional amtTypeGlobal Simple Type

Fuel amount information; this defines the portion of the total amount provided as part of this request that was specifically for fuel. This is informational only and will not alter the amount processed as part of the transaction. Value must be greater than zero.

FuelSvcType optional FuelSvcType Simple Type

Indicates whether the fuel service is self-service or full service or only non-fuel products were purchased.

Valid values include:

  • 0 - Undefined
  • 1 - Self-service
  • 2 - Full service
  • 3 - Only non-fuel products being purchased
FleetPromptData optional FleetPromptDataType Complex Type

Driver-entered responses to prompts required during a transaction.

All
FleetProductTypeCode optional FleetProductTypeCode Simple Type

Value encoded on the card that drives what information is prompted for at the point of sale.

Valid values include:

  • 1 - Prompts for ID number and odometer reading
  • 2 - Prompts for vehicle number and odometer reading
  • 3 - Prompts for driver number and odometer reading
  • 4 - Prompts for odometer reading only
  • 5 - No prompts issued
VehicleNbr optional VehicleNbrType Simple Type

The Vehicle Number entered by the driver. Required when the FleetProductTypeCode is 2. For Mastercard the maximum value is 6 digits.

DriverIdNbr optional DriverIdNbrType Simple Type

The Driver ID / Driver Number entered by the driver. Required when the FleetProductTypeCode is 1 or 3. For Mastercard the maximum value is 6 digits.

OdometerReading optional OdometerReadingType Simple Type

The Odometer Reading entered by the driver. Required when the FleetProductTypeCode is 1, 2, 3, or 4.

FleetDiscountAmtInfo optional amtTypeGlobal Simple Type

Discount Amount available to the cardholder.

OilCompanyBrandName optional OilCompanyBrandNameType Simple Type

The 4-digit value that identifies the brand or chain name. Required for Mastercard Fleet transactions.

Valid values include: 0500-0523, 9999

FleetTaxDetails optional FleetTaxDetailsType Complex Type

Allows sending Canadian sales tax details for fleet card processing.

All
GSTAmt optional amtTypeGlobal Simple Type

Goods and Services Tax.

HSTAmt optional amtTypeGlobal Simple Type

Harmonized Sales Tax.

PSTAmt optional amtTypeGlobal Simple Type

Provincial Sales Tax.

QSTAmt optional amtTypeGlobal Simple Type

Quebec Sales Tax.

LocalTaxRate optional localTaxRateType Simple Type

Local Tax Rate.

Note: For Visa Fleet Cards only.

BuyerRecipientName optional Restriction of xs:string

Required on transactions with an amount over 150.

Note: For Visa Fleet Cards only.

PSTTaxRegistration optional pstTaxRegistrationType Simple Type

Provincial Sales Tax Registration number.

Note: For Visa Fleet Cards only.

MerchantVATRegistration optional Restriction of xs:string

Merchant Value Added Tax Registration number. Required for Visa processing.

CustomerVATRegistration optional Restriction of xs:string

Customer Value Added Tax Registration number. Required for Visa processing. Valid value should be 18 characters or less.

Used By
FleetData Element
FleetData Element
FleetData Element
FleetData Element
Source
<xs:complexType name="FleetDataType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="FuelProductCode" type="FuelProductCodeType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Three-digit code that identifies the fuel item purchased.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values include: 001-070, 099</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FuelUnitPrice" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Unit price for the fuel item purchased.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FuelUnitOfMeasure" type="FuelUnitOfMeasureType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Unit of measure for the fuel item purchased (can include EV charging).</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values include:</p>
          <ul xmlns="http://Hps.Exchange.PosGateway">
            <li>1 - Gallons</li>
            <li>2 - Liters</li>
            <li>3 - Pounds</li>
            <li>4 - Kilos</li>
            <li>5 - Imperial Gallons</li>
            <li>6 - Kilowatt hour</li>
            <li>7 - Minutes</li>
            <li>8 - Hours</li>
          </ul>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FuelQuantity" type="FuelQuantityType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Quantity of the fuel item purchased.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FuelAmtInfo" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Fuel amount information; this defines the portion of the total amount provided as part of this request that was specifically for fuel. This is informational only and will not alter the amount processed as part of the transaction. Value must be greater than zero.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FuelSvcType" type="FuelSvcType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether the fuel service is self-service or full service or only non-fuel products were purchased.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values include:</p>
          <ul xmlns="http://Hps.Exchange.PosGateway">
            <li>0 - Undefined</li>
            <li>1 - Self-service</li>
            <li>2 - Full service</li>
            <li>3 - Only non-fuel products being purchased</li>
          </ul>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FleetPromptData" type="FleetPromptDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Driver-entered responses to prompts required during a transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FleetDiscountAmtInfo" type="amtTypeGlobal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Discount Amount available to the cardholder.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="OilCompanyBrandName" type="OilCompanyBrandNameType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The 4-digit value that identifies the brand or chain name.  Required for Mastercard Fleet transactions.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Valid values include: 0500-0523, 9999</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FleetTaxDetails" type="FleetTaxDetailsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Allows sending Canadian sales tax details for fleet card processing.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema