Skip to main content

Field Reference


This reference applies to the Reporting API.

Use these field names in the reportFields array when creating a report subscription or one-time report ΓÇö for example, "reportFields": ["Request.RequestID", "BillTo.FirstName"]. See Report Subscriptions for the full request structure. Fields are organized by type (for example, billing, settlement, tokens). Where available, additional details including description, field format, and mapped values are included.

Application Fields

Application Fields
Field NameDescription
NameName of application used.
RcodeOne-digit code indicating whether the entire request was successful.
ReasonCodeNumeric value that corresponds to the result of the overall request.
RflagOne-word description of the result of the entire request.
RmsgMessage that explains the ics_flag value.

Authorization Results Fields

Authorization Results Fields
Field NameDescription
AVSResultOptional results of address verification test.
CVVResultOptional results of card verification number test.

Bank Information Fields

Bank Information Fields

Field names in this group are prepended with BankInfo.

Field NameDescription
AddressBank's address.
BranchCodeCode that identifies the branch of the customer's bank when you are not using the IBAN.
CityCity in which the bank is located.
CountryCountry in which the bank is located.
NameBank's name.
SwiftCodeBank's SWIFT code. Unique address of the bank. Also known as the Bank Identification Code (BIC).

Batch Fields

Batch Fields
Field NameDescription
BatchDateDate when the batch was sent to the processor.
BatchIDBatch in which the transaction was sent.
StatusStatus of batch file.
SuccessFlagIndicates whether batch file processing was successful.

Bill To Fields

Bill To Fields

Field names in this group are prepended with BillTo.

Field NameDescription
Address1First line of the billing street address as it appears on the credit card issuer's records.
Address2Additional address information.
CityCity of the billing address.
CompanyNameName of the customer's company.
CompanyTaxIDTax identification number of customer's company.
CountryCountry of the billing address.
CustomerIDYour identifier for the customer.
EmailCustomer's email address, including the full domain name.
FirstNameFirst name of the billed customer.
HostNameDNS resolved hostname from billTo_ipAddress.
IPAddressCustomer's IP address.
LastNameLast name of the billed customer.
MiddleNameMiddle name of the billed customer.
NameSuffixSuffix of billed customer.
PhoneCustomer's phone number.
StateState or province of the billing address.
TitleTitle of the billed customer.
UserNameCustomer's user name.
ZipZIP/Postal code for the billing address. The postal code must consist of five to nine digits.

Chargeback and Retrieval Fields

Chargeback and Retrieval Fields
Field NameDescription
AdjustmentAmountAmount of the chargeback adjustment.
AdjustmentARNAssociation reference number.
AdjustmentCurrencyCurrency of the chargeback adjustment.
CaseIdentifierNumerical identifier created by Cybersource to represent a unique chargeback, representment, or other exception.
CaseNumberProcessor-assigned case number.
CaseTimeThe date that the case was opened.
CaseTypeDescription of the case type.
ChargebackAmountAmount of the chargeback.
ChargebackCurrencyChargeback currency code.
ChargebackMessageText message from the issuer explaining the reason for the chargeback or other exception.
ChargebackReasonCodeAssociation chargeback reason code.
ChargebackReasonCodeDescriptionText description of the reason code.
ChargebackTimeThe date that the chargeback was originated by the issuing bank.
DocumentIndicatorIndicates whether or not there are associated documents. Possible values: Y, N
FeeAmountAmount of the chargeback exception fee.
FeeCurrencyCurrency code for the chargeback exception fee.
FinancialImpactIndicates whether or not there is a financial impact. Possible values: Y, N
FinancialImpactTypeDebit, credit, or none.
MerchantCategoryCodeFour-digit number that the payment card industry uses to classify merchants into market segments.
PartialIndicatorFlag indicating whether the transaction is enabled for partial chargeback.
ResolutionTimeResolution time in UTC.
ResolvedToIndicatorIndicates resolved to status of transaction. Possible values: B: Bank, M: Merchant, S: Split, G: General ledger.
RespondByDateDate by which item must be submitted to the chargeback processor to allow sufficient time for representment.
TransactionTypeCapture type of the original transaction.

