MCType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

MCType

All

DiscountAmt optional Restriction of xs:decimal

Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.

If amount value is positive, then value is treated as discount for the invoice.

If amount value is negative, then value is treated as refund discount for the invoice.

FreightAmt optional Restriction of xs:decimal

Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

DutyAmt optional Restriction of xs:decimal

Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

DestinationPostalZipCode optional Restriction of xs:string

Postal code of destination location. May contain spaces.

ShipFromPostalZipCode optional Restriction of xs:string

Postal code of the location being shipped from. May contain spaces.

DestinationCountryCode optional Restriction of xs:string

The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces

InvoiceRefNbr optional Restriction of xs:string

Card Acceptor Reference Number.

Visa: Value Added Tax invoice reference number. May contain spaces.

For Mastercard: Card Acceptor Reference Number.

OrderDate optional xs:dateTime

Indicates date the purchase was made in YYMMDD format.

DestinationStateProvinceCode optional Restriction of xs:string

The state / province code for the location to which goods are being shipped

LineItems

Sequence 0..∞

LineItemDetail MCLineItemsType Complex Type

Sequence

ItemDescription optional Restriction of xs:string

Description of the good or service being supplied.

ProductCode optional Restriction of xs:string

Identifies the product being purchased, for example, an inventory number or UPC code. A value other than spaces or zeros should be provided.

Quantity Restriction of xs:decimal

The number of units of the product being purchased. Must be numeric and greater than zero.

ItemTotalAmt Restriction of xs:decimal

Contains the total amount of the line item; calculated as unit cost multiplied by quantity, less discount.

For Mastercard only, the item total amount may be zero.

UnitOfMeasure optional Restriction of xs:string

Contains the code indicating the unit of measure (gallons, etc.).

UnitCost optional Restriction of xs:decimal

The cost per unit of measure.

DiscountAmt optional Restriction of xs:decimal

Contains any discount on this line item.

ItemDiscountRate optional Restriction of xs:decimal

The discount rate applied to the item.

ZeroCostInd optional zeroCostIndReqType Simple Type

Indicates whether a line item was provided at zero cost.

Y - The line item is at zero cost to the customer. The item total item amount may be equal to zero.

N - The line item is not at zero cost to the customer. The item total amount may not be equal to zero.

ItemCommodityCode optional Restriction of xs:string

The national standard description code of the good or service being supplied.

HSTAmt optional amtTypeGlobal Simple Type

Harmonized Sales Tax.

HSTRate optional Restriction of xs:decimal

Harmonized Sales Tax Rate.

GSTAmt optional amtTypeGlobal Simple Type

Goods and Services Tax.

GSTRate optional Restriction of xs:decimal

Goods and Services Tax Rate.

PSTAmt optional amtTypeGlobal Simple Type

Provincial Sales Tax.

PSTRate optional Restriction of xs:decimal

Provincial Sales Tax Rate.

QSTAmt optional amtTypeGlobal Simple Type

Quebec Sales Tax.

QSTRate optional Restriction of xs:decimal

Quebec Sales Tax Rate.

Used By

MC Element

Source

<xs:complexType name="MCType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="DiscountAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as discount for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as refund discount for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="FreightAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as positive for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as negative for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DutyAmt" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is positive, then value is treated as positive for the invoice.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If amount value is negative, then value is treated as negative for the invoice.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:decimal">
          <xs:fractionDigits value="2" />
          <xs:totalDigits value="12" />
          <xs:minExclusive value="-10000000000" />
          <xs:maxExclusive value="10000000000" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DestinationPostalZipCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Postal code of destination location. May contain spaces.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="10" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="ShipFromPostalZipCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Postal code of the location being shipped from. May contain spaces.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="10" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="DestinationCountryCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="3" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="InvoiceRefNbr" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Card Acceptor Reference Number.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Visa: Value Added Tax invoice reference number. May contain spaces.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">For Mastercard:  Card Acceptor Reference Number.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="25" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="OrderDate" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates date the purchase was made in YYMMDD format.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="DestinationStateProvinceCode" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The state / province code for the location to which goods are being shipped</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:pattern value="^[a-zA-Z0-9 ]*$" />
          <xs:maxLength value="3" />
        </xs:restriction>
      </xs:simpleType>
    </xs:element>
    <xs:element name="LineItems">
      <xs:complexType>
        <xs:sequence minOccurs="0" maxOccurs="unbounded">
          <xs:element name="LineItemDetail" type="MCLineItemsType" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:all>
</xs:complexType>