DebitAddToBatch Element

Description

DebitAddToBatch is used to add a pre-authorized debit transaction to the open batch. If a batch is not open this transaction will create one.

Note: DebitAuth is only allowed in Canada.

For Future Use.

Namespace

http://Hps.Exchange.PosGateway

Type

PosDebitAddToBatchReqType Complex Type

Diagram

Overview

DebitAddToBatch PosDebitAddToBatchReqType Complex Type

DebitAddToBatch is used to add a pre-authorized debit transaction to the open batch. If a batch is not open this transaction will create one.

Note: DebitAuth is only allowed in Canada.

For Future Use.

All

GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates the transaction to be updated.

AccountType optional accountTypeType Simple Type

Indicates the type of account provided; see the associated Type enumerations for specific values supported.

Amt optional amtType Simple Type

If present, this amount replaces the amount to be settled for the original transaction; this includes all other "Info" amounts associated with the original transaction or provided in this request.

DirectMktData optional DirectMktDataType Complex Type

If provided, these fields will replace or add direct marketing data to the original transaction.

All

DirectMktInvoiceNbr directMktInvoiceNbrType Simple Type

Invoice number

Note: The elements in the direct marketing data group are passed on through the settlement process. The invoice field in the AdditionalTxnFields group is not passed on.

DirectMktShipMonth monthType Simple Type

Ship month

DirectMktShipDay dayType Simple Type

Ship day

CashbackAmtInfo optional amtType Simple Type

Cashback amount information; this defines the portion of the total amount provided as part of this request that was specifically for cashback. This is informational only and will not alter the amount processed as part of the transaction.

LodgingDataEdit optional LodgingDataEditType Complex Type

If provided, these fields will replace or add Lodging data edits to the original transaction.

All

FolioNumber optional folioNumberType Simple Type

Lodging system generated value used to group and manage charges during a stay

Duration optional xs:int

Duration of stay in days

The stay Duration range is from 1 to 99.

CheckInDate optional xs:date

Date of check-in

CheckOutDate optional xs:date

Date of check-out

Rate optional amtType Simple Type

Daily room rate

Note: This field is required by AMEX.

ExtraCharges optional ExtraChargesDataType Complex Type

Indicates the types of extra charges included in the extra charge amount information and the total transaction amount

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

ExtraChargeAmtInfo optional amtType Simple Type

Total extra charge amount information; this defines the portion of the total amount provided as part of this request that was specifically for lodging extra charges. This is informational only and will not alter the amount processed as part of the transaction.

MessageAuthenticationCode optional xs:string

A block of encrypted data to be sent from the POS on every contact Interac sale and return request. Required for Canadian merchants processing debit reversals.

PosSequenceNbr optional PosSequenceNbrType Simple Type

POS sequence number for Canadian Debit transactions.

TagData optional TagDataType Complex Type

EMV or Non-EMV tag data in TLV format. For EMV tag data this would consist of the chip card results after applying the Issuer response tags.

All

TagValues optional Extension of xs:string

This field holds the tag data values.

source required Restriction of xs:string

This field specifies the source of the tag data value. It can be either chip or msd.

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.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

Source

<xs:element name="DebitAddToBatch" type="PosDebitAddToBatchReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">DebitAddToBatch is used to add a pre-authorized debit transaction to the open batch. If a batch is not open this transaction will create one.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">
        <b>Note:</b> DebitAuth is only allowed in Canada.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">For Future Use.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>