Check Fields

Check Fields

Field names in this group are prepended with Check.

Field NameDescription
BankTransitNumber—
AccountEncoderIDIdentifier for the bank that provided the customer's encoded account number.
SecCodeAuthorization method used for the transaction.

Conversion Fields

Conversion Fields
Field NameDescription
ConversionDateDate order converted.
NewDecisionReviewer evaluation result.
OriginalDecisionOrder profile evaluation result.
ProfileOrder profile used to evaluate the order.
ReviewerPerson who evaluated order originally marked for review.
ReviewerCommentsAdditional information added by reviewer.
QueueReview queue originally assigned to order.

Deposit Fields

Deposit Fields
Field NameDescription
AmountAmount of the deposit.
CategoryCategory of the deposit.
CurrencyCurrency code of the deposit.
ExchangeRateExchange rate. Includes a decimal point and up to 4 decimal places.
ExchangeRateDescriptionExchange rate description from the funding bank.
IdentifierUnique reference number for this deposit.
MerchantBankAcctLast4Bank account number to which the funds transfer will be deposited. For security purposes, all but the last 4 digits are masked.
MerchantBankAcctNameName used on the bank account.
MerchantBankCodeRouting number for the account to which the funds transfer will be deposited.
MerchantBankCountryCountry in which the bank is located. Use the two-character ISO Standard Country Codes.
MerchantBankNameBank's name.
MerchantID merchant ID.
MethodFunds transfer method.
StatusStatus of the deposit. Possible values: S: Success, P: Pending, F: Failed
TimeDeposit time for the transaction in UTC.
TransferMessageDeposit transfer message provided by the processor.
TypeDescription of events included in this funds transfer.

Device Fields

Device Fields
Field NameDescription
DeviceIDIdentification number of device used for transaction.

Event Fields

Event Fields
Field NameDescription
AmountAmount for the event.
CurrencyCodeCurrency code for the event.
EventType of event that occurred for the transaction.
EventDateDate in GMT format that the event occurred. This field can be null for some event types, such as Declined.
ProcessorMessageAdditional information from the processor about the event, such as an error message or explanation.

Exception Fields

Exception Fields
Field NameDescription
ActionBrief description of the action.
ClientIDID of the client.
CYBSExceptionIDException ID number assigned by .
DccLookupStatusDCC lookup status of the transaction.
DccExchangeRateDCC exchange rate of the transaction.
DccMarginRateDCC margin rate of the transaction.
ExceptionAmountAmount specified in the exception.
ExceptionAmountCurrencyException currency represented in ISO 4217:2008 alpha-3.
ExceptionCategoryType of exception.
ExceptionDateDate of exception.
ExceptionDescriptionDescription of exception.
ExceptionDeviceHardwareRevisionHardware revision number of the device.
ExceptionDeviceIDID of the device.
ExceptionDeviceOSOperating system of the device.
ExceptionDeviceOSVersionOperating system version of the device.
ExceptionDeviceTerminalIDDevice Terminal ID number.
ExceptionMessageDescription of the exception.
ExceptionReasonCodeReason code for the error that occurred. This reason code is the same one that you receive in the response or transaction receipt.
ExceptionReasonDescriptionDescription of exception reason.
ExceptionStatusCurrent status of the transaction.
ExceptionStatusCodeStatus code of the exception.
ExceptionTypeType of exception.
FinancialStatusFinancial status of the transaction.
LastActionDateDate of last action on the transaction.
LocalCurrencyCodeLocal currency code.
NextActionDateDate of next action on the transaction.
OriginalTransactionSubmissionDateDate on which the transaction was submitted.
PartnerMerchantIDMerchant ID of partner.
PartnerMerchantNameMerchant name of partner.
PaymentNumberPayment number.
ProcessorCaseIDProcessor-assigned case number.
ProcessorResponseCodeCode returned directly from the processor for the exception that occurred.
ReasonCodeReason code for the exception that occurred.
RetryCountTotal number of payments that are pending in retry mode.
SchemeOperatorScheme operator.
SDKVersionSDK version being used.
SettlementProcessorName of settlement processor.
StorageMechanismStorage mechanism being used.

