|
All
|
SiteId xs:int
Site identifier used to process the request.
|
|
MerchName xs:string
Merchant name associated with this site id
|
|
DeviceId xs:int
Device identifier used to process the request.
|
|
ServiceName xs:string
This is the original request type (i.e. CreditSale)
|
|
ReqUtcDT xs:dateTime
Transaction request date time in UTC (Coordinated Universal Time)
|
|
ReqDT xs:dateTime
Transaction request date time in the time zone conversion requested
|
|
RspUtcDT xs:dateTime
Transaction response date time in UTC (Coordinated Universal Time)
|
|
RspDT xs:dateTime
Transaction response date time in the time zone conversion requested
|
|
MerchNbr xs:string
The merchant number (MID) associated with this site id
|
|
TermOrdinal xs:int
Terminal ordinal number associated with this device id
|
|
MerchAddr1 xs:string
Merchant address 1 associated with this site id
|
|
MerchAddr2 xs:string
Merchant address 2 associated with this site id
|
|
MerchCity xs:string
Merchant city associated with this site id
|
|
MerchState xs:string
Merchant state associated with this site id
|
|
MerchZip xs:string
Merchant zip associated with this site id
|
|
MerchPhone xs:string
Merchant phone number associated with this site id
|
|
|
|
|
|
|
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.
|
|
CustomerRefId Restriction of xs:string
Canadian customer reference Id.
| | |
|
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
| |
|
|
|
|
Sequence
| |
|
|
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 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.
|
| |
|
|
All
| |
|
|
All
|
TagValues optional Extension of xs:string
This field holds the tag data values.
| | |
|
|
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
|
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.
|
|
NetworkToken optional cryptogramTypeType Simple Type
FOR FUTURE USE
For use with NetworkToken only. If type is not provided, and a cryptogram is sent, Portico will use the default cryptogram type for the card brand.
| | |
|
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
| | | |
|
|
|
MerchAddr3 optional xs:string
Merchant address 3 associated with this site id
|
|
CrossMidTidInd optional xs:string
Indicates whether the transaction was processed as a Cross MID or Cross TID transaction.
|
|
|
Sequence
|
Choice
|
|
All
|
SummaryCommodityCode optional Restriction of xs:string
Contains the 4-character national standard coding structure for the description of goods.May contain be null or all spaces.
|
|
DiscountAmt optional Restriction of xs:decimal
Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.
If amount value is positive, then value is treated as discount for the invoice.
If amount value is negative, then value is treated as refund discount for the invoice.
|
|
FreightAmt optional Restriction of xs:decimal
Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.
If amount value is positive, then value is treated as positive for the invoice.
If amount value is negative, then value is treated as negative for the invoice.
|
|
DutyAmt optional Restriction of xs:decimal
Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.
If amount value is positive, then value is treated as positive for the invoice.
If amount value is negative, then value is treated as negative for the invoice.
NOTE: Duty may also be called Import Tax, Excise, or Customs Tax.
|
|
ShipFromPostalZipCode optional Restriction of xs:string
Postal code of the location being shipped from. May contain spaces.
|
|
DestinationCountryCode optional Restriction of xs:string
The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces
|
|
InvoiceRefNbr optional Restriction of xs:string
Value Added Tax invoice reference number. May contain spaces.
|
|
OrderDate optional xs:dateTime
Date the order was taken. May be null or contain zeros.
|
|
VATTaxAmtFreight optional Restriction of xs:decimal
Contains any Value Added Tax Amount or Other Sales Tax Amount. This field may be null or contain zeroes if no freight/shipping tax amount was applied.
If amount value is positive, then value is treated as positive for the invoice.
If amount value is negative, then value is treated as negative for the invoice.
|
|
VATTaxRateFreight optional Restriction of xs:decimal
The Tax Rate of the Value Added Tax or Other Sales Tax.
|
|
DiscountTreatment optional Restriction of xs:int
Indicates how the merchant is managing discount.
Valid values:
0 - no invoice level discount provided
1 - tax was calculated on the post-discount invoice total.
2 - tax was calculated on the pre-discount invoice total.
|
|
TaxTreatment optional Restriction of xs:int
Indicates how the merchant is handling taxes
Valid values:
0 - NLL (net prices with tax calculated a line item level)
1 - NIL (net prices with tax calculated at invoice level)
2 - GLL (gross prices given with tax information provided at the line item level)
3 - GIL (gross prices given with tax information provided at invoice level)
4 - NON (no tax applies on the invoice for the transaction)
|
| |
|
|
All
| | | | |
|
|
All
| |
|
|
All
|
SAFOrigDT optional xs:dateTime
Date and time when the transaction was originally initiated.
| | |
|
SDKNameVersion optional
Name and Version of the SDK used for integration, where applicable.
|
|
|
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.
| | |
|
CurrencyCodeAlpha xs:string
Indicates the currency text associated with the CardHolderCurrCode.
|
|
|
All
|
Program optional programType Simple Type
Available to merchants in Asia Pacific, Mexico, and Canada.
For merchants in Canada, use VIS.
Valid values include:
|
|
SIPOptions optional sipOptionsType Simple Type
Available to merchants in Asia Pacific. Required when the Program is SIP
Valid values include:
- 01 - SIPZERO
- 02 - SIPREGULAR
- 03 - SIPMADNESS
|
|
InstallmentPlan optional installmentPlanType Simple Type
Required for merchants in Mexico
Valid values include:
- 00 - No promotion
- 03 - Without interest to the cardholder
- 05 - With interest to the cardholder
- 07 - Buy today, pay later
|
| |
|
IPData optional IPDataBlockType Complex Type
Information regarding Installment Plans associated with the transaction. Currently only returned for Visa Installment Service (VIS).
|
All
| |
|
EUSingleTap optional booleanType Simple Type
This field provides a way for a European merchant to indicate whether a transaction is a Single Tap contactless transaction, or whether the request contains an intentionally duplicated (replayed) ATC value. Applies to MC transactions only. Valid values: Y - SingleTap N - ReplayedATC
|
|
|
All
|
SCAExemptionType SCAExemptionTypeType Simple Type
Eligible exemption to Strong Customer authentication (SCA) for the transaction.
Valid values include:
- 'TrustedMerchant' Trusted merchant exemption claimed/requested.
- 'LowValue' Transaction exemption from SCA as the merchant has determined it to be a low value payment.
- 'SecureCorporatePayment' Transaction exemption from SCA as the merchant has determined it as a SCP.
- 'TxnRiskAnalysis' TRA exemption claimed/requested.
- 'DelegatedAuth' Issuer has delegated SCA.
- 'AuthenticationOutage' Authentication outage
- 'MerchantInitiated' Merchant initiated
- 'RecurringPayment' Recurring payment
Note: Visa Merchant ID is required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication.
|
|
SCAVisaMerchantId optional Restriction of xs:string
Note: Visa Merchant ID for Trusted Merchant and Delegated Authentication exemptions, required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication
| | | |