On This Page
Payment Data Fields
Field Name | Description | Data Type (Length) |
---|---|---|
AAV_CAVV | Optional authentication data that
you can receive after the customer is authenticated. | VARCHAR2 (3) |
ACHVerificationResult | Raw result of the ACH Verification
service. | — |
ACHVerificationResult
Mapped | 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. | String (15) |
Amount | Grand total for the order. | Number (19) |
AuthIndicator | — | — |
AuthorizationCode | Authorization code for the
payment. | VARCHAR2 (15) |
AuthorizationType | Authorization type of the
payment. | VARCHAR2 (1) |
AuthReversalAmount | — | — |
AuthReversalResult | — | — |
AVSResult | Raw code for Address Verification
Service result for the payment. | VARCHAR2 (10) |
AVSResultMapped | Address Verification Service result
for the payment. | VARCHAR2 (5) |
BalanceAmount | Remaining balance on the
account. | Number (19) |
BalanceCurrencyCode | Currency of the remaining balance on
the account. | VARCHAR2 (3) |
BankAccountName | Name of account holder. | VARCHAR2 (90) |
BankCode | Bank code or sort code for the
account if a bank account was used for the transaction. | VARCHAR2 (15) |
BatchFilesID | — | — |
BinNumber | Bank identification number. | VARCHAR2 (8) |
CardCategory | Type of card used in the
transaction. | VARCHAR2 (10) |
CardCategoryCode | Category code of card used in the
transaction. | — |
CardPresent | Indicates whether the card is
present at the time of the transaction. | String (1) |
CardVerificationMethod | — | — |
CurrencyCode | Currency code for the
payment. | VARCHAR2 (3) |
CustomerAccountID | — | — |
CVResult | CVN result code. | — |
DCCIndicator | Flag that indicates whether DCC is
being used for the transaction. | VARCHAR2 (1) |
ECI | Optional information that you can
receive if you use the Payer Authentication service. | Number (5) |
eCommerceIndicator | Type of eCommerce
transaction. | CHAR (1) |
EMVRequestFallback | Indicates that a fallback method was
used to enter credit card information into the POS terminal. | String (5) |
EVEmail | Mapped Electronic Verification
response code for the customer’s email address. | VARCHAR2 (5) |
EVEmailRaw | Raw Electronic Verification response
code from the processor for the customer’s email address. | VARCHAR2 (10) |
EventType | Type of event that occurred for the
transaction. | — |
EVName | Mapped Electronic Verification
response code for the customer’s name. | VARCHAR2 (5) |
EVNameRaw | Raw Electronic Verification response
code from the processor for the customer’s last name. | VARCHAR2 (10) |
EVPhoneNumber | Mapped Electronic Verification
response code for the customer’s phone number. | VARCHAR2 (5) |
EVPhoneNumberRaw | Raw Electronic Verification response
code from the processor for the customer’s phone number. | VARCHAR2 (10) |
EVPostalCode | Mapped Electronic Verification
response code for the customer’s postal code. | VARCHAR2 (5) |
EVPostalCodeRaw | Raw Electronic Verification response
code from the processor for the customer’s postal code. | VARCHAR2 (10) |
EVStreet | Mapped Electronic Verification
response code for the customer’s street address. | VARCHAR2 (5) |
EVStreetRaw | Raw Electronic Verification response
code from the processor for the customer’s street address. | VARCHAR2 (10) |
ExchangeRate | Exchange rate. | Number (27) |
ExchangeRateDate | Time stamp for the exchange
rate. | Date |
GrandTotal | Grand total amount for the order,
including tax, for requests that do not contain payment information. | Number (19) |
IssuerResponseCode | Additional authorization code that
must be printed on the receipt when returned by the processor. | VARCHAR2 (15) |
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. | VARCHAR2 (3) |
OriginalAmount | — | — |
OriginalCurrency | — | — |
PaymentProcessor | Name of payment processor. | VARCHAR2 (40) |
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. | Number (26) |
PinType | Method that was used to verify the
cardholder's identity. | Integer (1) |
POSCatLevel | Type of cardholder-activated
terminal. | Non-negative Integer (1) |
POSEntryMode | Method of entering credit card
information into the POS terminal. | String (11) |
POSEnvironment | Operating environment. | String (1) |
POSTerminalCapability | POS terminal’s
capability. | — |
ProcessorMID | — | — |
ProcessorResponseCode | The error message sent directly from
the bank. | VARCHAR2 (60) |
ProcessorResponseID | Response ID sent from the
processor. | VARCHAR2 (50) |
ProcessorTID | Transaction identification (TID)
that is used to identify and track a transaction throughout its life
cycle. | VARCHAR2 (60) |
ProcessorTransactionID | — | — |
RequestedAmount | Amount requested to be
authorized. | Number (19) |
RequestedAmountCurrencyCode | Currency for the amount requested to
be authorized. | VARCHAR2 (5) |
RoutingNetworkType | Processor scheme used for routing
the transaction. | String (1) |
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. | String (5) |
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. | String (1) |
SubsequentAuthFirst | Indicates whether the customer
initiated the transaction and whether the credentials are stored for future
authorizations. | String (1) |
SubsequentAuthReason | Reason for the merchant-initiated
transaction or incremental authorization. | String (1) |
SubsequentAuthStoredCredential | Indicates whether you obtained the
payment information from credentials on file (COF) instead of from the
customer. | String (1) |
SubsequentAuthTransactionID | Network transaction identifier that
was returned for a previous authorization in the series. | String (15) |
TargetAmount | Converted amount. | Number (19) |
TargetCurrency | Billing currency. | VARCHAR2 (3) |
TerminalIDAlternate | Identifier for an alternate terminal
at your retail location. | String (8) |
TotalTaxAmount | Total tax amount for all of the line
items in the transaction. | Number (19) |
TransactionRefNumber | Reference number for the
transaction. | VARCHAR2 (60) |
XID | Optional transaction identifier
generated by Payer Authentication that you can receive when the customer is
enrolled and when validation is successful. | VARCHAR2 (40) |