Fee Fields

Fee Fields
Field NameDescription
AssessmentAmountAmount of the assessment.
AssessmentCurrencyCurrency of the assessment.
BillingCycleBilling cycle of the merchant. Possible values: daily, weekly, monthly
BillingTypeBilling type of the merchant. Possible values: discount, interchangePlus, serviceFee, other
ClearedInterchangeLevelCode for the clearing level.
DiscountAmountDiscountRate × TransactionAmount. This value includes four decimal points.
DiscountCurrencyCurrency of the discount.
DiscountRateDiscount rate.
DowngradeReasonCodeReason 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
InterchangeAmountFinal amount of transaction after the interchange rates are applied.
InterchangeCurrencyISO currency code for the currency of the clearing rate.
InterchangeRateInterchange rate for the transaction.
PerItemFeeAmountFee for a single item.
PerItemFeeCurrencyCurrency for a single item fee.
PricedInterchangeLevelInterchange flat rate assigned during account setup. This value includes four decimal points.
ServiceFeeAmountAmount of service fee for transaction.
ServiceFeeAmountCcyCurrency of the service fee.
ServiceFeeFixedAmountAmount of the fixed service fee for the transaction.
ServiceFeeFixedAmountCcyCurrency of the fixed service fee.
ServiceFeeRatePercentage rate of the service fee.
SettlementAmountAmount of the settlement.
SettlementCurrencyCurrency of the settlement.
SettlementTimeTime the settlement was processed.
SettlementTimeZoneTime zone of the settlement.
SourceDescriptorSource descriptor for transaction.
TotalFeeAmountTotal amount of all fee transactions for the specified date range.
TotalFeeCurrencyCurrency for all fee transactions for the specified date range.

Fee Summary Fields

Fee Summary Fields
Field NameDescription
CardTypeCard type.
CountCount.
FeeDescriptionFee description.
FeeTypeFee type.
FundingCurrencyCurrency in which fees are applied.
PaymentMethodPayment method used.
PercentageFeePercentage fee charged.
PerItemFeeFee charged per item.
TotalFeeAmountTotal fee amount.
TransactionAmountTransaction amount.
TransactionTypeTransaction type.

Fund Transfer Fields

Fund Transfer Fields

Field names in this group are prepended with FundTransfer.

Field NameDescription
BankCheckDigitCode used to validate the customer's account number.
IbanIndicatorInternational Bank Account Number (IBAN).

Funding Fields

Funding Fields

Field names in this group are prepended with Funding.

Field NameDescription
CurrencyExchangeDescriptionExchange rate description from the processor.
CurrencyExchangeRateExchange rate for converting from transaction currency to funding currency.
FeeAmountFee for the transaction.
FeeCurrencyFee currency represented in ISO 4217:2008 alpha-3.
FeeDescriptionFee description from the processor.
FundingAccountSuffixLast 4 digits of funding account.
FundingAmountFunding amount of the transaction.
FundingBankCodeBank code of the funding bank.
FundingBankCountryBank country of the funding bank represented in ISO 3166-1 alpha-3.
FundingBankNameName of bank funding the transaction.
FundingCurrencyFunding currency represented in ISO 4217:2008 alpha-3.
FundingDateFunding date of the transaction.
FundingIdentificationNumberFunding identification for the funding of the transaction.
FundingProcessorMessageFunding response message from the processor.
FundingTransferMessageFunding transfer message provided by the processor.
ProcessorResponseCodeFunding response code from the processor.
StatusFunding status. Possible values: S: Success, P: Pending, F: Failed

Gift Card Fields

Gift Card Fields
Field NameDescription
CurrentBalanceCurrent gift card balance in the local currency.
PreviousBalancePrevious gift card balance in the 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.
RedemptionTypeType of redemption. Possible values: CASHOUT, REDEMPTION, REDEMPTION_PARTIAL_ALLOWED (default). This field is supported only on ValueLink.

Healthcare Fields

