Field Reference

This reference applies to Reporting.

This section includes report field names and descriptions for downloadable reports and card-present transactions, and field names with compound values.

Advanced Fraud Screen (AFS) Fields

Field Name	Description
`Factors`	Information that affected score of the order.
`HostSeverity`	Risk associated with customer's email domain.
`InfoCodeString`	List of information codes triggered by the order.
`IPAddress`	Customer’s IP address.
`IPCountry`	Name of the country decoded from IP address.
`IPRoutingMethod`	Routing method decoded from IP address.
`IPState`	Name of the state decoded from IP address.
`Model`	Name of score model used for the transaction.
`Score`	Total score calculated for the order.

Application Fields

Field Name	Description
`Name`	Name of application used.
`Rcode`	One-digit code indicating whether the entire request was successful.
`ReasonCode`	—
`Rflag`	One-word description of the result of the entire request.
`Rmsg`	Message that explains the `ics_rflag` value.

Authorization Results Fields

Field Name	Description
`AVSResult`	Optional results of address verification test.
`CVVResult`	Optional results of card verification number test.

Bank Information Fields

Field Name	Description
`Address`	Bank's address.
`BranchCode`	Code that identifies the branch of the customer's bank when you are not using the IBAN.
`City`	City in which the bank is located.
`Country`	Country in which the bank is located.
`Name`	Bank's name.
`SwiftCode`	Bank's SWIFT code. Unique address of the bank. Also known as the Bank Identification Code (BIC).

Batch Fields

Field Name	Description
`BatchDate`	Date when the batch was sent to the processor.
`BatchID`	Identifier for the batch in which the transaction was sent.
`Status`	Status of batch file.
`SuccessFlag`	Indicates whether batch file processing was successful.

Billable Transaction Details Fields

M = Mandatory, O = Optional.

Field Name	Description	Required/Optional
`Currency`	The ISO currency code used in the transaction.	M
`Merchant Reference Number`	The order reference or tracking number generated by the merchant.	M
`Organization ID`	The transacting MID value assigned by Cybersource or .	M
`PartnerSolutionID`	The identifier assigned to a partner and included in all requests from the partner solution.	O
`Payment Processor`	The name of the payment processor.	O
`Product Code`	The product code for the transaction.	M
`Product Description`	The product description for the transaction.	M
`Quantity`	The quantity of the service requested.	M
`Reason Code`	The three-digit status code per application.	O
`Requested Amount`	The amount used in the transaction.	M
`Request ID`	The unique identification number generated by Cybersource or to identify the submitted request.	M
`Rmsg`	The text result description per application.	O
`Service Name`	The name of the service being requested as identified in Cybersource or .	M
`Transaction Date`	The date of the transaction. Format: `YYYY-MM-DD HH:MM:SS`	M

Bill To Fields

Field Name	Description
`Address1`	First line of the billing street address as it appears on the credit card issuer’s records.
`Address2`	Additional address information.
`City`	City of the billing address.
`CompanyName`	Name of the customer’s company.
`CompanyTaxID`	Tax identification number of customer's company.
`Country`	Country of the billing address.
`CustomerID`	Merchant-assigned identifier for the customer.
`Email`	Customer’s email address, including the full domain name.
`FirstName`	First name of the billed customer.
`HostName`	DNS resolved hostname from `billTo_ipAddress`.
`IPAddress`	Customer’s IP address.
`LastName`	Last name of the billed customer.
`MiddleName`	Middle name of the billed customer.
`NameSuffix`	Suffix of billed customer.
`Phone`	Customer’s phone number.
`State`	State or province of the billing address.
`Title`	Title of the billed customer.
`UserName`	Customer's user name.
`Zip`	Zip/Postal code for the billing address. The postal code must consist of 5 to 9 digits.

Card-Present Fields

The fields in this table are available in the Transaction Request only for card-present transactions.

