CreditAddToBatch Element

Description

CreditAddToBatch is primarily used to add a previously approved open authorization (CreditAuth, CreditOfflineAuth, OverrideFraudDecline, or RecurringBillingAuth) to the current open batch. If a batch is not open this transaction will create one. It also provides the opportunity to alter data associated with the transaction (i.e. add a tip amount).

Note: The gateway will not submit an authorization or reversal when the settlement amount of a transaction is altered. The client is responsible for managing these adjustments as needed.

Namespace

http://Hps.Exchange.PosGateway

Type

PosCreditAddToBatchReqType Complex Type

Diagram

Overview

CreditAddToBatch PosCreditAddToBatchReqType Complex Type

Note: The gateway will not submit an authorization or reversal when the settlement amount of a transaction is altered. The client is responsible for managing these adjustments as needed.

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.

Amt optional amtTypeGlobal 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.

GratuityAmtInfo optional amtTypeGlobal Simple Type

If present, this amount is stored with the original transaction. If the original already had gratuity amount information, this will replace it. This defines the portion of the settlement amount that is specifically for gratuity. 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 amtTypeGlobal Simple Type

Daily room rate

Note: This field is required by AMEX.

RoomTax optional amtTypeGlobal Simple Type

Total Room Tax Charges. For Feature Use

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 amtTypeGlobal 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.

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

FleetData optional FleetDataType Complex Type

Fleet Card data.

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.

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.

DirectMktShipMonth monthType Simple Type

Ship month

DirectMktShipDay dayType Simple Type

Ship day

SurchargeAmtInfo optional amtTypeGlobal Simple Type

If present, this amount is stored with the original transaction. If the original already had surcharge amount information, this will replace it. This defines the portion of the settlement amount that is specifically for a surcharge. This is informational only and will not alter the amount processed as part of the transaction.

Note: This field is limited to 8 digits with implied decimal.

EMVTagData optional emvTagDataType Simple Type

EMV tag data in TLV format consisting of the chip card results after applying the Issuer response tags.

Note: This field has been obsoleted.See the TagData field for the alternative.

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.

PFFundingDetails optional PFFundingDetailsType Complex Type

Allows ProPay merchants to specify split funding for a transaction.

All

PFRecAccountNbr Restriction of xs:long

Account number of the merchant who will receive the secondary amount.

PFFundingAmt amtTypeGlobal Simple Type

Amount for which the split transaction has to be performed.

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.

RetryInd optional booleanType Simple Type

Indicates whether this transaction is a retry of the previous CreditAddToBatch request.

Note: This is for the UK market only.

NoShow optional booleanType Simple Type

Indicates that this charge is due to a "no show" on a reservation

Note: This is for the UK and AP markets 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.

Source

<xs:element name="CreditAddToBatch" type="PosCreditAddToBatchReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">CreditAddToBatch is primarily used to add a previously approved open authorization (CreditAuth, CreditOfflineAuth, OverrideFraudDecline, or RecurringBillingAuth) to the current open batch. If a batch is not open this transaction will create one. It also provides the opportunity to alter data associated with the transaction (i.e. add a tip amount).</p>
      <p xmlns="http://Hps.Exchange.PosGateway" />
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong> The gateway will not submit an authorization or reversal when the settlement amount of a transaction is altered. The client is responsible for managing these adjustments as needed.
                          </p>
    </xs:documentation>
  </xs:annotation>
</xs:element>