Open the Portico Developer Guide site
PosGateway Schema
AutoSubstantiationType Complex Type
PosGateway Schema : AutoSubstantiationType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
RealTimeSubstantiation Element MerchantVerificationValue Element FourthAdditionalAmtInfo Element ThirdAdditionalAmtInfo Element SecondAdditionalAmtInfo Element FirstAdditionalAmtInfo Element All AutoSubstantiationType Complex Type
Overview
All
FirstAdditionalAmtInfo AdditionalAmtType Complex Type

First additional amount information; this defines the portion of the total amount provided as part of this request that was specifically for healthcare charges. This will not alter the amount processed as part of the transaction.

Note: The first additional amount must be of type TOTAL_HEALTHCARE_AMT. This first amount includes the total of the over-the-counter (OTC) charges and any other healthcare additional amounts including prescriptions, vision, clinic, and dental. The total amount of this transaction must be greater than or equal to the total healthcare amount.

All
AmtType amtTypeType Simple Type

The type of healthcare amount; see the associated Type enumerations for specific values supported.

Amt amtTypeGlobal Simple Type

Amount associated with the specified type

SecondAdditionalAmtInfo optional AdditionalAmtType Complex Type

Second additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.

All
AmtType amtTypeType Simple Type

The type of healthcare amount; see the associated Type enumerations for specific values supported.

Amt amtTypeGlobal Simple Type

Amount associated with the specified type

ThirdAdditionalAmtInfo optional AdditionalAmtType Complex Type

Third additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.

All
AmtType amtTypeType Simple Type

The type of healthcare amount; see the associated Type enumerations for specific values supported.

Amt amtTypeGlobal Simple Type

Amount associated with the specified type

FourthAdditionalAmtInfo optional AdditionalAmtType Complex Type

Fourth additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.

All
AmtType amtTypeType Simple Type

The type of healthcare amount; see the associated Type enumerations for specific values supported.

Amt amtTypeGlobal Simple Type

Amount associated with the specified type

MerchantVerificationValue optional xs:string

Merchant Verification Value; 10-character string provided by VISA that indicates participation in the Select Merchant Fee program

Note: This no longer needs to be sent as Heartland will pull this information from the merchant's profile automatically.

RealTimeSubstantiation optional booleanType Simple Type

Indicates if a merchant used an inventory approval system to verify that the items purchased qualify for healthcare auto-substantiation.

Note: This field is required for IIAS participants.

Used By
AutoSubstantiation Element
AutoSubstantiation Element
AutoSubstantiation Element
AutoSubstantiation Element
AutoSubstantiation Element
Source
<xs:complexType name="AutoSubstantiationType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="FirstAdditionalAmtInfo" type="AdditionalAmtType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">First additional amount information; this defines the portion of the total amount provided as part of this request that was specifically for healthcare charges. This will not alter the amount processed as part of the transaction.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The first additional amount must be of type TOTAL_HEALTHCARE_AMT. This first amount includes the total of the over-the-counter (OTC) charges and any other healthcare additional amounts including prescriptions, vision, clinic, and dental. The total amount of this transaction must be greater than or equal to the total healthcare amount.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SecondAdditionalAmtInfo" type="AdditionalAmtType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Second additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ThirdAdditionalAmtInfo" type="AdditionalAmtType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Third additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FourthAdditionalAmtInfo" type="AdditionalAmtType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Fourth additional amount information; this defines the portion of the first additional amount provided as part of this request that was for a specific healthcare amount type. This will not alter the amount processed as part of the transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchantVerificationValue" type="xs:string" default="0000000000" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant Verification Value; 10-character string provided by VISA that indicates participation in the Select Merchant Fee program</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This no longer needs to be sent as Heartland will pull this information from the merchant's profile automatically.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RealTimeSubstantiation" type="booleanType" default="N" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates if a merchant used an inventory approval system to verify that the items purchased qualify for healthcare auto-substantiation.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This field is required for IIAS participants.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema