CreditIncrementalAuthReqBlock1Type Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

CreditIncrementalAuthReqBlock1Type

All

GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction.

Amt amtTypeGlobal Simple Type

The amount requested for authorization

LodgingData optional ExtraChargesDataType Complex Type

Lodging extra charge indicators; common group of elements that provide additional details specific to lodging transactions that may be required in certain situations as determined by the brands

Note: The field name LodgingData can be confusing in this case as it is actually referring to the lodging extra charges data type.

All

Restaurant optional booleanType Simple Type

Restaurant charge

GiftShop optional booleanType Simple Type

Gift shop charge

MiniBar optional booleanType Simple Type

Mini-bar charge

Telephone optional booleanType Simple Type

Telephone charge

Other optional booleanType Simple Type

Other charge

Laundry optional booleanType Simple Type

Laundry charge

ExtraChargeDetailAmtInfo optional ExtraChargeDetailAmtInfoDataType Complex Type

Defines the individual amounts of extra charges included in the extra charge amount information and the total transaction amount.

ExtraChargesDetailAmountInfo can be used by Asia Pacific merchants only.

All

RestaurantCharges optional amtTypeGlobal Simple Type

Restaurant amount. For Feature Use

GiftShopCharges optional amtTypeGlobal Simple Type

Gift shop amount. For Feature Use

MinibarCharges optional amtTypeGlobal Simple Type

Mini-bar amount. For Feature Use

TelephoneCharges optional amtTypeGlobal Simple Type

Telephone amount. For Feature Use

OtherCharges optional amtTypeGlobal Simple Type

Other amounts. For Feature Use

LaundryCharges optional amtTypeGlobal Simple Type

Laundry amount. For Feature Use

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type

A common group of optional fields that are supported in several different transaction types for Merchant use.

All

Description optional descriptionType Simple Type

Free-form description field. This must not contain sensitive information.

InvoiceNbr optional Restriction of xs:string

Used to log the invoice number on transactions that are not eCommerce.

CustomerID optional customerIDType Simple Type

Used to log Merchant specific customer identification.

Note: For GETI check transactions, this is sent in the CUSTOM3 field.

CardOnFileData optional CardOnFileDataType Complex Type

Card On File Data

For Credit Incremental Auth transactions, this data is used for Exchange-hosted merchants only. For GSAP, GNAP, and AP hosted merchants, the card on file data is obtained from the original Credit Auth being incremented.

All

CardBrandTxnId optional restrictedStringType Simple Type

Network Transaction Identifier

CardOnFile optional CardOnFileType Simple Type

Card On File Indicator

Valid values include:

'C' - Cardholder initiated transaction
'M' - Merchant initiated transaction

CategoryInd optional CategoryIndType Simple Type

Mastercard CIT/MIT indicator subcategory

Valid values include:

01 - Unscheduled Credential-on-file
02 - Standing Order (variable amount and fixed frequency)
03 - Subscription (fixed amount and frequency)
06 - Related/Delayed Charge
07 - No Show Charge
08 - Resubmission

Note: Future use for GSAP-AP merchants

x_global_transaction_id optional x_global_transaction_idType Simple Type

Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be updated.

Note: This is for internal use only.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All

CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

AccountReferenceReq optional accountReferenceReqType Simple Type

Indicates whether Payment Account Reference (PAR) should be returned with the authorization, when available.

Note: Account Reference is supported only for the Exchange and GNAP-UK authorization platforms.

Used By

Block1 Element

Source

<xs:complexType name="CreditIncrementalAuthReqBlock1Type" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="GatewayTxnId" type="txnIdType" default="-1" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Gateway-generated transaction identifier returned in the response of the original transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Amt" type="amtTypeGlobal">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The amount requested for authorization</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="LodgingData" type="ExtraChargesDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Lodging extra charge indicators; common group of elements that provide additional details specific to lodging transactions that may be required in certain situations as determined by the brands</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The field name LodgingData can be confusing in this case as it is actually referring to the lodging extra charges data type.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ExtraChargeDetailAmtInfo" type="ExtraChargeDetailAmtInfoDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Defines the individual amounts of extra charges included in the extra charge amount information and the total transaction amount.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">ExtraChargesDetailAmountInfo can be used by Asia Pacific merchants only.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AdditionalTxnFields" type="AdditionalTxnFieldsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">A common group of optional fields that are supported in several different transaction types for Merchant use.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CardOnFileData" type="CardOnFileDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Card On File Data</p>
          <p xmlns="http://Hps.Exchange.PosGateway">For Credit Incremental Auth transactions, this data is used for Exchange-hosted merchants only.  For GSAP, GNAP, and AP hosted merchants, the card on file data is obtained from the original Credit Auth being incremented.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="x_global_transaction_id" type="x_global_transaction_idType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be updated.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This is for internal use only.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CurrencyConversion" type="CurrConversionDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Data block for Currency Conversion.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Integration must be through GP-API</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AccountReferenceReq" type="accountReferenceReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether Payment Account Reference (PAR) should be returned with the authorization, when available.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Account Reference is supported only for the Exchange and GNAP-UK authorization platforms.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>