Field Name	Description
`Device.DeviceID`	Value created by the client software that uniquely identifies the POS device. This value is provided by the client software that is installed on the POS terminal. This value is not sent to the processor but is used for reporting purposes.
`PaymentData.AcquirerMerchantNumber`	Identifier that was assigned to you by your acquirer. This value must be printed on the receipt.
`PaymentData.CardPresent`	Indicates whether the card is present at the time of the transaction. Possible values: `N`: Card is not present. `Y`: Card is present.
`PaymentData.CardVerificationMethod`	Method that was used to verify the cardholder's identity. Possible values: `0`: No verification `1`: Signature `2`: PIN.
`PaymentData.EMVRequest Fallback`	Indicates that a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:Swipe the card or key the credit card information into the POS terminal.Use the `pos_entryMode` field to indicate whether the information was swiped or keyed.Possible values: `true`: Fallback method was used. `false` (default): Fallback method was not used.
`PaymentData.IssuerResponseCode`	Additional authorization code that must be printed on the receipt when returned by the processor. This value is generated by the processor and is returned only for a successful transaction.This field is supported only on SIX.
`PaymentData.PinType`	Method that was used to verify the cardholder's identity. Possible values: `0`: No verification `1`: Signature `2`: PIN This field is supported only on American Express Direct, OmniPay Direct, and SIX.
`PaymentData.POSCatLevel`	Type of cardholder-activated terminal. Possible values: `1`: Automated dispensing machine `2`: Self-service terminal `3`: Limited amount terminal `4`: In-flight commerce (IFC) terminal `5`: Radio frequency device `6`: Mobile acceptance terminal `7`: Electronic cash register `8`: E-commerce device at your location `9`: Terminal or cash register that uses a dial-up connection to the transaction processing network Chase Paymentech Solutions Only values `1`, `2`, and `3` are supported. FDC Nashville Global Only values `7`, `8`, and `9` are supported. GPN Only values `6`, `7`, `8`, and `9` are supported. TSYS Acquiring Solutions Only value `6` is supported.
`PaymentData.POSEntryMode`	Method of entering credit card information into the POS terminal. Possible values: `contact`: Read from direct contact with chip card. `contactless`: Read from a contactless interface using chip data. `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct or SIX. `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. `swiped`: Read from credit card magnetic stripe.The `contact`, `contactless`, and `msd` values are supported only for Europay, Mastercard, and Visa (EMV) transactions.
`PaymentData.POSEnvironment`	Operating environment. Possible values: `0`: No terminal used, or unknown environment. `1`: On merchant premises, attended. 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions. `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions. `5`: On premises of cardholder, unattended. `9`: Unknown delivery mode. `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the Internet. `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by courier.For Mastercard transactions, the only valid values are `2` and `4`.
`PaymentData.RoutingNetworkType`	—
`PaymentData.StoreAndForwardIndicator`	When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. This value is not sent to the processor but is used for reporting purposes. Possible values: `true` / `false`.
`PaymentData.TerminalIDAlternate`	Identifier for an alternate terminal at your retail location. You define the value for this field.This field is supported only for Mastercard transactions on FDC Nashville Global. Use the `pos_terminalID` field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this `pos_terminalIDAlternate` field to identify the terminal used for the transaction.This value is neither verified nor modified before it is passed to the processor.
`Request.PartnerOriginalTransactionID`	Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal's software and to . Therefore, you can use this value to reconcile transactions between and the terminal's software.This value is not sent to the processor but is used for reporting purposes.This field is supported only on American Express Direct and SIX.
`Request.PartnerSDKVersion`	Version of the software installed on the POS terminal. This value is provided by the client software that is installed on the POS terminal.This value is not sent to the processor but is used for reporting purposes.This field is supported only on American Express Direct and SIX.
`Request.TerminalSerialNumber`	Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal.This value is not sent to the processor but is used for reporting purposes.This field is supported only on American Express Direct and SIX.

Case Management Fields

Field Name	Description
`ActiveNumberOfRules`	Indicates the number of rules in use in the profile.
`ActiveProfileDecision`	Decision of active profile.
`ActiveProfileName`	Name of the active profile.
`ActiveProfileScore`	Score of the active profile.
`ActiveRuleDecision`	Summarizes the active rule decision.
`ActiveRuleName`	Name of active rule as it appears in Profile Editor.
`ActiveRuleScore`	Score of the active rules.
`OwnerOrganization`	Organization name of the reviewer assigned to the order.
`OwnerUsername`	Specific reviewer assigned to the order.
`PassiveNumberOfRules`	Indicates the number of rules in use in the profile.
`PassiveProfileDecision`	Decision of passive profile.
`PassiveProfileName`	Name of the passive profile.
`PassiveProfileScore`	Score of the passive profile.
`PassiveRuleDecision`	Summarizes the passive rule decision.
`PassiveRuleName`	Name of passive rule as it appears in Profile Editor.
`PassiveRuleScore`	Score of the passive rules.
`Priority`	Degree of importance assigned to the order.
`Queue`	Order queue selected.
`ReviewDate`	Date and time of final decision.
`ReviewDecision`	Summarizes final outcome for the order.
`ReviewNotes`	Comments made by reviewer about the order.

Chargeback and Retrieval Fields

Field Name	Description
`AdjustmentAmount`	Amount of the `chargeback` adjustment.
`AdjustmentCurrency`	Currency of the `chargeback` adjustment.
`AdjustmentARN`	Association reference number.
`CaseIdentifier`	Numerical identifier created to represent a unique `chargeback`, representment, or other exception.
`CaseNumber`	Processor-assigned case number.
`CaseTime`	The date that the case was opened.
`CaseType`	Description of the case type.
`ChargebackAmount`	Amount of the chargeback.
`ChargebackCurrency`	Chargeback currency code.
`ChargebackMessage`	Text message from the issuer explaining the reason for the chargeback or other exception.
`ChargebackReasonCode`	Association chargeback reason code.
`ChargebackReasonCodeDescription`	Text description of the reason code.
`ChargebackTime`	The date that the chargeback was originated by the issuing bank.
`DocumentIndicator`	Indicates whether or not there are associated documents. Possible values: `Y`, `N`
`FeeAmount`	Amount of the chargeback exception fee.
`FeeCurrency`	Currency code for the chargeback exception fee.
`FinancialImpact`	Indicates whether or not there is a financial impact. Possible values: `Y`, `N`
`FinancialImpactType`	Debit, credit, or none.
`MerchantCategoryCode`	Four-digit number that the `payment card industry` uses to classify merchants into market segments.
`PartialIndicator`	Flag indicating whether the transaction is enabled for partial chargeback.
`ResolutionTime`	Resolution time in UTC.
`ResolvedToIndicator`	Indicates resolved to status of transaction. Possible values: `B`: Bank `M`: Merchant `S`: Split `G`: General ledger
`RespondByDate`	Date by which item must be submitted to the chargeback processor to allow sufficient time for representment.
`TransactionType`	Capture type of the original transaction.

Check Fields

Field Name	Description
`BankTransitNumber`	Bank routing number.
`AccountEncoderID`	Identifier for the bank that provided the customer’s encoded account number.
`SecCode`	Authorization method used for the transaction.

Conversion Fields

Field Name	Description
`ConversionDate`	Date order converted.
`NewDecision`	Reviewer evaluation result.
`OriginalDecision`	Order profile evaluation result.
`Profile`	Order profile used to evaluate the order.
`Reviewer`	Person who evaluated order originally marked for review.
`ReviewerComments`	Additional information added by reviewer.
`Queue`	Review queue originally assigned to order.

Customer Fields

Field Name	Description
`BillingAddress1`	First line of billing street address as it appears on credit card issuer’s records.
`BillingAddress2`	Additional address information.
`BillingCity`	Billing address city.
`BillingCompanyName`	Customer's company name.
`BillingCountry`	Billing address country.
`BillingEmail`	Customer's email address.
`BillingFirstName`	First name of the billed customer.
`BillingLastName`	Last name of the billed customer.
`BillingPhone`	Customer's phone number.
`BillingPostalCode`	Billing address postal code.
`BillingState`	Billing address state or province.
`CustomerID`	Merchant-assigned identifier for the customer.
`ShippingAddress1`	First line of the shipping address.
`ShippingAddress2`	Second line of the shipping address.
`ShippingCity`	Shipping address city.
`ShippingCompanyName`	Recipient's company name.
`ShippingCountry`	Shipping address country.
`ShippingFirstName`	First name of the recipient.
`ShippingLastName`	Last name of the recipient.
`ShippingPhone`	Recipient's phone number.
`ShippingPostalCode`	Shipping address postal code.
`ShippingState`	Shipping address state or province.

Deposit Fields

Field Name	Description
`Amount`	Amount of the deposit.
`Category`	Category of the deposit.
`Currency`	Currency code of the deposit.
`ExchangeRate`	Exchange rate. Includes a decimal point and up to 4 decimal places.
`ExchangeRateDescription`	Exchange rate description from the funding bank.
`Identifier`	Unique reference number for this deposit.
`MerchantBankAcctLast4`	Bank account number to which the funds transfer will be deposited. For security purposes, all but the last 4 digits are masked.
`MerchantBankAcctName`	Name used on the bank account.
`MerchantBankCode`	Routing number for the account to which the funds transfer will be deposited.
`MerchantBankCountry`	Country in which the bank is located. Two-character ISO Standard Country Codes.
`MerchantBankName`	Bank's name.
`MerchantID`	Merchant ID.
`Method`	Funds transfer method.
`Status`	Status of the deposit. Possible values: `S`: Success, `P`: Pending, `F`: Failed
`Time`	Deposit time for the transaction in UTC.
`TransferMessage`	Deposit transfer message provided by the processor.
`Type`	Description of events included in this funds transfer.

Device Fields

Field Name	Description
`DeviceID`	Identification number of device used for transaction.

Device Fingerprint Fields

Field Name	Description
`BrowserLanguage`	Comma-separated list of languages preferred or supported by the browser.
`CookiesEnabled`	Indicates if cookies are enabled in customer's browser.
`DeviceFirstSeen`	Date when the device was first encountered.
`DeviceLatitude`	Latitude of the GPS location of the device.
`DeviceLongitude`	Longitude of the GPS location of the device.
`DeviceMatched`	Longitude of the GPS location of the mobile device.
`Fingerprint/DeviceFingerprint`	Unique ID of a computer or other device.
`FlashEnabled`	Indicates if Flash is enabled in customer's browser.
`FlashOperatingSystem`	Device operating system as reported by Flash.
`FlashVersion`	Version of Flash installed on the device.
`GPSAccuracy`	Indicates the accuracy of the GPS location of the mobile device.
`ImagesEnabled`	Indicates if images are enabled in customer's browser.
`Jailbreak/RootPrivileges`	Indicates if a mobile device has root privileges.
`Jailbreak/RootReason`	Additional information describing elements on mobile device that triggered escalation to root privileges.
`JavaScriptEnabled`	Indicates if JavaScript is enabled in customer's browser.
`ProfiledURL`	URL of profiled page.
`ProfilingDate/Time`	Time of device profiling.
`ProfilingDuration/RequestDuration`	Total time in milliseconds to process the profiling request.
`ProxyIPAddress`	IP address of proxy if available.
`ProxyIPAddressActivities`	Actions associated with the proxy IP address.
`ProxyIPAddressAttributes`	Characteristics associated with the proxy IP address.
`ProxyServerType`	Type of proxy server based on the HTTP header.
`ScreenResolution`	Screen resolution of the device.
`SmartID`	Device identifier generated from attributes collected during profiling.
`SmartIDConfidenceLevel`	Probability that the Smart ID is correctly identifying a returning device.
`TimeOnPage`	Time period in milliseconds that device profiling page displays on browser before it closes or user navigates away from the page.
`TrueIPAddress`	Customer’s true IP address detected by the application.
`TrueIPAddressActivities`	Actions associated with the true IP address.
`TrueIPAddressAttributes`	Characteristics associated with the true IP address.
`TrueIPAddressCity`	City associated with the true IP address.
`TrueIPAddressCountry`	Country associated with the true IP address.
`TypeofBrowserAgent`	Indicates if a mobile device or a computer was used to initiate the session.

Emailage Fields

Field Name	Description
`CompanyName`	Name of company to which the email belongs.
`DomainCategory`	The category type for company's email domain.
`DomainCompany`	Domain of company to which the email belongs.
`DomainCorporate`	Indicates if domain is registered to a business.
`DomainCountryCode`	Domain of country code to which the email belongs.
`DomainCreationDate`	Creation date of the domain.
`DomainCreationDate-DaysOld`	Number of days since email domain was created.
`DomainExists`	Verifies if the email domain exists.
`DomainName`	The email address domain name.
`DomainRisk`	Provides risk level for the domain.
`EmailCreationDate`	Creation date of the email.
`EmailCreationDate-DaysOld`	Number of days since email account was created.
`EmailExists`	Verifies if email address exists.
`EmailFirstSeenDate`	The oldest time stamp found for records associated with email address.
`EmailFirstSeenDate-DaysOld`	Number of days since email was first seen.
`EmailLocation`	Location of the person who owns email address.
`EmailNameMatch`	Indicates status of the name of the customer matching the email owner.
`EmailOwnerName`	Name of the person who owns the email address.
`EmailageReason`	Provides information relevant to understanding the Emailage Risk Score.
`EmailageReasonDescription`	Provides information relevant to understanding the Emailage Risk Score.
`EmailageRecommendation`	Recommendation based on results of other Emailage fields.
`EmailageRiskBand`	Indicates the number associated with certain Emailage Score ranges.
`EmailageScore`	Proprietary algorithm that calculates the fraud risk associated with an email address.
`FraudType`	If multiple companies within the Emailage system marked the queried value as fraud, this field provides the most recent fraud type.
`Gender`	Gender of the person who owns the email address.
`IP Postal`	Postal code associated with the IP address.
`IPAnonymousProxy`	Indicates if the user's IP address is an anonymous proxy.
`IPCity`	For U.S., city where the IP is located.
`IPCountry`	Name of the country associated with the IP.
`IPRegion`	For U.S., state where the IP is located.
`IPReputation`	Reputation of the proxy, indicates the likelihood that the user's IP address is an open proxy.
`IPRiskLevel`	Provides the fraud risk for the IP Address.
`LastConfirmationDate`	The last date the email address was queried in the Emailage system.
`PhoneSyntaxValidation`	Indicates if the phone syntax is valid.
`SMLinks`	Count of social media sites that match the queried email.
`SocialMediaFriends`	Total friends for the email owner located on social media sites.
`SourceIndustry`	If `FraudType` contains a value, this field provides the industry of the most recent company to mark the email as fraud or legitimate.
`Title`	Title of the email owner.
`Totalhits`	Number of times the email address was queried in the Emailage system in a 7 day period.
`Uniquehits`	Number of unique companies that queried the email address in the Emailage system in a 7 day period.

Event Fields

Field Name	Description
`Amount`	Amount for the event.
`CurrencyCode`	Currency code for the event.
`Event`	Type of event that occurred for the transaction.
`EventDate`	Date in GMT format that the event occurred. This field can be null for some event types, such as Declined.
`ProcessorMessage`	Additional information from the processor about the event, such as an error message or explanation.

Exception Fields

Field Name	Description
`Action`	Brief description of the action.
`ClientID`	—
`CYBSExceptionID`	Assigned exception ID number.
`DccLookupStatus`	—
`DccExchangeRate`	—
`DccMarginRate`	—
`ExceptionAmount`	Amount specified in the exception.
`ExceptionAmountCurrency`	Exception currency represented in ISO 4217:2008 alpha-3.
`ExceptionCategory`	Type of exception.
`ExceptionDate`	Date of exception.
`ExceptionDescription`	—
`ExceptionDeviceHardwareRevision`	—
`ExceptionDeviceID`	—
`ExceptionDeviceOS`	—
`ExceptionDeviceOSVersion`	—
`ExceptionDeviceTerminalID`	—
`ExceptionMessage`	Description of the exception.
`ExceptionReasonCode`	Reason code for the error that occurred. This reason code is the same one that you receive in the response or transaction receipt.
`ExceptionReasonDescription`	Description of exception reason.
`ExceptionStatus`	Current status of the transaction.
`ExceptionStatusCode`	—
`ExceptionType`	Type of exception.
`FinancialStatus`	Financial status of the transaction.
`LastActionDate`	Date of last action on the transaction.
`LocalCurrencyCode`	Local currency code.
`NextActionDate`	Date of next action on the transaction.
`OriginalTransactionSubmissionDate`	Date on which the transaction was submitted.
`PartnerMerchantID`	—
`PartnerMerchantName`	—
`PaymentNumber`	Payment number.
`ProcessorCaseID`	Processor-assigned case number.
`ProcessorResponseCode`	Code returned directly from the processor for the exception that occurred.
`ReasonCode`	Reason code for the exception that occurred.
`RetryCount`	Total number of payments that are pending in retry mode.
`SchemeOperator`	—
`SDKVersion`	—
`SettlementProcessor`	Name of settlement processor.
`StorageMechanism`	—

Fee Fields

Field Name	Description
`AcquirerInterchangeAmount`	—
`AssessmentAmount`	Amount of the assessment.
`AssessmentCurrency`	Currency of the assessment.
`BillingCycle`	Billing cycle of the merchant. Possible values: `daily`, `weekly`, `monthly`
`BillingType`	Billing type of the merchant. Possible values: `discount`, `interchangePlus`, `serviceFee`, `other`
`ClearedInterchangeLevel`	Code for the clearing level.
`ConversionFee`	Fee amount added for currency conversion.
`ConversionFeeCurrency`	—
`DiscountAmount`	`DiscountRate` *`TransactionAmount`. This value includes 4 decimal points.
`DiscountCurrency`	Currency of the discount.
`DiscountRate`	Discount rate.
`DowngradeReasonCode`	Reason for downgrade. Possible values: `1`: Transaction exceeded timeliness. `2`: Authorization code is missing. `8`: POS entry mode does not qualify. `9`: POS condition code does not qualify. `A`: POS terminal capability does not qualify. `D`: Mail/phone/e-commerce indicator does not qualify. `K`: Transaction cleared as intraregional. `L`: Transaction cleared as interregional. `R`: Reclassification. `U`: UK domestic. `V`: German domestic. `W`: Transaction cleared as world signia. `X`: Did not qualify at merchant price level.
`ExchangeRate`	—
`GrossInterchangeAmount`	—
`InterchangeAmount`	Final amount of transaction after the interchange rates are applied.
`InterchangeCurrency`	ISO currency code for the currency of the clearing rate.
`InterchangeRate`	Interchange rate for the transaction.
`IssuerInterchangeAmount`	—
`MerchantID`	—
`OtherInterchangeAmount`	—
`PerItemFeeAmount`	Fee for a single item.
`PerItemFeeCurrency`	Currency for a single item fee.
`PricedInterchangeLevel`	Interchange flat rate that was assigned when you set up your account. This value includes 4 decimal points.
`ReimbursementFee`	—
`ReimbursementFeeDebitCreditIndicator`	—
`ServiceFeeAmount`	Amount of service fee for transaction.
`ServiceFeeAmountCcy`	Currency of the service fee.
`ServiceFeeFixedAmount`	Amount of the fixed service fee for the transaction.
`ServiceFeeFixedAmountCcy`	Currency of the fixed service fee.
`ServiceFeeRate`	Percentage rate of the service fee.
`SettlementAmount`	Amount of the settlement.
`SettlementCurrency`	Currency of the settlement.
`SettlementTime`	Time the settlement was processed.
`SettlementTimeZone`	Time zone of the settlement.
`SourceDescriptor`	—
`TotalFeeAmount`	Total amount of all fee transactions for the specified date range.
`TotalFeeCurrency`	Currency for all fee transactions for the specified date range.
`TransactionIntegrityFee`	—
`TransactionIntegrityFeeDebitCreditIndicator`	—

Fee Summary Fields

Field Name	Description
`CardType`	Card type.
`Count`	Count.
`FeeDescription`	Fee description.
`FeeType`	Fee type.
`FundingCurrency`	Currency in which fees applied.
`PaymentMethod`	Payment method used.
`PercentageFee`	Percentage fee.
`PerItemFee`	Fee charged per item.
`TotalFeeAmount`	Total fee amount.
`TransactionAmount`	Transaction amount.
`TransactionType`	Transaction type.

Funding Fields

Field Name	Description
`CurrencyExchangeDescription`	Exchange rate description from the processor.
`CurrencyExchangeRate`	Exchange rate for converting from transaction currency to funding currency.
`FeeAmount`	Fee for the transaction.
`FeeCurrency`	Fee currency represented in ISO 4217:2008 alpha-3.
`FeeDescription`	Fee description from the processor.
`FundingAccountSuffix`	Last 4 digits of funding account.
`FundingAmount`	Funding amount of the transaction.
`FundingBankCode`	Bank code of the funding bank.
`FundingBankCountry`	Bank country of the funding bank represented in ISO 3166-1 alpha-3.
`FundingBankName`	Name of bank funding the transaction.
`FundingCurrency`	Funding currency represented in ISO 4217:2008 alpha-3.
`FundingDate`	Funding date of the transaction.
`FundingIdentificationNumber`	Funding identification for the funding of the transaction.
`FundingProcessorMessage`	Funding response message from the processor.
`FundingTransferMessage`	Funding transfer message provided by the processor.
`ProcessorResponseCode`	Funding response code from the processor.
`Status`	Funding status. Possible values: `S` (success), `P` (pending), `F` (failed)

Fund Transfer Fields

Field Name	Description
`BankCheckDigit`	Code used to validate the customer's account number.
`IbanIndicator`	International Bank Account Number (IBAN).

Gift Card Fields

Field Name	Description
`CurrentBalance`	Current gift card balance in your local currency.
`PreviousBalance`	Previous gift card balance in your local currency. This value was the gift card balance before the concurrent transaction was applied to the gift card. This field is supported only on ValueLink. For example, when a customer purchases a gift card and uses the gift card to purchase a product at the same time, the response message includes: Previous gift card balance, which was the balance before the purchase of the product Current gift card balance, which is the balance after the purchase of the product
`RedemptionType`	Type of redemption. Possible values: `CASHOUT` `REDEMPTION` `REDEMPTION_ PARTIAL_ ALLOWED` (default) This field is supported only on ValueLink.

Healthcare Fields

Field Name	Description
`Amount`	Amount of the healthcare payment.
`AmountType`	Type of healthcare payment. For example: `healthcare`, `dental`, `clinic`
`Currency`	Currency used in transaction.
`IndustryType`	Type of industry for the transaction.

Invoice Fields

Field Name	Definition
`BillingGroupDescription`	Description of the billing group.
`NotProcessed`	Number of unprocessed transactions.
`OrganizationID`	Merchant ID.
`PerformedServices`	ICS service name.
`Processed`	Number of processed transactions.
`Total`	Invoice count.

JP Fields

Field Name	Description
`Amount`	Transaction grand total.
`AuthForward`	Name of Japanese acquirer that processed transaction. Available only for CCS (CAFIS) and JCN Gateway.
`AuthorizationCode`	Transaction authorization code.
`CardSuffix`	Last four digits of card.
`Currency`	Currency used in transaction.
`CustomerFirstName`	Customer first name.
`CustomerLastName`	Customer last name.
`Date`	Date of transaction.
`Gateway`	Name of gateway used to process transaction.
`JPOInstallmentMethod`	Number of payment installments (Japanese payment method only).
`JPOPaymentMethod`	Type of Japanese payment method used.
`MerchantID`	Gateway merchant identifier.
`MerchantReferenceNumber`	Merchant order reference or tracking number.
`NetworkTokenTransType`	Network token transaction type.
`PaymentMethod`	Method of payment.
`RequestID`	Client request identifier.
`SubscriptionID`	Customer profile identifier for requested service.
`Time`	Time of transaction.
`TransactionReferenceNumber`	Reference number used to reconcile gateway reports with processor reports.
`TransactionType`	Type of transaction.

Line Item Fields

Field Name	Description
`FulfillmentType`	Information about the product code used for the line item.
`InvoiceNumber`	Invoice number for order.
`MerchantProductSku`	Identification code for the product.
`Number`	Number of the line item in an order.
`ProductCode`	Used to determine product category: electronic, handling, physical, service, or shipping.
`ProductName`	Name of product.
`Quantity`	Quantity of product.
`TaxAmount`	Total tax to apply to the product.
`UnitPrice`	Per-item price of the product.

Mark As Suspect Fields

Field Name	Description
`MarkingDate`	Date the order was marked.
`MarkingNotes`	Notes about the customer or the order.
`MarkingReason`	Selected reason for marking the order.
`MarkingUserName`	Identity of the user marking the order.

Merchant Defined Data Fields

Field Name	Description
`MerchantDefinedData_field1`	Fields that you can use to store information (Field1 - Field20).

Life Cycle Management Event Fields

Field names in this group are prepended with LifeCycleManagementEvent.

Field Name	Description
`LCMEventDateProcessed`	Date that the Life-Cycle Management event was fully processed.
`LCMEventStatus`	Processing status of the Life-Cycle Management event.
`LCMEventStatusText`	Free-formatted text field detailing the process of the Life-Cycle Management event.
`LCMEventType`	Type of Life-Cycle Management event applied.
`LCMEventUniqueID`	Unique identifier for the Life-Cycle Management event applied.

Network Token Fields

Field names in this group are prepended with NetworkToken.

Field Name	Description
`CardExpiryDate`	Expiration date of the card.
`CardSuffix`	Last 4 digits of the card.
`NetworkTokenPAR`	Network token `payment account reference` (PAR).
PAR	A unique reference that identifies the underlying payment account.
`TokenExpiryDate`	Expiration date of the network token.
`TokenModifiedDate`	Date that the network token was modified.
`TokenRequestorID`	Identifier of the wallet that the network token belongs to.
`TokenService`	Token service that provisioned the network token.
`TokenState`	State of the network token.
`TokenSuffix`	Last 4 digits of the network token.
`TokenUniqueID`	Unique identifier for the network token.

Notification of Change Fields

Merchant Reference Number
Transaction Reference Number
NOC Date
NOC Code
Updated Account Type
Updated Routing Number
Updated Account Number
Updated Consumer Name

Order Fields

Field Name	Description
`ConnectionMethod`	Method by which order was sent to .
`GiftWrap`	Indicates if the customer requested gift wrapping for this purchase.
`MerchantID`	Merchant ID.
`MerchantReferenceNumber`	Order or tracking number.
`Price`	Price of each item.
`ProductCode`	Type of product in the offer.
`ProductName`	Name of the product.
`ProductSKU`	Merchant’s product.
`Quantity`	Quantity of product being purchased.
`ReasonCode`	One-digit code that indicates if the entire request was successful.
`ReplyCode`	One-digit code that indicates if the entire request was successful.
`ReplyFlag`	One-word description of the result of the entire request.
`ReplyMessage`	Message that explains the reply flag.
`RequestID`	Identifier for the request generated by the client.
`ReturnAccepted`	Indicates if returns are accepted for this order.
`ShippingMethod`	Shipping method for the product.
`TaxTax`	Total tax to apply to the product.
`TransactionDate`	Date of transaction.

Payer Auth Detail Request Fields

Field Name	Description
`DSTransactionID`	3DS v2 Directory Server transaction identifier.
`MerchantID`	Merchant ID used for the transactions.
`RequestID`	Identifier for the transaction request.
`TransactionDate`	Date on which the transaction took place.
`TransactionID`	Identifier of transaction.
`TransactionType`	Transaction type.

Payer Auth Request Fields

Field Name	Description
`AccountID`	Account identifier.
`AcquirerBin`	Acquiring `bank identification number`.
`CardExpiry`	Card expiration.
`Country`	Country.
`MerchantID`	Merchant identifier.
`MerchantName`	Merchant name.
`MerchantURL`	Merchant URL.
`PurchaseAmount`	Purchase amount.
`PurchaseDate`	Purchase date.
`PurchaseXID`	Purchase XID.

Payer Auth Response Fields

Field Name	Description
`AcquirerBin`	Acquiring `bank identification number`.
`AuthTime`	Authorization time.
CAVV	CAVV.
ECI	E-commerce indicator.
`MerchantID`	Merchant identifier.
`PurchaseAmount`	Purchase amount.
`PurchaseDate`	Purchase date.
`PurchaseXID`	Purchase XID.
`TransactionStatus`	Transaction status.

Payment Data Fields

Field Name	Description
`AAV_CAVV`	Optional authentication data that you can receive after the customer is authenticated.
`ACHVerificationResult`	Raw result of the ACH Verification service.
`ACHVerificationResultMapped`	Mapped result of the ACH Verification service.
`AcquirerMerchantID`	—
`AcquirerMerchantNumber`	Identifier that was assigned to you by your acquirer. This value must be printed on the receipt.
`Amount`	Grand total for the order.
`AuthIndicator`	—
`AuthorizationCode`	Authorization code for the payment.
`AuthorizationType`	Authorization type of the payment.
`AuthReversalAmount`	—
`AuthReversalResult`	—
`AVSResult`	Raw code for Address Verification Service result for the payment.
`AVSResultMapped`	Address Verification Service result for the payment.
`BalanceAmount`	Remaining balance on the account.
`BalanceCurrencyCode`	Currency of the remaining balance on the account.
`BankAccountName`	Name of account holder.
`BankCode`	Bank code or sort code for the account if a bank account was used for the transaction.
`BatchFilesID`	—
`BinNumber`	Bank identification number.
`CardCategory`	Type of card used in the transaction.
`CardCategoryCode`	Category code of card used in the transaction.
`CardPresent`	Indicates whether the card is present at the time of the transaction.
`CardVerificationMethod`	—
`CurrencyCode`	Currency code for the payment.
`CustomerAccountID`	—
`CVResult`	CVN result code.
`DCCIndicator`	Flag that indicates whether DCC is being used for the transaction.
ECI	Optional information that you can receive if you use the Payer Authentication service.
`eCommerceIndicator`	Type of e-commerce transaction.
`EMVRequestFallback`	Indicates that a fallback method was used to enter credit card information into the POS terminal.
`EVEmail`	Mapped Electronic Verification response code for the customer’s email address.
`EVEmailRaw`	Raw Electronic Verification response code from the processor for the customer’s email address.
`EventType`	Type of event that occurred for the transaction.
`EVName`	Mapped Electronic Verification response code for the customer’s name.
`EVNameRaw`	Raw Electronic Verification response code from the processor for the customer’s last name.
`EVPhoneNumber`	Mapped Electronic Verification response code for the customer’s phone number.
`EVPhoneNumberRaw`	Raw Electronic Verification response code from the processor for the customer’s phone number.
`EVPostalCode`	Mapped Electronic Verification response code for the customer’s postal code.
`EVPostalCodeRaw`	Raw Electronic Verification response code from the processor for the customer’s postal code.
`EVStreet`	Mapped Electronic Verification response code for the customer’s street address.
`EVStreetRaw`	Raw Electronic Verification response code from the processor for the customer’s street address.
`ExchangeRate`	Exchange rate.
`ExchangeRateDate`	Time stamp for the exchange rate.
`GrandTotal`	Grand total amount for the order, including tax, for requests that do not contain payment information.
`IssuerResponseCode`	Additional authorization code that must be printed on the receipt when returned by the processor.
`JpoJccaTerminalID`	Unique terminal identifier provided by Japan Credit Card Association (JCCA).
`JpoPaymentMethod`	Indicates Japanese payment option being used.
`MandateReferenceNumber`	—
`MerchantCategoryCode`	Four-digit number that `payment card industry` uses to classify merchants into market segments.
`NetworkCode`	—
`NumberOfInstallments`	Total number of installments when making payments in installments.
`OriginalAmount`	—
`OriginalCurrency`	—
`PaymentProcessor`	Name of payment processor.
`PaymentProductCode`	Type of payment product used by the consumer to pay on a payment provider’s site, such as installments or bank transfer.
`PaymentRequestID`	Original request ID for the purchase.
`PinType`	Method that was used to verify the cardholder's identity.
`POSCatLevel`	Type of cardholder-activated terminal.
`POSEntryMode`	Method of entering credit card information into the POS terminal.
`POSEnvironment`	Operating environment.
`POSTerminalCapability`	POS terminal’s capability.
`ProcessorMID`	—
`ProcessorResponseCode`	The error message sent directly from the bank.
`ProcessorResponseID`	Response ID sent from the processor.
`ProcessorTID`	Transaction identification (TID) that is used to identify and track a transaction throughout its life cycle.
`ProcessorTransactionID`	—
`RequestedAmount`	Amount requested to be authorized.
`RequestedAmountCurrencyCode`	Currency for the amount requested to be authorized.
`RoutingNetworkType`	Processor scheme used for routing the transaction.
`SalesSlipNumber`	Transaction identifier that you generate.
`ShopName`	Name of the shop.
`ShopNameKatakana`	Shop name displayed in katakana characters.
`ShopNameLocal`	Shop name displayed in local dialect.
`SolutionType`	Type of digital payment used. Valid values: `001`, `006`, `007`
`StoreAndForwardIndicator`	When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored.
`SubMerchantCity`	Sub-merchant’s city.
`SubMerchantCountry`	Sub-merchant’s country.
`SubMerchantEmail`	Sub-merchant’s email address.
`SubMerchantID`	Identifier assigned to sub-merchant.
`SubMerchantName`	Sub-merchant’s name.
`SubMerchantPhone`	Sub-merchant’s phone number.
`SubMerchantPostalCode`	Sub-merchant’s ZIP/Postal code.
`SubMerchantState`	Sub-merchant’s state.
`SubMerchantStreet`	First line of sub-merchant’s street address.
`SubsequentAuth`	Indicates whether the transaction is a merchant-initiated transaction or subsequent authorization.
`SubsequentAuthFirst`	Indicates whether the customer initiated the transaction and whether the credentials are stored for future authorizations.
`SubsequentAuthReason`	Reason for the merchant-initiated transaction or incremental authorization.
`SubsequentAuthStoredCredential`	Indicates whether you obtained the payment information from credentials on file (COF) instead of from the customer.
`SubsequentAuthTransactionID`	Network transaction identifier that was returned for a previous authorization in the series.
`TargetAmount`	Converted amount.
`TargetCurrency`	Billing currency.
`TerminalIDAlternate`	Identifier for an alternate terminal at your retail location.
`TotalTaxAmount`	Total tax amount for all of the line items in the transaction.
`TransactionRefNumber`	Reference number for the transaction.
`XID`	Optional transaction identifier generated by Payer Authentication that you can receive when the customer is enrolled and when validation is successful.

Payment Method Fields

Field Name	Description
`AccountEncoderID`	—
`AccountSuffix`	Last four digits of the customer’s payment account number.
`AccountType`	—
`AuthMerchantAdviceCode`	—
`AuthMerchantAdviceCodeRaw`	—
`BankAccountName`	Bank's account name.
`BankCheckDigit`	—
`BankCity`	—
`BankCode`	Bank's code. Used for some countries when you are not using the IBAN. Contact Customer Support for required country-specific bank account information.
`BankCountry`	—
`BankNumber`	—
`BankTransitNumber`	—
`BinCountry`	Issuer country code.
`BoletoBarCodeNumber`	Numeric representation of the boleto barcode.
`BoletoNumber`	Boleto Bancário payment number.
`BranchCode`	—
`CardCategory`	Type of card used.
`CardCategoryCode`	Code for card type used.
`CardType`	Type of card to authorize.
`CheckNumber`	Check number.
`EffectiveDate`	—
`ExpirationMonth`	Two-digit month in which the credit card expires.
`ExpirationYear`	Four-digit year in which the credit card expires.
`IbanIndicator`	—
`IssueNumber`	Number of times a Maestro (UK Domestic) card has been issued to the account holder.
`MandateId`	Identification reference for the direct debit mandate.
`MandateType`	Type of mandate.
`NetworkTokenTransType`	—
`OverridePaymentMethod`	—
`RawValidationCode`	—
`ResultCode`	—
`SignatureDate`	Date of signature.
`StartMonth`	Month of the start of the Maestro (UK Domestic) card validity period.
`StartYear`	Year of the start of the Maestro (UK Domestic) card validity period.
`SwiftCode`	—
`TypeDescription`	—
`ValidationLevel`	—
`WalletType`	Type of wallet.

Payment Fields

Field Name	Description
`AccountSuffix`	Last four digits of the customer’s payment account number.
`AuthEVAddress1`	Mapped Electronic Verification response code for the customer’s street address.
`AuthEVEmail`	Mapped Electronic Verification response code for the customer’s email address.
`AuthEVLastName`	Mapped Electronic Verification response code for the customer’s last name.
`AuthEVPhone`	Mapped Electronic Verification response code for the customer’s phone number.
`AuthEVPostalCode`	Mapped Electronic Verification response code for the customer’s postal code.
`AVSResultMapped`	Address Verification Service result for the payment.
`CardBIN`	Eight-digit card issuer `bank identification number`.
`CardBINCountry`	Country associated with the origin of the card.
`CardIssuer`	Name of the bank.
`CardScheme`	Subtype of card account.
`CardType`	Type of payment card account.
`CardVerificationResult`	Raw result of the ACH Verification service.
`ECommerceIndicator`	Type of e-commerce transaction.
`LocalCurrencyCode`	Your local pricing currency code.
`LocalOrderAmount`	Amount in your original local pricing currency.
`OrderAmount`	Grand total amount or the individual line-item amounts.
`OrderCurrency`	Currency used for the order.

POS Terminal Exceptions Fields

Field Name	Description
`AccountSuffix`	—
`Amount`	—
`BillToEmail`	Email address of the user.
`CardVerificationMethod`	Type of customer verification.
`ClientID`	Client identifier for an installation; generated by the operating system.
`CurrencyCode`	—
`DCCExchangeRate`	Dynamic Currency Conversion exchange rate.
`DCCLookupStatus`	Lookup Status of Dynamic Currency Conversion.
`DCCMarginRate`	Margin rate of Dynamic Currency Conversion.
`DeviceHardwareRevision`	Hardware revision printed on the back of the credit card reader.
`DeviceID`	Serial number printed on the back of the credit card reader. Dashes are stripped from the serial number.
`DeviceOS`	Operating system of the device.
`DeviceOSVersion`	Operating system version of the device.
`DeviceTerminalID`	Terminal identifier assigned to the credit card reader; used by the clearing institute to identify credit card readers.
`ExceptionCategory`	Status of the transaction.
`ExceptionDescription`	Detailed description of the status of the transaction.
`ExceptionStatusCode`	Code that represents the status of the transaction.
`ExpirationMO`	—
`ExpirationYR`	—
`FirstName`	—
`LastName`	—
`LocalCurrencyCode`	Three-digit security code for the local currency.
`MerchantID`	—
`PartnerMerchantID`	Three-digit identifier for the partner merchant.
`PartnerMerchantName`	Name of the merchant that performed the transaction.
`PartnerOriginalTransactionID`	Unique identifier of the transaction.
`ProcessorMID`	Merchant identifier of the merchant that performed the transaction; as assigned by the clearing institute.
`POSTerminalExceptionRequestID`	Unique identifier of the transaction processor; for debugging purposes.
`SchemeOperator`	Scheme of the credit card.
`SDKVersion`	Version of the software development kit (SDK).
`StorageMechanism`	Source from which payment details are collected.
`TerminalID`	Terminal identifier of the merchant that performed the transaction.
`TransactionDate`	—

Profile Fields

Field Name	Description
`Name`	Name of the profile.
`ProfileDecision`	Decision returned by the profile.
`ProfileMode`	Activity mode of the profile.
`RuleDecision`	Decision returned by the rule.
`RuleName`	Name of the rule.

Proof XML Fields

Field Name	Description
`AcquirerBin`	Acquiring bank identification number.
`Date`	Transaction date.
`DirectoryServerURL`	Directory server URL.
`Enrolled`	Enrollment indicator.
`MerchantID`	Merchant ID used for transaction.
`Pan`	Customer masked account number.
`Password`	Password.

Recipient Fields

Field Name	Description
`Address`	Recipient street address.
`City`	Recipient city.
`Country`	Recipient country.
`DOB`	Recipient date of birth.
`FirstName`	Recipient first name.
`LastName`	Recipient last name.
`MiddleInitial`	Recipient name middle initial.
`PhoneNumber`	Recipient phone number.
`PostalCode`	Recipient postal code.
`RecipientBillingAmount`	Transaction billed amount.
`RecipientBillingCurrency`	Recipient billing currency.
`ReferenceNumber`	Recipient reference number.
`State`	Recipient state.

Recurring Billing Fields

Field Name	Description
`BillingPeriodLength`	Length of the billing period.
`BillingPeriodUnit`	Billing period unit. For example: `day`, `week`, `month`.
`PlanPeriodLength`	Length of the plan.
`PlanPeriodUnit`	Plan period unit. For example: `day`, `week`, `month`.
`PlanDescription`	Description of the plan.
`PlanCurrency`	Currency of the plan.
`PlanID`	Unique identifier of the plan.
`PlanCode`	Unique code of the plan.
`SetupFee`	Fee for setting up the subscription.
`SubscriptionStatus`	Current status of the subscription. For example, `active` or `inactive`.
`SubscriptionID`	Unique identifier of the plan.
`SubscriptionCode`	Unique code of the subscription.
`SubscriptionName`	Unique name of the subscription.
`SubscriptionNextPaymentDate`	Date of the next payment for this subscription.
`SubscriptionSuccessfulPayments`	Number of successful payments for this subscription.
`SubscriptionRetryCount`	Number of times a failed payment has been retried.
`SubscriptionStartDate`	Date the subscription starts.
`SubscriptionPaymentAmount`	Amount paid for this subscription.
`TMSCustomerID`	Unique customer ID of a customer in the system.
`TMSPaymentInstrumentID`	Unique payment instrument ID of a customer in the system.
`TMSShippingID`	Unique shipping ID of a customer in the system.

Request Fields

Field Name	Description
`Comments`	Optional comments that you can make about the subscription or customer profile.
`eCommerceIndicator`	Transaction type.
`LocalizedrequestDate`	—
`MerchantID`	Merchant ID used for the transactions.
`MerchantReferenceNumber`	Merchant’s order reference or tracking number.
`PartnerOriginalTransactionID`	Partner original transaction identifier.
`PartnerSDKVersion`	Partner SDK version.
`RequestID`	Identifier for the transaction request.
`Source`	Source of request.
`SubscriptionID`	Identifier for the customer profile.
`TerminalSerialNumber`	—
`TransactionDate`	Date on which the transaction took place.
`TransactionID`	—
`TransactionRefNumber`	Transaction identifier.
`TransactionType`	Transaction type.
`User`	Information about a user.
`LocalizedRequestDate`	Localized request date.

SCA Exemption Fields

HSBC processor merchants must obtain approval from HSBC before using strong customer authentication (SCA) exemptions on authorization transactions for these exemption types:

Authentication outage
Follow-on recurring payment
Low-risk transaction

This requirement does not apply to the low_value_exemption_indicator field.

Field Name	Description
`SCAExemption`	Reason the transaction is exempt from `strong customer authentication` (SCA) requirements. Possible values: `delegated_authentication_exemption_indicator`, `low_value_exemption_indicator`, `risk_analysis_exemption_indicator`, `secure_corporate_payment_indicator`, `trusted_merchant_exemption_indicator`.
`SCAExemptionValues`	Number indicating whether the associated SCA exemption was included in the transaction. Possible values: `0`: Not exempt. `1`: Exempt.

Sender Fields

Field Name	Description
`Address`	Sender address.
`City`	Sender city.
`Country`	Sender country.
`DOB`	Sender date of birth.
`FirstName`	Sender first name.
`LastName`	Sender last name.
`MiddleInitial`	Sender name middle initial.
`PhoneNumber`	Sender phone number.
`PostalCode`	Sender postal code.
`SenderReferenceNumber`	Reference number generated by you that uniquely identifies the sender.
`SourceOfFunds`	Source of funds.
`State`	Sender state.

Settlement Fields

Field Name	Description
`SettlementAge`	Settlement aging.
`SettlementAmount`	Amount settled for transaction.
`SettlementCurrencyCode`	Currency code applied to settlement.
`SettlementDate`	Date settlement applied.
`SourceResponseCode`	Response code sent from source.
`SourceResponseMessage`	Response message sent from source.
`Status`	Settlement status. Possible values: `S`: Success, `P`: Pending, `F`: Failed

Shipping Fields

Field Name	Description
`Carrier`	Carrier used to ship product.
`Method`	Shipping method for the product.

Ship To Fields

Field Name	Description
`Address1`	Shipping address first line.
`Address2`	Shipping address second line.
`City`	Shipping city.
`CompanyName`	—
`Country`	Shipping address country.
`FirstName`	Recipient first name.
`LastName`	Recipient last name.
`Phone`	Recipient phone number.
`State`	Shipping address state or province.
`Zip`	Shipping address Zip/postal code.

Standard Billing Data Package Fields

These are the fields in the Standard Billing Data Package report.

Field Name	Description
Header Record
`File Date`	The date when the system generated the report. Format: YYYYMMDD
`File Time`	The time of the day when the system generated the report. Format: HHMMSS
`Institution ID`	Unique ID of the partner.
`Record Type`	Record identifier. Fixed value is `HR`.
Detail Records
`Acquirer Merchant ID`	Merchant ID assigned by the acquirer.
`Amount Sign`	Possible values: `001`: Positive `002`: Negative
`Card Acceptor ID`	ID assigned to a merchant by acquirer and used in transactions. Used only for Payment Gateway Services (Card Present and Card Not Present)
`Card Scheme`	Payment network linked to the payment card.
`Card Type`	Type of payment card. Possible values: `C`: Credit card `D`: Debit card `P`: Prepaid card
`Client Reference`	Unique identifier assigned to a client in . The special character underscore (_) is allowed.
`Count`	Sum of transactions for a given product code.
`Currency Code`	ISO numeric currency code used in the transaction.
`Domestic/International Indicator`	Indicates whether the transaction was domestic or international. Possible values: `01`: Domestic `02`: International
`Product Code`	The product code for the transaction or the partner opted product code associated to the product code.
`Record Type`	Record identifier. Fixed value is `DR`.
`Statistic Type`	Not in use.
`Total Amount`	Sum payment value for a given product code.
`Transaction Date`	Date of the transaction. Format: YYYYMMDD
Trailer Record
`Number of Records`	The total number of records in the report including the Header Record, Detail Records, and Trailer Record.
`Record Type`	Record identifier. Fixed Value is `TR`.

Card Scheme — Payment network linked to the payment card. Possible values:

001: Visa
002: Mastercard
003: American Express
004: Discover
005: Diners Club
006: Carte Blanche
007: JCB
008: Optima
011: Twinpay (credit)
012: Twinpay (debit)
013: Walmart
014: Enroute
015: Lowes Consumer
016: Home Depot Consumer
017: MBNA
018: Dick's Sportwear
019: Casual Corner
020: Sears
021: JAL
023: Disney
024: Switch/Solo
025: Sams Club Consumer
026: Sams Club Business
027: Nicos
029: Bebe
030: Restoration Hardware
031: Delta
032: Solo
033: Visa Electron
034: Dankort
035: Laser
036: Cartes Bancaires
037: Carta
042: Maestro
043: GE MONEY
044: Korean cards
045: Style
046: J.Crew
050: Hipercard
051: Aura
052: Redecard
053: Orico card
054: Elo
055: Capital One Private Label
058: Carnet
059: ValueLink
061: RuPay
062: China UnionPay
063: Falabella Private Label
064: Prompt card
065: Korean Domestic
066: Banricompras

Monthly Fee Details Fields

These are the fields in the Standard Monthly Fee report.

Field Name	Description
Header Record
`File Date`	The date when the system generated the report. Format: YYYYMMDD
`File Time`	The time of the day when the system generated the report. Format: HHMMSS
`Institution ID`	Unique ID of the partner.
`Record Type`	Record identifier. Fixed value is `HR`.
Detail Records
`Acquirer Merchant ID`	Merchant ID assigned by the acquirer.
`Actual Fee`	Actual fee value for a given product code. The value is corrected to two decimal places. This value is a multiple of 100.
`Client Reference`	Unique identifier assigned to a client. The special character underscore (_) is allowed.
`Currency Code`	ISO currency code.
`Fee Type`	Type of fee. Possible values: `MONTHLY` `ONETIME` `MIN`
`Organization Type`	Type of organization. Possible values: `RESELLER` `RESOLD` `MID` `RESELLER_MID`
`Product Code`	product code for the fee.
`Quantity`	Quantity for the given product code.
`Record Type`	Record identifier. Fixed value is `DR`.
`Tax`	Tax value for a given product code. The value is corrected to two decimal places. This value is a multiple of 100.
`Total Fee`	Total fee value for a given product code. The value is corrected to two decimal places. This value is a multiple of 100.
Trailer Record
`Number of Records`	The total number of records in the report including the Header Record, Detail Records, and Trailer Record.
`Record Type`	Record identifier. Fixed Value is `TR`.

Tax Fields

Field Name	Description
`Country`	Credit card billing country. Use the two-character ISO Standard Country Codes. When `shipTo_country` is not provided, `billTo_country` is used in its place. When `billTo_country` is set to `US` or `CA`,`billTo_postalCode` and `billTo_state` are also required. It is the merchant's responsibility to determine whether a field is required for the transaction.
`CurrencyCode`	—
`LineExemptAmount`	—
`InvoiceDate`	Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday.The default is the date, in Pacific time, that the request is received. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that apply on a specific date.
`JurisdictionCode`	—
`JurisdictionName`	Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the `show_tax_per_offer` field is set to `yes`.
`JurisdictionType`	Free-text description of the jurisdiction for the item. For example, San Mateo County. Returned only if the `show_tax_per_offer` field is set to `yes`.
`LineItemAmount`	Line Amount total.
`LineNo`	—
`MerchantIdentifer`	Merchant ID. Use the same merchant ID for evaluation, testing, and production.
`MerchantReferenceCode`	Merchant-generated order reference or tracking number.
`PointOfOrderAcceptanceCity`	This item-level field overrides the corresponding request-level field. This field is not used unless the `item_#_orderAcceptanceState` and `item_#_orderAcceptanceCountry` fields are present.
`PointOfOrderAcceptanceCountry`	This item-level field overrides the corresponding request-level field. This field is not used unless the `item_#_ orderAcceptanceState` and `item_#_ orderAcceptanceCity` fields are present. Use the two-character ISO Standard Country Codes.
`PointOfOrderAcceptancePostalCode`	Order acceptance ZIP/Postal Code.
`PointOfOrderAcceptanceStateProvince`	This item-level field overrides the corresponding request-level field. This field is not used unless the `item_#_orderAcceptanceCity` and `item_#_orderAcceptanceCountry` fields are present. Use the State, Province, and Territory Codes for the United States and Canada.
`PointOfOrderOriginCity`	Order origin city. This field is not used unless the `taxService_orderOriginState` and `taxService_orderOriginCountry` fields are present.
`PointOfOrderOriginCountry`	This item-level field overrides the corresponding request-level field. This field is not used unless the `item_#_orderAcceptanceState` and `item_#_orderAcceptanceCity` fields are present. Use the two-character ISO Standard Country Codes.
`PointOfOrderOriginPostalCode`	Order origin postal code. This field is not used unless the `taxService_orderOriginCity`, `taxService_orderOriginState`, and `taxService_orderOriginCountry` fields are present.
`PointOfOrderOriginStateProvince`	Order origin state. This field is not used unless the `taxService_orderOriginCity` and `taxService_orderOriginCountry` fields are present. Use the State, Province, and Territory Codes for the United States and Canada.
`ProductCode`	Type of product. This value is used to determine the product category: electronic, handling, physical, service, or shipping. The default value is default. To use the tax calculation service, use values listed in the Tax Product Code Guide. For information about this document, contact Customer Support.
`ProductName`	Name of the product. Some services use this value for communication with the customer, so the name should clearly represent the product. For `ccAuthService` and `ccCaptureService`, required if `item_#_productCode` is not default or one of the values related to shipping and handling.
`ProductSku`	Product’s identifier code. For `ccAuthService` and `ccCaptureService`, required if `item_#_productCode` is not default or one of the values related to shipping and handling.
`Quantity`	Quantity of the product being purchased.
`Rate`	Jurisdiction tax rate for the item.
`ReportingDate`	Reporting date of any committed transaction. Defaults to current date if not provided. Also the default Tax Calculation Date unless a different date is specified in `invoiceHeader_invoiceDate`.
`RequestIdentifier`	Identifier for the request.
`ShipFromCity`	City from which the order is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This field is used only when `shipFrom_state` and `shipFrom_country` are present.
`ShipFromCountry`	Country from which the product is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This item-level field overrides the corresponding request-level field. Use the two character ISO Standard Country Codes.
`ShipFromPostalCode`	Postal code from which the product is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This item-level field overrides the corresponding request-level field.
`ShipFromStateProvince`	State from which the order is shipped, which is used to determine tax rules and/or rates applied to the transaction based on sourcing. This field is used only when `shipFrom_city` and `shipFrom_country` are present. Use the State, Province, and Territory Codes for the United States and Canada.
`ShipToCity`	City of the shipping address. This field is used only when the `shipTo_state` and `shipTo_country` fields are present.
`ShipToCountry`	Country of the shipping address. Use the two-character ISO Standard Country Codes. This field is used only when the `ship_to_city` and `ship_to_state` fields are present.
`ShipToPostalCode`	Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the shipping country is the US, the 9-digit postal code must follow this format:[5 digits][dash][4 digits]Example: `12345-6789`When the shipping country is Canada, the 6-digit postal code must follow this format:[alpha][numeric][alpha][space][numeric][alpha][numeric]Example: `A1B 2C3`
`ShipToStateProvince`	State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. The default value for `shipTo_state` is `billTo_state`. This field is used only when the `shipTo_city` and `shipTo_country` fields are present.
`ShipToStreet`	Street of the shipping address.
`StateProvince`	This item-level field overrides the corresponding request-level field. This field is not used unless the `item_#_orderOriginCity` and `item_#_orderOriginCountry` fields are present.
`TaxableAmount`	—
`TaxAmount`	Total tax for all items.
`TaxName`	Name of the jurisdiction tax for the item. For example, CA State Tax.
`TransactionType`	Sale/Refund. Based on refund indicator (refund or not).
`UnitPrice`	Per-item price of the product. This value cannot be negative.

