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
- Authorization Results Fields
- Bank Information Fields
- Batch Fields
- Bill To Fields
- Chargeback and Retrieval Fields
- Check Fields
- Conversion Fields
- Deposit Fields
- Device Fields
- Event Fields
- Exception Fields
- Fee Fields
- Fee Summary Fields
- Fund Transfer Fields
- Funding Fields
- Gift Card Fields
- Healthcare Fields
- Invoice Fields
Application Fields
Application Fields
| Field Name | Description |
|---|---|
Name | Name of application used. |
Rcode | One-digit code indicating whether the entire request was successful. |
ReasonCode | Numeric value that corresponds to the result of the overall request. |
Rflag | One-word description of the result of the entire request. |
Rmsg | Message that explains the ics_flag value. |
Authorization Results Fields
Authorization Results Fields
| Field Name | Description |
|---|---|
AVSResult | Optional results of address verification test. |
CVVResult | Optional results of card verification number test. |
Bank Information Fields
Bank Information Fields
Field names in this group are prepended with BankInfo.
| 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
Batch Fields
| Field Name | Description |
|---|---|
BatchDate | Date when the batch was sent to the processor. |
BatchID | Batch in which the transaction was sent. |
Status | Status of batch file. |
SuccessFlag | Indicates whether batch file processing was successful. |
Bill To Fields
Bill To Fields
Field names in this group are prepended with BillTo.
| 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 | Your 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 five to nine digits. |
Chargeback and Retrieval Fields
Chargeback and Retrieval Fields
| Field Name | Description |
|---|---|
AdjustmentAmount | Amount of the chargeback adjustment. |
AdjustmentARN | Association reference number. |
AdjustmentCurrency | Currency of the chargeback adjustment. |
CaseIdentifier | Numerical identifier created by Cybersource 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
Check Fields
Field names in this group are prepended with Check.
| Field Name | Description |
|---|---|
BankTransitNumber |  |
AccountEncoderID | Identifier for the bank that provided the customer's encoded account number. |
SecCode | Authorization method used for the transaction. |
Conversion Fields
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. |
Deposit Fields
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. Use the 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
Device Fields
| Field Name | Description |
|---|---|
DeviceID | Identification number of device used for transaction. |
Event Fields
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
Exception Fields
| Field Name | Description |
|---|---|
Action | Brief description of the action. |
ClientID | ID of the client. |
CYBSExceptionID | Exception ID number assigned by . |
DccLookupStatus | DCC lookup status of the transaction. |
DccExchangeRate | DCC exchange rate of the transaction. |
DccMarginRate | DCC margin rate of the transaction. |
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 | Description of exception. |
ExceptionDeviceHardwareRevision | Hardware revision number of the device. |
ExceptionDeviceID | ID of the device. |
ExceptionDeviceOS | Operating system of the device. |
ExceptionDeviceOSVersion | Operating system version of the device. |
ExceptionDeviceTerminalID | Device Terminal ID number. |
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 | Status code of the exception. |
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 | Merchant ID of partner. |
PartnerMerchantName | Merchant name of partner. |
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 | Scheme operator. |
SDKVersion | SDK version being used. |
SettlementProcessor | Name of settlement processor. |
StorageMechanism | Storage mechanism being used. |
Fee Fields
Fee Fields
| Field Name | Description |
|---|---|
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. |
DiscountAmount | DiscountRate × TransactionAmount. This value includes four 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 |
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. |
PerItemFeeAmount | Fee for a single item. |
PerItemFeeCurrency | Currency for a single item fee. |
PricedInterchangeLevel | Interchange flat rate assigned during account setup. This value includes four decimal points. |
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 | Source descriptor for transaction. |
TotalFeeAmount | Total amount of all fee transactions for the specified date range. |
TotalFeeCurrency | Currency for all fee transactions for the specified date range. |
Fee Summary Fields
Fee Summary Fields
| Field Name | Description |
|---|---|
CardType | Card type. |
Count | Count. |
FeeDescription | Fee description. |
FeeType | Fee type. |
FundingCurrency | Currency in which fees are applied. |
PaymentMethod | Payment method used. |
PercentageFee | Percentage fee charged. |
PerItemFee | Fee charged per item. |
TotalFeeAmount | Total fee amount. |
TransactionAmount | Transaction amount. |
TransactionType | Transaction type. |
Fund Transfer Fields
Fund Transfer Fields
Field names in this group are prepended with FundTransfer.
| Field Name | Description |
|---|---|
BankCheckDigit | Code used to validate the customer's account number. |
IbanIndicator | International Bank Account Number (IBAN). |
Funding Fields
Funding Fields
Field names in this group are prepended with Funding.
| 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 |
Gift Card Fields
Gift Card Fields
| Field Name | Description |
|---|---|
CurrentBalance | Current gift card balance in the local currency. |
PreviousBalance | Previous 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. |
RedemptionType | Type of redemption. Possible values: CASHOUT, REDEMPTION, REDEMPTION_PARTIAL_ALLOWED (default). This field is supported only on ValueLink. |
Healthcare Fields
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
Invoice Fields
Field names in this group are prepended with Invoice.
| Field Name | Description |
|---|---|
BillingGroupDescription | Description of the billing group. |
NotProcessed | Number of unprocessed transactions. |
OrganizationID | Merchant ID. |
PerformedServices | Cybersource service name. |
Processed | Number of processed transactions. |
Total | Invoice count. |
JP Fields
Life Cycle Management Fields
Life Cycle Management Event Fields
Field names in this group are prepended with LifeCycleManagementEvent.
| Field Name | Description |
|---|---|
LCMEventDateProcessed | Date on which 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 that is applied. |
LCMEventUniqueID | Unique 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 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. |
Merchant Defined Data Fields
Merchant Defined Data Fields
| Field Name | Description |
|---|---|
MerchantDefinedData_field1 | Fields 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 Name | Description |
|---|---|
CardExpiryDate | Expiration date of the card. |
CardSuffix | Last four 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 on which 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 four digits of the network token. |
TokenUniqueID | Unique identifier for the network token. |
Payment Data Fields
Payment Data Fields
Field names in this group are prepended with PaymentData.
| Field Name | Description |
|---|---|
AAV_CAVV | Optional authentication data returned after the customer is authenticated. |
ACHVerificationResult | Raw result of the ACH verification service. |
ACHVerificationResultMapped | Mapped result of the ACH verification service. |
AcquirerMerchantID | Merchant ID of acquirer. |
AcquirerMerchantNumber | Merchant number of acquirer. |
Amount | Grand total for the order. |
AuthIndicator | Authorization indicator for the transaction. |
AuthorizationCode | Authorization code for the payment. |
AuthorizationType | Authorization type of the payment. |
AuthReversalAmount | Authorization reversal amount. |
AuthReversalResult | Result of the authorization reversal. |
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 bank account. |
BankCode | Code of bank branch. |
BinNumber | Bank identification number. In the , this field is called AccountPrefix. |
CardCategory | Type of card used in the transaction. |
CardCategoryCode | Category code of card used in the transaction. |
CardPresent | Card-present transaction indicator. |
CardVerificationMethod | Card verification method used. |
CurrencyCode | Currency code for the payment. |
CVResult | CVN result code. |
DCCIndicator | Flag that indicates whether Dynamic Currency Conversion is being used for the transaction. |
DomesticRouting | Flag indicates whether the transaction was routed domestically. |
| ECI | Optional information that you can receive if you use the Payer Authentication service. |
eCommerceIndicator | Type of e-commerce transaction. |
EMVRequestFallback | EMV request fallback indicator. |
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 | Response code of issuer. |
MandateReferenceNumber | Mandate reference number. |
NetworkCode | Network code. |
NumberOfInstallments | Total number of installments when making payments in installments. |
PaymentProcessor | Name of payment processor. |
PaymentProductCode | Type of payment product used by the consumer to pay on a payment provider's website, such as installments or bank transfer. |
PaymentRequestID | Original request ID for the purchase. |
PinType | Type of PIN entry. |
POSCatLevel | Category of point of sale (POS). |
POSEntryMode | POS entry mode. |
POSEnvironment | POS environment. |
ProcessorMID | Processor merchant ID. |
ProcessorResponseCode | The error message sent directly from the bank. |
ProcessorResponseID | Response ID sent from the processor. |
ProcessorTID | Transaction ID (TID) that is used to identify and track a transaction throughout its life cycle. |
ProcessorTransactionID | Processor transaction ID. |
RequestedAmount | Amount requested to be authorized. |
RequestedAmountCurrencyCode | Currency for the amount requested to be authorized. |
RoutingNetworkType | Type of routing network. |
StoreAndForwardIndicator | Indicates whether store-and-forward is used for transaction. |
SubMerchantCity | Sub-merchant's city. |
SubMerchantCountry | Sub-merchant's country. |
SubMerchantEmail | Sub-merchant's email address. |
SubMerchantID | Sub-merchant's ID. |
SubMerchantName | Sub-merchant's name. |
SubMerchantPhone | Sub-merchant's phone number. |
SubMerchantPostalCode | Sub-merchant's postal code. |
SubMerchantState | Sub-merchant's state. |
SubMerchantStreet | Sub-merchant's street address. |
SurchargeFee | Surcharge fee amount. |
SurchargeFeeSign | Sign (+ or -) of the surcharge amount. |
TargetAmount | Converted amount. |
TargetCurrency | Billing currency. |
TerminalIDAlternate | Alternate terminal ID. |
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
Payment Method Fields
Field names in this group are prepended with PaymentMethod.
| Field Name | Description |
|---|---|
AccountSuffix | Last four digits of the customer's payment account number. |
BankAccountName | Bank's account name. |
BankCode | Bank's code. Used for some countries when the IBAN is not used. Cybersource customer support can provide required country-specific bank account information. |
BoletoBarCodeNumber | Numeric representation of the boleto barcode. |
BoletoNumber | Boleto Bancário payment number. |
CardCategory | Type of card used. |
CardCategoryCode | Code for card type used. |
CardType | Type of card to authorize. |
CheckNumber | Check number. |
ExpirationMonth | Two-digit month in which the credit card expires. |
ExpirationYear | Four-digit year in which the credit card expires. |
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. |
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. |
WalletType | Type of wallet. |
POS Terminal Exceptions Fields
POS Terminal Exceptions Fields
Field names in this group are prepended with POSTerminalExceptions.
| Field Name | Description |
|---|---|
POSTerminalException.BillToEmail | Email address of the user. |
CardVerificationMethod | Type of customer verification. |
ClientID | Client identifier for an installation. Generated by the operating system. |
DCCExchangeRate | Dynamic Currency Conversion (DCC) exchange rate. |
DCCLookupStatus | Lookup Status of DCC. |
DCCMarginRate | Margin rate of DCC. |
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 removed from the serial number. |
DeviceOS | Operating system of the device. |
DeviceOSVersion | Operating system version of the device. |
DeviceTerminalID | Terminal ID assigned to the credit card reader. It is 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. |
LocalCurrencyCode | Three-digit security code for the local currency. |
MerchantID | Merchant ID. |
PartnerMerchantID | Three-digit ID for the partner merchant. |
PartnerMerchantName | Name of the merchant that performed the transaction. |
PartnerOriginalTransactionID | Unique ID for the transaction. |
ProcessorMID | Merchant ID of the merchant that performed the transaction. Assigned by the clearing institute. |
POSTerminalException.RequestID | Unique ID 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 ID of the merchant that performed the transaction. |
TransactionDate | Date of the transaction. |
Profile Fields
Profile Fields
Field names in this group are prepended with Profile.
| 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
Proof XML Fields
Field names in this group are prepended with ProofXML.
| Field Name | Description |
|---|---|
AcquirerBin | Acquiring bank identification number. |
Date | Transaction date. |
DirectoryServerURL | Directory server URL. |
Enrolled | Enrollment indicator. |
MerchantID | Cybersource merchant ID used for transaction. |
Pan | Customer masked account number. |
Password | Password. |
Recipient Fields
Recipient Fields
Field names in this group are prepended with Recipient.
| 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. |
Request Fields
Request Fields
Field names in this group are prepended with Request.
| Field Name | Description |
|---|---|
Comments | Optional comments about the subscription or customer profile. |
eCommerceIndicator | E-commerce indicator for the transaction. |
MerchantID | Cybersource merchant ID used for the transactions. |
MerchantReferenceNumber | Merchant-generated order reference or tracking number. |
PartnerOriginalTransactionID | Transaction ID from the partner. |
PartnerSDKVersion | SDK version used to process the transaction. |
RequestID | ID for the transaction request. |
Source | Source of request. |
SubscriptionID | ID for the customer profile. |
TerminalSerialNumber | Serial number of the terminal. |
TransactionDate | Date on which the transaction occurred. |
TransactionID | ID of the transaction. |
TransactionRefNumber | Transaction reference number. |
TransactionType | Type of transaction. |
User | Information about a user. |
Risk Fields
Risk Fields
Field names in this group are prepended with Risk.
| Field Name | Description |
|---|---|
AppliedAVS | Indicates whether or not Address Verification Service rules were applied to the transaction. |
AppliedCategoryGift | Importance 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. |
AppliedCategoryTime | Importance 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. |
AppliedCV | Indicates whether or not card verification was applied to the transaction. |
AppliedHostHedge | Importance 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. |
AppliedThreshold | Score threshold applied to the order. |
AppliedTimeHedge | Importance 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. |
AppliedVelocityHedge | Importance 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. |
BinAccountType | Type of customer. |
BinCountry | Country (two-digit country code) associated with the BIN of the customer's card used for the payment. |
BinIssuer | Name of the bank or entity that issued the card account. |
BinScheme | Subtype of card account. |
CodeType | Category of information code returned for an order. |
CodeValue | Description of the information code returned in the CodeType element. |
ConsumerLoyalty | Indicates whether a loyalty program is used or the number of the loyalty reward account that is used. |
ConsumerPasswordProvided | Reserved for future use. |
ConsumerPromotions | Reserved for future use. |
CookiesAccepted | Indicates 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. |
CookiesEnabled | Indicates whether cookies are enabled in the customer's browser. |
DeviceFingerPrint | Indicates whether Device Fingerprint is used. |
Factors | Information that affected the score of the order. |
FlashEnabled | Indicates whether Flash is enabled in the customer's browser. |
GiftWrap | Reserved for future use. |
HostSeverity | Risk associated with the customer's email domain. |
ImagesEnabled | Indicates whether images are enabled in the customer's browser. |
IPCity | Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. |
IPCountry | Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. |
IPRoutingMethod | Routing method decoded from the IP address used directly or indirectly by the customer to send the order. |
IPState | Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. |
JavascriptEnabled | Indicates whether JavaScript is enabled in the customer's browser. |
LostPassword | Reserved for future use. |
ProductRisk | Indicates 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. |
ProxyIPAddress | IP address of the proxy if it is 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. |
RepeatCustomer | Reserved for future use. |
ReturnsAccepted | Indicates whether returns are accepted for this order. Possible values: true: Returns are accepted for this order, false: Returns are not accepted for this order. |
Score | Total score calculated for the order. |
TimeLocal | Local time of order. |
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. |
SCA Exemption Fields
SCA Exemption Fields
| Field Name | Description |
|---|---|
SCAExemption | Reason 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 |
SCAExemptionValues | Number indicating whether the associated SCA exemption was included in the transaction. Possible values: 0: Not exempt, 1: Exempt |
Sender Fields
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 the merchant that uniquely identifies the sender. |
SourceOfFunds | Source of funds. |
State | Sender state. |
Settlement Fields
Settlement Fields
Field names in this group are prepended with Settlement.
| Field Name | Description |
|---|---|
SettlementAge | Settlement aging. |
SettlementAmount | Amount that is settled for transaction. |
SettlementCurrencyCode | Currency code that is applied to settlement. |
SettlementDate | Date on which settlement is applied. |
SourceResponseCode | Response code that is sent from source. |
SourceResponseMessage | Response message that is sent from source. |
Status | Settlement 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 Name | Description |
|---|---|
Address1 | Shipping address first line. |
Address2 | Shipping address second line. |
City | Shipping city. |
CompanyName | Name of company. |
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. |
Shipping Fields
Shipping Fields
Field names in this group are prepended with Shipping.
| Field Name | Description |
|---|---|
Carrier | Carrier that is used to ship product. |
Method | Shipping method for the product. |
TMS Token Fields
TMS Token Fields
Field names in this group are prepended with TMSToken.
| Field Name | Description |
|---|---|
Creator | Organization ID or merchant ID of the organization or merchant that created the TMS token. |
CustomerID | TMS customer token ID. |
InstrumentIdentifierID | Unique identifier for the instrument identifier. |
InstrumentIdentifierState | Current state of the instrument identifier token. |
PaymentInstrumentID | TMS payment instrument token ID. |
ShippingAddressID | TMS shipping address token ID. |
VaultID | Unique identifier for the vault to which the token belongs. |
Token Fields
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
Travel Fields
Field names in this group are prepended with Travel.
| 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 ID. |
PassengerLastName | Passenger's last name. |
PassengerPhone | Passenger's phone number. |
PassengerStatus | Company's passenger classification, such as frequent flyer. |
PassengerType | Passenger 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 Name | Description |
|---|---|
AcquirerBin | Acquiring bank ID number. |
MerchantID | Merchant ID. |
Pan | Customer masked account number. |
Verify Enrollment Response Fields
Verify Enrollment Response Fields
Field names in this group are prepended with VERes.
| Field Name | Description |
|---|---|
AccountID | Account ID. |
AcsUrl | ACS URL. |
Enrolled | Indicates that enrollment is verified. |
Thanks for your feedback!
Last published: September 29, 2026