Healthcare Fields
Field NameDescription
AmountAmount of the healthcare payment.
AmountTypeType of healthcare payment. For example: healthcare, dental, clinic
CurrencyCurrency used in transaction.
IndustryTypeType of industry for the transaction.

Invoice Fields

Invoice Fields

Field names in this group are prepended with Invoice.

Field NameDescription
BillingGroupDescriptionDescription of the billing group.
NotProcessedNumber of unprocessed transactions.
OrganizationIDMerchant ID.
PerformedServicesCybersource service name.
ProcessedNumber of processed transactions.
TotalInvoice count.

JP Fields

JP Fields
Field NameDescription
AmountTransaction grand total.
AuthForwardName of Japanese acquirer that processed transaction. Available only for CCS (CAFIS) and JCN Gateway.
AuthorizationCodeTransaction authorization code.
CardSuffixLast four digits of card.
CurrencyCurrency used in transaction.
CustomerFirstNameCustomer first name.
CustomerLastNameCustomer last name.
DateDate of transaction.
GatewayName of gateway used to process transaction.
JPOInstallmentMethodNumber of payment installments (Japanese payment method only).
JPOPaymentMethodType of Japanese payment method used.
MerchantIDCybersource (gateway) merchant identifier.
MerchantReferenceNumberMerchant order reference or tracking number.
NetworkTokenTransTypeNetwork token transaction type.
PaymentMethodMethod of payment.
RequestIDClient request identifier.
SubscriptionIDCustomer profile identifier for requested service.
TimeTime of transaction.
TransactionReferenceNumberReference number used to reconcile Cybersource (gateway) reports with processor reports.
TransactionTypeType of transaction.

Life Cycle Management Fields

Life Cycle Management Event Fields

Field names in this group are prepended with LifeCycleManagementEvent.

Field NameDescription
LCMEventDateProcessedDate on which the life-cycle management event was fully processed.
LCMEventStatusProcessing status of the life-cycle management event.
LCMEventStatusTextFree-formatted text field detailing the process of the life-cycle management event.
LCMEventTypeType of life-cycle management event that is applied.
LCMEventUniqueIDUnique identifier for the life-cycle management event that is applied.

Line Item Fields

Line Item Fields

Field names in this group are prepended with LineItems.

Field NameDescription
FulfillmentTypeInformation about the product code used for the line item.
InvoiceNumberInvoice number for order.
MerchantProductSkuIdentification code for the product.
NumberNumber of the line item in an order.
ProductCodeUsed to determine product category: electronic, handling, physical, service, or shipping.
ProductNameName of product.
QuantityQuantity of product.
TaxAmountTotal tax to apply to the product.
UnitPricePer-item price of the product.

Merchant Defined Data Fields

Merchant Defined Data Fields
Field NameDescription
MerchantDefinedData_field1Fields that you can use to store information (Field1 - Field20).

Network Token Fields

Network Token Fields

Field names in this group are prepended with NetworkToken.

Field NameDescription
CardExpiryDateExpiration date of the card.
CardSuffixLast four digits of the card.
NetworkTokenPARNetwork token payment account reference (PAR).
PARA unique reference that identifies the underlying payment account.
TokenExpiryDateExpiration date of the network token.
TokenModifiedDateDate on which the network token was modified.
TokenRequestorIDIdentifier of the wallet that the network token belongs to.
TokenServiceToken service that provisioned the network token.
TokenStateState of the network token.
TokenSuffixLast four digits of the network token.
TokenUniqueIDUnique identifier for the network token.

Payment Data Fields

Payment Data Fields

Field names in this group are prepended with PaymentData.