TMS Token Fields

Field names in this group are prepended with TMSToken.

Field Name	Description
`Creator`	Organization ID or merchant ID that created the token.
`CustomerID`	customer token ID.
`InstrumentIdentifierID`	Unique identifier for the instrument identifier.
`InstrumentIdentifierState`	Current state of the instrument identifier token.
`PaymentInstrumentID`	payment instrument token ID.
`ShippingAddressID`	shipping address token ID.
`VaultID`	Unique identifier for the vault that the token belongs to.

Token Fields

Field names in this group are prepended with Token.

Field Name	Description
`NetworkTokenTransType`	Network token transaction type.
`TokenCode`	Transaction token code.

Travel Fields

Field Name	Description
`CompleteRoute`	Concatenation of individual travel legs.
`DepartureDateTime`	First leg departure date and time.
`JourneyType`	Type of travel.
`Number`	Passenger number.
`PassengerFirstName`	Passenger’s first name.
`PassengerEmail`	Passenger's email address, including the complete domain name.
`PassengerId`	Ticketed passenger identifier.
`PassengerLastName`	Passenger’s last name.
`PassengerPhone`	Passenger's phone number.
`PassengerStatus`	Company's passenger classification, such as frequent flyer program.
`PassengerType`	Passenger classification associated with the price of the ticket.

