|
Sequence
|
MaskedCardNbr optional xs:string
This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.
|
|
CardSwiped xs:string
Indicates whether or not the payment method from the original transaction was swiped
|
|
|
All
|
CardHolderZip optional zipType Simple Type
Zip or postal code; see the associated Type pattern for restrictions.
Note: Canadian postal codes should be sent in the format "A0A0A0".
|
| |
|
ServiceName xs:string
This is the original request type (i.e. CreditSale)
|
|
TxnStatus xs:string
The current transaction status at the time of the search.
These can vary, but some of the key status values include:
- Active - 'A'
- Closed - 'C'
- Voided - 'V'
- Inactive - 'I'
- Reversed - 'R'
|
|
AuthAmt optional amtTypeGlobal Simple Type
The actual authorized amount
Note: This can be different from the original requested amount for partial authorizations.
|
|
SettlementAmt amtTypeGlobal Simple Type
The amount the transaction would settle for if it were closed as part of a batch
Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.
Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.
|
|
ClerkID optional Restriction of xs:string
|
|
RspDT xs:dateTime
Transaction response date time in the time zone conversion requested
|
|
IssTxnId optional xs:string
Issuer transaction identifier
|
|
BatchCloseDT optional xs:dateTime
Batch close date time in the time zone conversion requested. If the transaction is in open batch value is nil.
|
|
AcctDataSrc optional xs:string
Account data source code. This is a derived value that represents the source of the account data received. For example, proximity vs. swiped vs. manual, et al.
|
|
|
All
|
TaxType optional taxTypeType Simple Type
Tax type indicator that qualifies the associated tax amount, see the associated Type enumerations for specific values supported.
|
|
TaxAmt optional amtTypeGlobal Simple Type
Tax amount
Note: If the tax type is 'TaxExempt', an amount should not be provided. If it is, the gateway discards the amount.
|
|
|
All
|
BuyerRecipientName optional Restriction of xs:string
Required on transactions with an amount over 150.
|
|
CustomerRefId Restriction of xs:string
Canadian customer reference Id.
| | | | |
|
|
All
|
LodgingDataEdit optional LodgingDataEditType 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
|
All
|
Duration optional xs:int
Duration of stay in days
The stay Duration range is from 1 to 99.
|
|
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.
|
| |
|
| | |
|
|
All
|
InvoiceNbr optional Restriction of xs:string
Used to log the invoice number on transactions that are not eCommerce.
|
| |
|
|
All
| |
|
|
|
|
|
|
|
|
|
|
All
|
|
All
|
RoutingNumber optional xs:string
Check routing number; manually entered or parsed from MICR data.
|
|
AccountNumber optional Restriction of xs:string
Check account number; manually entered or parsed from MICR data.
|
|
CheckNumber optional xs:string
The physical check number; manually entered or parsed from MICR data.
|
|
MICRData optional Restriction of xs:string
Magnetic ink character recognition (MICR) data obtained from a check reader.
|
|
AccountType optional accountTypeType Simple Type
Indicates the type of account provided; see the associated Type enumerations for specific values supported.
Note: If processing with Colonnade, AccountType must be specified.
| | |
|
|
All
|
CheckName optional xs:string
Business name on check.
Note: If processing with Colonnade, this field is required.
Note: This sets the COMPANY_NAME sent to GETI.
|
|
EmailAddress optional xs:string
Consumer email address
Note: This was for Transmodus only and is no longer used.
|
|
DLState optional xs:string
Consumer driver's license state
Note: This field may be required by GETI based on the terminal configuration.
|
|
DLNumber optional Restriction of xs:string
Consumer driver's license number
Note: This field may be required by GETI based on the terminal configuration.
|
|
CourtesyCard optional Restriction of xs:string
Consumer courtesy card number
|
| |
|
|
| |
|
|
All
|
AIType xs:string
Identifies the attachment type; see Simple Types, attachmentTypeType enumerations for specific values supported.
|
|
AIFormat optional xs:string
Identifies the format of the attachment data; see Simple Types, attachmentFormatType enumerations for specific values supported
| | |
|
|
All
|
GiftMaskedAlias optional Restriction of xs:string
The alias used masked with '*' to only show part of the value
|
| |
|
|
All
|
RecurringDataCode optional xs:string
MasterCard value that may be returned on recurring transactions.
Note: This is returned in the response and should never be used in the request.
| | |
|
|
All
| |
|
FraudRuleInfo optional xs:string
Comma-separated list of strings containing the ID or description of the fraud rule that triggered the fraud decline. Only applies to authorizations that were declined due to fraud.
Note: This is for internal use only.
|
|
RepeatCount optional xs:int
For fraud declines indicates how many times the transaction has been overridden. Max is 1, so essentially, this indicates if the fraud decline result was overridden. Only applies to authorizations that were declined due to fraud.
Note: This is for internal use only.
|
|
HasEMVTag optional xs:string
Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that EMV were sent, 'N' indicates that they were not.
|
|
HasEComPaymentData optional xs:string
Indicates whether or not Secure ECommerce Payment Data was sent on this transaction; 'Y' indicates that it did and 'N' that it did not.
|
|
CAVVResultCode optional xs:string
The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.
|
|
TokenPANLast4 optional xs:string
Last 4 digits of PAN associated with Token. This may be returned by issuer when using SecureECommerce.
|
|
Company optional xs:string
The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.
|
|
CustomerFirstname optional xs:string
The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.
|
|
CustomerLastname optional xs:string
The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.
|
|
DebtRepaymentIndicator optional debtRepaymentType Simple Type
Allows for flagging this transaction as being against a debt obligation. Only use this field with Heartland's explicit direction. This flag is used to identify transactions that might qualify for VISA's Debt Repayment Program special interchange rates.
|
|
|
Sequence
|
Status optional xs:string
Status
|
|
BuyerEmailAddress optional xs:string
The Buyer Email Address associated with the AltPayment at the time the transaction was processed.
|
|
StatusDT optional xs:dateTime
Date and time the status was recorded.
|
|
|
Sequence
|
Code optional xs:string
Code from processor response
|
|
Message optional xs:string
Message from processor response
|
|
Type optional xs:string
Type of processor response
| | | | |
|
|
All
| |
|
|
All
|
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
| | |
|
CardBrandTxnId optional xs:string
The CardBrandTxnId for this transaction.
|
|
SAFData optional SAFDataType Complex Type
Specify if transaction was initiated in "store and forward" (SAF) mode (Y).
If SAFData block is present, SAFIndicator is required.
|
All
|
SAFOrigDT optional xs:dateTime
Date and time when the transaction was originally initiated.
| | |
|
|
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.
|
|
MarkupFee optional Restriction of xs:decimal
The mark up percentage applied to the transaction, resulting in the commission fee.
| | |
|
AccountReference optional xs:string
'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.
Note: Account Reference is supported only for HOST Exchange.
|
|
ProcessedTxnMcc optional mccType Simple Type
The merchant category code (MCC) used in the authorization request; if not provided the default MCC configured for the Device is assumed.
| |