 |
 |
Sequence
 |
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'
|
 |
MaskedCardNbr 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; 'Y' indicates that it was and 'N' that it was not
|
 |
DebitCreditInd xs:string
Indicates if the transaction was a 'D (debit) or 'C' (credit)
|
 |
SaleReturnInd xs:string
Indicates if the transaction was a 'S' (sale) or 'R' (return)
|
 |
ReqACI xs:string
Requested authorization characteristics indicator
|
 |
RspACI xs:string
Response authorization characteristics indicator
|
 |
AcctDataSrc 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.
|
 |
IssTxnId xs:string
Issuer transaction identifier
|
 |
RefNbr xs:string
Retrieval reference number
|
 |
TxnSeqNbr xs:int
Transaction sequence number incremented with each authorization requested by a device
|
 |
AmountIndicator xs:string
Valid values include:
- 'E' indicates that the transaction amount is an estimated amount
- 'F' indicates the transaction amount is the final amount to be charged to the cardholder
|
 |
 |
All
 |
BuyerRecipientName optional Restriction of xs:string
Required on transactions with an amount over 150.
|
| |
 |
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.
|
 |
 |
All
| |
 |
 |
All
 |
InvoiceNbr optional Restriction of xs:string
Used to log the invoice number on transactions that are not eCommerce.
|
| |
 |
 |
All
 |
AttachmentType xs:string
Identifies the attachment types to be returned; see the attachmentTypeType enumerations for specific values supported.
|
 |
AttachmentFormat xs:string
Identifies the format of the attachment data; see the attachmentFormatType enumerations for specific values supported.
|
 |
Height optional xs:int
For image formats, this is the height calculated internally based on the provided data.
|
 |
Width optional xs:int
For image formats, this is the width calculated internally based on the provided data.
|
 |
AttachmentName optional Restriction of xs:string
A merchant-assigned name for the associated attachment
|
| |
 |
 |
All
| |
 |
 |
All
 |
 |
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.
|
| |
 |
| | |
 |
|
 |
|
 |
|
 |
 |
Sequence
 |
 |
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
|
| |
 |
|
 |
 |
Sequence
 |
Type optional xs:string
Indicates type of response information:
- Error
- Decline
- Information
- Warning
- Approve
- Unknown
|
 |
Code optional xs:string
Check processor response code(s); overall single response code or detail response codes separated by a hyphen (-)
|
 |
Message optional xs:string
Message description of the provided code
|
 |
FieldNumber optional xs:string
Field number that is in error
|
 |
FieldName optional xs:string
Field name that is in error
| | |
| |
 |
 |
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
| |
 |
AllowDup optional Restriction of xs:string
|
 |
ProcessorRefNum optional Restriction of xs:string
Reference number returned by processor
|
 |
ReversalIndicator optional Restriction of xs:string
Indicates that this transaction was reversed
|
 |
TokenRequested optional Restriction of xs:string
Indicates that a request for a token was made on this transaction
|
 |
TokenGenerated optional Restriction of xs:string
Indicates that a Token was generated as a result of this transaction
|
 |
EMVTagData optional xs:string
EMV tag data in TLV format.
Note: This field has been obsoleted.See the TagData field for the alternative.
|
 |
EMVIssuerResp optional xs:string
EMV tag data returned by the issuer in TLV format
|
 |
PaymentData optional xs:string
SecureECommerce Payment Data.
|
 |
ECommerceIndicator optional xs:string
Electronic Commerce Indicator when using SecureECommerce.
|
 |
CAVVResultCode optional xs:string
The Visa Cardholder Authentication Verfication Value results code returned by the Issuer when using SecureECommerce.
|
 |
TokenPANLast4 optional xs:string
Last 4 digits of PAN associated with Token returned by the 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 the transaction as being against a debt obligation and applies to Visa and Discover transactions only. The card associations have strict requirements for usage. This flag must not be used without explicit direction from Global Payments.
|
 |
 |
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
 |
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.
| | | |
 |
 |
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.
|
 |
 |
All
 |
PaymentFacilitatorTxnId optional xs:string
Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.
|
 |
PaymentFacilitatorTxnNbr optional xs:string
Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.
| | |
 |
 |
All
 |
Version optional versionType Simple Type
Indicates 3DS version used for authentication.
Valid values include:
- 1 = 3DS 1.x (no longer supported)
- 2 = 3DS 2.2
- 3 = 3DS 2.3 (Future Use)
- 4 = 3DS 2.4 (Future Use)
- 5 = 3DS 2.5 (Future Use)
- 6 = 3DS 2.6 (Future Use)
- 7 = 3DS 2.7 (Future Use)
- 8 = 3DS 2.8 (Future Use)
- 9 = 3DS 2.9 (Future Use)
|
 |
AuthenticationValue optional Extension of authenticationValueType Simple Type
This value is the reference generated by the issuer to recognize that the authentication has taken place. Supported formats are CAVV, AEVV, UCAF. Must be encoded using base16 (Hex encoding) or base64 encoding.
|
 |
ECI eciType Simple Type
Electronic Commerce Indicator shows the value of the result of the authentication.
Note: This value represents UCI for MasterCard.
|
| |
 |
 |
All
 |
Cryptogram optional Extension of cryptogramType Simple Type
Cryptogram received from wallet payment. Supported formats are DSRP, TokenBlocks and TAVV cryptograms. Must be encoded using base16 (Hex encoding) or base64 encoding.
|
 |
ECI optional eciType Simple Type
Electronic Commerce Indicator associated with the Cryptogram. This is an optional field.
|
 |
DigitalPaymentToken optional xs:string
Payment payload used to send encrypted apple or google pay data.
|
| |
 |
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.
|
 |
 |
All
| |
 |
AccountReference optional xs:string
Returned by the issuer in the authorization response when available. It is alphanumeric and may be up to 35 characters, the length of the value may vary by card brand.
Note: Account Reference is supported only for the Exchange and GNAP-UK authorization platforms.
|
 |
ExtendedAuthRsp optional Restriction of xs:string
When ExtendedAuthInd is included in the request, this element returns the result.
Valid values include:
'Y' - indicates the issuer approved the extension; funds will be held for up to 30 days
'N' - indicates the issuer did not approve the extension; funds will be held for the standard period
|
 |
 |
All
 |
TYPointsTxnApprovalId optional Restriction of xs:string
Generated during the point redemption process. Must be present for all Thank You Point requests.
|
 |
CampaignId optional Restriction of xs:string
Identifier for each participating bank. Must be present for all Thank You Point requests.
|
 |
CampaignName optional Restriction of xs:string
Name of the participating bank associated with the Campaign ID.
|
 |
TYPointsMerchantId optional Restriction of xs:string
Thank You Point redemption system internal merchant identifier.
|
 |
ForeignTerminalId optional Restriction of xs:string
Cash register or point of sale ID of the trading partner. Must be present for all Thank You Point requests.
|
 |
TYPointsDischarged optional Restriction of xs:decimal
Points to be redeemed. Two decimals implied. Must be present for all Thank You Point requests.
|
 |
ForeignTicketId optional Restriction of xs:string
Invoice number or unique sales folio of the point of sale. Must be present for all Thank You Point requests.
|
| |
 |
 |
All
 |
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
|
 |
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
|
 |
 |
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
|
 |
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.
|
| |
 |
|
 |
 |
All
 |
BuyerRecipientName optional Restriction of xs:string
Required on transactions with an amount over 150.
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.
| | | | | | |