Velocity Morphing Fields

Field Name	Description
`Count`	Velocity morphing count information.

Verify Enrollment Request Fields

Field Name	Description
`AcquirerBin`	Acquiring bank identification number.
`MerchantID`	Merchant identifier.
`Pan`	Customer masked account number.

Verify Enrollment Response Fields

Field Name	Description
`AccountID`	Account identifier.
`AcsUrl`	ACS URL.
`Enrolled`	Indicates enrollment verified.

Fields with Compound Values

Some of the new reports contain different field names and headers. In some cases, multiple fields have been combined into a single field with values separated by commas. For example, the rcode, rflag, and rmsg responses for each application have been combined into ics_rcode, ics_rflag, and ics_rmsg. If a transaction called the ics_auth and ics_bill applications, the ics_rcode field could contain 1,1.


Application Fields
Rcode	ReasonCode	Rflag
Name	Rmsg
Health Care Fields
amount	amountType	currency
industryType	—
Line Item Fields
FulfillmentType	Quantity	UnitPrice
TaxAmount	MerchantProductSku	NameOfProduct
TypeOfProduct	InvoiceNumber	Number
Payment Method Fields
CardType	ExpirationMonth	ExpirationYear
StartMonth	StartYear	IssueNumber
AccountSuffix	BoletoNumber	BoletoBarCodeNumber
CardCategory	CardCategoryCode	WalletType
CheckNumber	MandateId	MandateType
SignatureDate	EffectiveDate	AccountType
TypeDescription	OverridePaymentMethod	Type
Payment Data Fields
AuthorizationType	AuthorizationCode	AVSResult
CurrencyCode	AVSResultMapped	CVResult
ProcessorResponseCode	NumberOfInstallments	ACHVerificationResult
ACHVerificationResultMapped	BalanceAmount	BalanceCurrencyCode
RequestedAmount	RequestedAmountCurrencyCode	EVEmail
EVEmailRaw	EVName	EVNameRaw
EVPhoneNumber	EVPhoneNumberRaw	EVStreet
EVStreetRaw	EVPostalCode	EVPostalCodeRaw
BinNumber	Amount	PaymentRequestID
PaymentProcessor	TotalTaxAmount	EventType
GrandTotal	ECI	AAV_CAVV
XID	TargetAmount	TargetCurrency
ExchangeRate	ExchangeRateDate	DCCIndicator
BankCode	BankAccountName	AuthIndicator
AuthReversalResult	AuthReversalAmount	CardPresent
POSEntryMode	EMVRequestFallback	TerminalIDAlternate
POSCatLevel	CardVerificationMethod	POSEnvironment
RoutingNetworkType	StoreAndForwardIndicator	PinType
IssuerResponseCode	AcquirerMerchantNumber	NetworkCode
MandateReferenceNumber	ProcessorTID	ProcessorTransactionID
ProcessorMID	PaymentProductCode	AcquirerMerchantID
SubMerchantCity	SubMerchantCountry	SubMerchantEmail
SubMerchantID	SubMerchantName	SubMerchantPhone
SubMerchantPostalCode	SubMerchantState	SubMerchantStreet
TransactionRefNumber	eCommerceIndicator	CustomerAccountID
BatchFilesID	SolutionType	AuthFactorCode
EMVServiceCode	AFTIndicator	SalesSlipNumber
JpoJccaTerminalID	JpoPaymentMethod	ShopName
ShopNameLocal	ShopNameKatakana	POSTerminalCapability
MerchantCategoryCode	—

Was this page helpful?

Last published: September 29, 2026