Field NameDescription
AAV_CAVVOptional authentication data returned after the customer is authenticated.
ACHVerificationResultRaw result of the ACH verification service.
ACHVerificationResultMappedMapped result of the ACH verification service.
AcquirerMerchantIDMerchant ID of acquirer.
AcquirerMerchantNumberMerchant number of acquirer.
AmountGrand total for the order.
AuthIndicatorAuthorization indicator for the transaction.
AuthorizationCodeAuthorization code for the payment.
AuthorizationTypeAuthorization type of the payment.
AuthReversalAmountAuthorization reversal amount.
AuthReversalResultResult of the authorization reversal.
AVSResultRaw code for Address Verification Service result for the payment.
AVSResultMappedAddress Verification Service result for the payment.
BalanceAmountRemaining balance on the account.
BalanceCurrencyCodeCurrency of the remaining balance on the account.
BankAccountNameName of bank account.
BankCodeCode of bank branch.
BinNumberBank identification number. In the , this field is called AccountPrefix.
CardCategoryType of card used in the transaction.
CardCategoryCodeCategory code of card used in the transaction.
CardPresentCard-present transaction indicator.
CardVerificationMethodCard verification method used.
CurrencyCodeCurrency code for the payment.
CVResultCVN result code.
DCCIndicatorFlag that indicates whether Dynamic Currency Conversion is being used for the transaction.
DomesticRoutingFlag indicates whether the transaction was routed domestically.
ECIOptional information that you can receive if you use the Payer Authentication service.
eCommerceIndicatorType of e-commerce transaction.
EMVRequestFallbackEMV request fallback indicator.
EVEmailMapped Electronic Verification response code for the customer's email address.
EVEmailRawRaw Electronic Verification response code from the processor for the customer's email address.
EventTypeType of event that occurred for the transaction.
EVNameMapped Electronic Verification response code for the customer's name.
EVNameRawRaw Electronic Verification response code from the processor for the customer's last name.
EVPhoneNumberMapped Electronic Verification response code for the customer's phone number.
EVPhoneNumberRawRaw Electronic Verification response code from the processor for the customer's phone number.
EVPostalCodeMapped Electronic Verification response code for the customer's postal code.
EVPostalCodeRawRaw Electronic Verification response code from the processor for the customer's postal code.
EVStreetMapped Electronic Verification response code for the customer's street address.
EVStreetRawRaw Electronic Verification response code from the processor for the customer's street address.
ExchangeRateExchange rate.
ExchangeRateDateTime stamp for the exchange rate.
GrandTotalGrand total amount for the order, including tax, for requests that do not contain payment information.
IssuerResponseCodeResponse code of issuer.
MandateReferenceNumberMandate reference number.
NetworkCodeNetwork code.
NumberOfInstallmentsTotal number of installments when making payments in installments.
PaymentProcessorName of payment processor.
PaymentProductCodeType of payment product used by the consumer to pay on a payment provider's website, such as installments or bank transfer.
PaymentRequestIDOriginal request ID for the purchase.
PinTypeType of PIN entry.
POSCatLevelCategory of point of sale (POS).
POSEntryModePOS entry mode.
POSEnvironmentPOS environment.
ProcessorMIDProcessor merchant ID.
ProcessorResponseCodeThe error message sent directly from the bank.
ProcessorResponseIDResponse ID sent from the processor.
ProcessorTIDTransaction ID (TID) that is used to identify and track a transaction throughout its life cycle.
ProcessorTransactionIDProcessor transaction ID.
RequestedAmountAmount requested to be authorized.
RequestedAmountCurrencyCodeCurrency for the amount requested to be authorized.
RoutingNetworkTypeType of routing network.
StoreAndForwardIndicatorIndicates whether store-and-forward is used for transaction.
SubMerchantCitySub-merchant's city.
SubMerchantCountrySub-merchant's country.
SubMerchantEmailSub-merchant's email address.
SubMerchantIDSub-merchant's ID.
SubMerchantNameSub-merchant's name.
SubMerchantPhoneSub-merchant's phone number.
SubMerchantPostalCodeSub-merchant's postal code.
SubMerchantStateSub-merchant's state.
SubMerchantStreetSub-merchant's street address.
SurchargeFeeSurcharge fee amount.
SurchargeFeeSignSign (+ or -) of the surcharge amount.
TargetAmountConverted amount.
TargetCurrencyBilling currency.
TerminalIDAlternateAlternate terminal ID.
TotalTaxAmountTotal tax amount for all of the line items in the transaction.
TransactionRefNumberReference number for the transaction.
XIDOptional transaction identifier generated by Payer Authentication that you can receive when the customer is enrolled and when validation is successful.

Payment Method Fields

Payment Method Fields

Field names in this group are prepended with PaymentMethod.

Field NameDescription
AccountSuffixLast four digits of the customer's payment account number.
BankAccountNameBank's account name.
BankCodeBank's code. Used for some countries when the IBAN is not used. Cybersource customer support can provide required country-specific bank account information.
BoletoBarCodeNumberNumeric representation of the boleto barcode.
BoletoNumberBoleto Bancário payment number.
CardCategoryType of card used.
CardCategoryCodeCode for card type used.
CardTypeType of card to authorize.
CheckNumberCheck number.
ExpirationMonthTwo-digit month in which the credit card expires.
ExpirationYearFour-digit year in which the credit card expires.
IssueNumberNumber of times a Maestro (UK domestic) card has been issued to the account holder.
MandateIdIdentification reference for the direct debit mandate.
MandateTypeType of mandate.
SignatureDateDate of signature.
StartMonthMonth of the start of the Maestro (UK domestic) card validity period.
StartYearYear of the start of the Maestro (UK domestic) card validity period.
WalletTypeType of wallet.

POS Terminal Exceptions Fields

POS Terminal Exceptions Fields

Field names in this group are prepended with POSTerminalExceptions.

Field NameDescription
POSTerminalException.BillToEmailEmail address of the user.
CardVerificationMethodType of customer verification.
ClientIDClient identifier for an installation. Generated by the operating system.
DCCExchangeRateDynamic Currency Conversion (DCC) exchange rate.
DCCLookupStatusLookup Status of DCC.
DCCMarginRateMargin rate of DCC.
DeviceHardwareRevisionHardware revision printed on the back of the credit card reader.
DeviceIDSerial number printed on the back of the credit card reader. Dashes are removed from the serial number.
DeviceOSOperating system of the device.
DeviceOSVersionOperating system version of the device.
DeviceTerminalIDTerminal ID assigned to the credit card reader. It is used by the clearing institute to identify credit card readers.
ExceptionCategoryStatus of the transaction.
ExceptionDescriptionDetailed description of the status of the transaction.
ExceptionStatusCodeCode that represents the status of the transaction.
LocalCurrencyCodeThree-digit security code for the local currency.
MerchantIDMerchant ID.
PartnerMerchantIDThree-digit ID for the partner merchant.
PartnerMerchantNameName of the merchant that performed the transaction.
PartnerOriginalTransactionIDUnique ID for the transaction.
ProcessorMIDMerchant ID of the merchant that performed the transaction. Assigned by the clearing institute.
POSTerminalException.RequestIDUnique ID of the transaction processor; for debugging purposes.
SchemeOperatorScheme of the credit card.
SDKVersionVersion of the software development kit (SDK).
StorageMechanismSource from which payment details are collected.
TerminalIDTerminal ID of the merchant that performed the transaction.
TransactionDateDate of the transaction.

Profile Fields

Profile Fields

Field names in this group are prepended with Profile.

Field NameDescription
NameName of the profile.
ProfileDecisionDecision returned by the profile.
ProfileModeActivity mode of the profile.
RuleDecisionDecision returned by the rule.
RuleNameName of the rule.

Proof XML Fields

Proof XML Fields

Field names in this group are prepended with ProofXML.

Field NameDescription
AcquirerBinAcquiring bank identification number.
DateTransaction date.
DirectoryServerURLDirectory server URL.
EnrolledEnrollment indicator.
MerchantIDCybersource merchant ID used for transaction.
PanCustomer masked account number.
PasswordPassword.

Recipient Fields

Recipient Fields

Field names in this group are prepended with Recipient.

Field NameDescription
AddressRecipient street address.
CityRecipient city.
CountryRecipient country.
DOBRecipient date of birth.
FirstNameRecipient first name.
LastNameRecipient last name.
MiddleInitialRecipient name middle initial.
PhoneNumberRecipient phone number.
PostalCodeRecipient postal code.
RecipientBillingAmountTransaction billed amount.
RecipientBillingCurrencyRecipient billing currency.
ReferenceNumberRecipient reference number.
StateRecipient state.

Request Fields

Request Fields

Field names in this group are prepended with Request.

Field NameDescription
CommentsOptional comments about the subscription or customer profile.
eCommerceIndicatorE-commerce indicator for the transaction.
MerchantIDCybersource merchant ID used for the transactions.
MerchantReferenceNumberMerchant-generated order reference or tracking number.
PartnerOriginalTransactionIDTransaction ID from the partner.
PartnerSDKVersionSDK version used to process the transaction.
RequestIDID for the transaction request.
SourceSource of request.
SubscriptionIDID for the customer profile.
TerminalSerialNumberSerial number of the terminal.
TransactionDateDate on which the transaction occurred.
TransactionIDID of the transaction.
TransactionRefNumberTransaction reference number.
TransactionTypeType of transaction.
UserInformation about a user.

Risk Fields

Risk Fields

Field names in this group are prepended with Risk.

Field NameDescription
AppliedAVSIndicates whether or not Address Verification Service rules were applied to the transaction.
AppliedCategoryGiftImportance of billing and shipping addresses in assessing the order. If no value is specified in the request, the server uses the default value for the merchant ID.
AppliedCategoryTimeImportance of time of day in assessing the order. If no value is specified in the request, the server uses the default value for the merchant ID.
AppliedCVIndicates whether or not card verification was applied to the transaction.
AppliedHostHedgeImportance of email and IP addresses of the customer in assessing the order. If no value is specified in the request, the server uses the default value for the merchant ID.
AppliedThresholdScore threshold applied to the order.
AppliedTimeHedgeImportance of time of day in assessing the order. If no value is specified in the request, the server uses the default value for the merchant ID.
AppliedVelocityHedgeImportance of the number of orders from the customer in a specific time period in assessing the order. If no value is specified in the request, the server uses the default value for the merchant ID.
BinAccountTypeType of customer.
BinCountryCountry (two-digit country code) associated with the BIN of the customer's card used for the payment.
BinIssuerName of the bank or entity that issued the card account.
BinSchemeSubtype of card account.
CodeTypeCategory of information code returned for an order.
CodeValueDescription of the information code returned in the CodeType element.
ConsumerLoyaltyIndicates whether a loyalty program is used or the number of the loyalty reward account that is used.
ConsumerPasswordProvidedReserved for future use.
ConsumerPromotionsReserved for future use.
CookiesAcceptedIndicates whether the customer's web browser accepts cookies. Possible values: true: The customer's browser accepts cookies, false: The customer's browser does not accept cookies.
CookiesEnabledIndicates whether cookies are enabled in the customer's browser.
DeviceFingerPrintIndicates whether Device Fingerprint is used.
FactorsInformation that affected the score of the order.
FlashEnabledIndicates whether Flash is enabled in the customer's browser.
GiftWrapReserved for future use.
HostSeverityRisk associated with the customer's email domain.
ImagesEnabledIndicates whether images are enabled in the customer's browser.
IPCityName of the city decoded from the IP address used directly or indirectly by the customer to send the order.
IPCountryName of the country decoded from the IP address used directly or indirectly by the customer to send the order.
IPRoutingMethodRouting method decoded from the IP address used directly or indirectly by the customer to send the order.
IPStateName of the state decoded from the IP address used directly or indirectly by the customer to send the order.
JavascriptEnabledIndicates whether JavaScript is enabled in the customer's browser.
LostPasswordReserved for future use.
ProductRiskIndicates the level of risk for the product. Possible values: low: The product is associated with few chargebacks, normal: The product is associated with a normal number of chargebacks, high: The product is associated with many chargebacks.
ProxyIPAddressIP address of the proxy if it is available.
ProxyIPAddressActivitiesActions associated with the proxy IP address.
ProxyIPAddressAttributesCharacteristics associated with the proxy IP address.
ProxyServerTypeType of proxy server based on the HTTP header.
RepeatCustomerReserved for future use.
ReturnsAcceptedIndicates whether returns are accepted for this order. Possible values: true: Returns are accepted for this order, false: Returns are not accepted for this order.
ScoreTotal score calculated for the order.
TimeLocalLocal time of order.
TrueIPAddressCustomer's true IP address detected by the application.
TrueIPaddressActivitiesActions associated with the true IP address.
TrueIPAddressAttributesCharacteristics associated with the true IP address.
TrueIPAddressCityCity associated with the true IP address.
TrueIPAddressCountryCountry associated with the true IP address.

SCA Exemption Fields

SCA Exemption Fields
Field NameDescription
SCAExemptionReason that 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
SCAExemptionValuesNumber indicating whether the associated SCA exemption was included in the transaction. Possible values: 0: Not exempt, 1: Exempt

Sender Fields

Sender Fields
Field NameDescription
AddressSender address.
CitySender city.
CountrySender country.
DOBSender date of birth.
FirstNameSender first name.
LastNameSender last name.
MiddleInitialSender name middle initial.
PhoneNumberSender phone number.
PostalCodeSender postal code.
SenderReferenceNumberReference number generated by the merchant that uniquely identifies the sender.
SourceOfFundsSource of funds.
StateSender state.

Settlement Fields

Settlement Fields

Field names in this group are prepended with Settlement.

Field NameDescription
SettlementAgeSettlement aging.
SettlementAmountAmount that is settled for transaction.
SettlementCurrencyCodeCurrency code that is applied to settlement.
SettlementDateDate on which settlement is applied.
SourceResponseCodeResponse code that is sent from source.
SourceResponseMessageResponse message that is sent from source.
StatusSettlement status. Possible values: S: Success, P: Pending, F: Failed

Ship To Fields

Ship To Fields

Field names in this group are prepended with ShipTo.

Field NameDescription
Address1Shipping address first line.
Address2Shipping address second line.
CityShipping city.
CompanyNameName of company.
CountryShipping address country.
FirstNameRecipient first name.
LastNameRecipient last name.
PhoneRecipient phone number.
StateShipping address state or province.
ZipShipping address ZIP/postal code.

Shipping Fields

Shipping Fields

Field names in this group are prepended with Shipping.

Field NameDescription
CarrierCarrier that is used to ship product.
MethodShipping method for the product.

TMS Token Fields

TMS Token Fields

Field names in this group are prepended with TMSToken.

Field NameDescription
CreatorOrganization ID or merchant ID of the organization or merchant that created the TMS token.
CustomerIDTMS customer token ID.
InstrumentIdentifierIDUnique identifier for the instrument identifier.
InstrumentIdentifierStateCurrent state of the instrument identifier token.
PaymentInstrumentIDTMS payment instrument token ID.
ShippingAddressIDTMS shipping address token ID.
VaultIDUnique identifier for the vault to which the token belongs.

Token Fields

Token Fields

Field names in this group are prepended with Token.

Field NameDescription
NetworkTokenTransTypeNetwork token transaction type.
TokenCodeTransaction token code.

Travel Fields

Travel Fields

Field names in this group are prepended with Travel.

Field NameDescription
CompleteRouteConcatenation of individual travel legs.
DepartureDateTimeFirst leg departure date and time.
JourneyTypeType of travel.
NumberPassenger number.
PassengerFirstNamePassenger's first name.
PassengerEmailPassenger's email address, including the complete domain name.
PassengerIdTicketed passenger ID.
PassengerLastNamePassenger's last name.
PassengerPhonePassenger's phone number.
PassengerStatusCompany's passenger classification, such as frequent flyer.
PassengerTypePassenger classification associated with the price of the ticket.

Verify Enrollment Request Fields

Verify Enrollment Request Fields

Field names in this group are prepended with VEReq.

Field NameDescription
AcquirerBinAcquiring bank ID number.
MerchantIDMerchant ID.
PanCustomer masked account number.

Verify Enrollment Response Fields

Verify Enrollment Response Fields

Field names in this group are prepended with VERes.

Field NameDescription
AccountIDAccount ID.
AcsUrlACS URL.
EnrolledIndicates that enrollment is verified.

Last published: September 29, 2026