name |
type |
description |
trackData |
string |
data that has been read from the card's magnetic stripe. |
number |
string |
credit card account number. |
cvv |
string |
card security code. |
expirationDate |
string |
expiration date for the card. Format: MM/YYYY. |
creditCardType |
string |
card type of the payment account. |
ksn |
string |
unaltered KSN Number from PIN pad. (Debit and EBT only.) |
pinblock |
string |
pinblock obtained from the PIN pad. (Debit and EBT only.) |
firstName |
string |
first name of the account holder. |
lastName |
string |
last name of the account holder. |
address |
object |
billing address of the account holder. |
emv
|
object |
Every chip card transaction contain dozens of pieces of information to be exchanged between the card, the terminal and the acquiring bank or processors host. (EMV Only) |
signature |
image |
image of the signature of the cardholder as completed at the time of the transaction. |
email |
string |
email address of the account holder. |
emailReceipt |
boolean |
enable or disable the functionality to send reciept via email. |
contactlessIndicator |
string |
Indicates the channel in which the card was input.
Indicates the channel in which the card was input.Valid values for this parameter are:
0 - Contact
1 - Contactless
|
isDebit |
string |
Indicates whether the card should be processed as a debit card.
Valid values for this parameter are:
0 - Credit
1 - Debit
|
fallbackIndicator |
string |
Indicates if the chip failed and the transaction was entered as mag stripe. Valid values for this parameter are:
0 - No Fallback
1 - Fallback
|
name |
type |
description |
applicationCryptogram |
string |
Cryptogram returned by the ICC in response of the GENERATE AC command. Tag 9F26. |
applicationInterchangeProfile |
string |
Indicates the capabilities of the card to support specific functions in the application. Tag 82. |
applicationTransactionCounter |
string |
Counter maintained by the application in the ICC (incrementing the ATC is managed by the ICC). Tag 9F36. |
cardSequenceNumber |
string |
This field identifies the card when multiple plastics are associated with a single account number. Tag 5F34. |
cryptogramCashBackAmount |
string |
Secondary amount associated with the transaction representing a cashback amount. Tag 9F03. |
cryptogramInformationData |
string |
Indicates the type of cryptogram and the actions to be performed by the terminal. Tag 9F27. |
cryptogramTerminalCountryCode |
string |
Indicates the country of the terminal, represented according to ISO 3166. Tag 9F1A. |
cryptogramTransactionAmount |
string |
Clearing amount of the transaction, including tips and other adjustments. Tag 9F02. |
cryptogramTransactionDate |
string |
Local date that the transaction was authorized. Tag 9A. |
cryptogramTransactionType |
string |
Indicates the type of financial transaction, represented by the first two digits of the ISO 8583:1987 Processing Code. The actual values to be used for the Transaction Type data element are defined by the relevant payment system. Tag 9C. |
cryptogramTransactioncurrencyCode |
string |
Indicates the currency code of the transaction according to ISO 4217. Tag 5F2A. |
formFactorIndicator |
string |
Personalized on the card and carries additional information about the contactless device, its security features, and technology used to acquire the transaction. Tag 9F6E. |
issuerApplicationData |
string |
Contains proprietary application data for transmission to the issuer in an online transaction. Note: For CCD-compliant applications, Annex C, section C7 defines the specific coding of the Issuer Application Data (IAD). To avoid potential conflicts with CCD-compliant applications, it is strongly recommended that the IAD data element in an application that is not CCD-compliant should not use the coding for a CCD-compliant application. Tag 9F10. |
terminalCapabilityProfile |
string |
Indicates the card data input, CVM, and security capabilities of the terminal. Tag 9F33. |
terminalVerificationResults |
string |
Status of the different functions as seen from the terminal. Tag 95. |
track2EquivalentDataChip |
string |
Contains the data elements of track 2 according to ISO/IEC 7813, excluding start sentinel, end sentinel, and Longitudinal Redundancy Check (LRC), as follows:Primary Account Number Field Separator (Hex 'D') Expiration Date (YYMM) Service Code Discretionary Data (defined by individual payment systems) Pad with one Hex 'F' if needed to ensure whole bytes. Tag 57. |
unpredictableNumber |
string |
Value to provide variability and uniqueness to the generation of a cryptogram. Tag 9F37. |
applicationIdentifier |
string |
Identifies the application as described in ISO/IEC 7816-5. Tag 9F06. |
transactionStatusIndicator |
string |
Indicates the functions performed in a transaction. Tag 9B. |
applicationName |
string |
Preferred mnemonic associated with the AID. Tag 9F12. |
cardEntryMode |
string |
Indicates chip / contact-less / keyed / swipe, including fallback if used. |
authorizationMode |
string |
Indicates Online / Offline. |
cardholderVerification |
string |
Identifies a method of verification of the cardholder supported by the application. |
name |
type |
description |
typeOfGoods |
string |
type of goods that are being purchased. Valid values are DIGITAL or PHYSICAL. |
additionalTerminalInfo |
object |
additional terminal information. Required to process checks when using the SEC code POINT_OF_SALE. |
levelTwoData |
object |
information related to level two processing. |
levelThreeData |
object |
information related to level three processing. |
deviceCode |
string |
device code of the device where the transaction originated. |
entrySource |
string |
entry source of the transaction. |
mailOrTelephoneOrderData |
object |
additional data for remote orders. Required in the case of a mail, phone, or ecommerce transaction. |
serviceData |
object |
restaurant-related transaction information. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields that can be sent with the transaction for reporting purposes. |
notes |
string |
notes associated with the transaction. |
invoiceNumber |
string |
invoice number. |
invoiceDescription |
string |
invoice description. |
softDescriptor |
string |
displays a description in addition to the merchants DBA. Maximum length is 18 characters. ASCII characters supported, with the exception of spaces. |
dynamicMCC |
string |
displays a 4 characters dynamic merchant category code. |
ebtData |
object |
information related to EBT transactions. |
name |
type |
description |
cycleType |
string |
time unit of billing cycle. Valid values are: WEEKLY MONTHLY QUARTERLY SEMI_ANNUALLY ANNUALLY |
startDate |
dateTime |
plan start date. |
dayOfTheMonth |
numeric |
day of the month on which the plan is set to bill. |
dayOfTheWeek |
numeric |
day of the week on which the plan is set to bill. |
month |
string |
month the plan is set to bill. |
frequency |
numeric |
frequency (in terms of cycles) with which to bill the account. Valid values are:
If cycleType = MONTHLY: 1 - 11 (e.g., 2 = every 2 months)
if cycleType = WEEKLY: 1 - 51 (e.g., 6 = every 6 weeks)
For cycleType = QUARTERLY, SEMI_ANNUALLY and ANNUALLY, frequency is set to 1 automatically.
|
totalAmount |
decimal |
total amount to be billed under the plan. |
numberOfPayments |
numeric |
total number of installments in the plan. |
installmentAmount |
decimal |
individual installment amount. |
balloonAmount |
decimal |
balloon amount. |
balloonPaymentAddedTo |
string |
indicates whether the balloon payment is to be applied to the first or last payment:
0 - add balloon amount to first payment
1 - add balloon amount to last payment
|
remainderAmount |
decimal |
amount of the final payment. |
remainderPaymentAddedTo |
string |
indicates whether the remainder should be applied to the first or last payment if installments are not equally divided:
0 - add remainder to first payment
1 - add remainder to last payment
|
active |
boolean |
sets the Plan Active or Inactive |
notes |
string |
notes associated with the plan. |
softdescriptor |
string |
displays a description in addition to the merchants DBA. |
dynamicMCC |
string |
displays a 4 characters dynamic merchant category code. |
planId |
int |
plan identifier. Auto-generated by the system and given to the merchant when the plan is added. |
nextPaymentDate |
dateTime |
next scheduled payment date. |
maxRetries |
int |
number of times to retry billing if payment is declined. |
primaryPaymentMethodId |
string |
primary payment method to be used for billing. |
secondaryPaymentMethodId |
string |
secondary payment method to be used for billing. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields tied to the plan, which can be used for reporting. |
name |
type |
description |
amount |
decimal |
amount to be billed under the plan. |
cycleType |
string |
time unit of billing cycle. Valid values are: WEEKLY MONTHLY QUARTERLY SEMI_ANNUALLY ANNUALLY |
dayOfTheMonth |
numeric |
day of the month on which the plan is set to bill. |
dayOfTheWeek |
numeric |
day of the week on which the plan is set to bill. |
month |
string |
month the plan is set to bill. |
frequency |
numeric |
frequency (in terms of cycles) with which to bill the account. Valid values are:
If cycleType = MONTHLY: 1 - 11 (e.g., 2 = every 2 months)
if cycleType = WEEKLY: 1 - 51 (e.g., 6 = every 6 weeks)
For cycleType = QUARTERLY, SEMI_ANNUALLY and ANNUALLY, frequency is set to 1 automatically.
|
endDate |
datetime |
plan end date. |
active |
boolean |
sets the Plan Active or Inactive |
notes |
string |
notes associated with the plan. |
softdescriptor |
string |
displays a description in addition to the merchants DBA. |
dynamicMCC |
string |
displays a 4 characters dynamic merchant category code. |
planId |
int |
plan identifier. Auto-generated by the system and given to the merchant when the plan is added. |
startDate |
dateTime |
plan start date. |
nextPaymentDate |
dateTime |
next scheduled payment date. |
maxRetries |
int |
number of times to retry billing if payment is declined. |
primaryPaymentMethodId |
string |
primary payment method to be used for billing. |
secondaryPaymentMethodId |
string |
secondary payment method to be used for billing. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields tied to the plan, which can be used for reporting. |
name |
type |
description |
secureNetId |
number |
merchant account identifier. |
transactionType |
fixed string |
transaction type identifier. |
responseText |
string |
transaction approval status. |
orderId |
string |
client-generated unique ID for each transaction, used as a way to prevent the processing of duplicate transactions. The orderId must be unique to the merchant's SecureNet ID; however, uniqueness is only evaluated for APPROVED transactions and only for the last 30 days. If a transaction is declined, the corresponding orderId may be used again.
The orderId is limited to 25 characters; e.g., “CUSTOMERID MMddyyyyHHmmss”. |
transactionId |
number |
transaction identifier. |
authorizationCode |
string |
authorization approval code. |
authorizedAmount |
number |
authorized amount. |
allowedPartialCharges |
boolean |
indicates whether partial payments are to be accepted. |
paymentTypeCode |
fixed string |
credit card or check type. Valid values are:
ACH - Check
DB - PIN Debit
EBT - Electronic Benefit Transfer
PD - Pinless Debit
VI - VISA
MC - MasterCard
AX - American Express
DS - Discover
MCF - MasterCard Fleet
VIF - VISA Fleet
WX - Wex
VY - Voyager
SV - Stored Value
|
paymentTypeResult |
fixed string |
transaction method. Valid values are:
CHECK
CREDIT_CARD
DEBIT_CARD
EBT
FLEET_CARD
STORED_VALUE
UNKNOWN
|
level2Valid |
boolean |
indicates whether the credit card is level 2 eligible. |
level3Valid |
boolean |
indicates whether the credit card is level 3 eligible. |
transactionData |
object |
date/time and amount of the authorized transaction. |
settlementData |
object |
date/time, amount, and batchId of the settled transaction. |
vaultData |
object |
customer data and Vault token. |
creditCardType |
string |
identifies the credit card type. Valid values are:
VISA
VISAFLEET
MASTERCARD
MASTERCARDFLEET
AMEX
DISCOVER
|
cardNumber |
string |
last 4 digits of the credit card number. Format: XXXXXXXXXXXX 3456. |
avsCode |
string |
address verification code. Valid values are:
0 - AVS data not provided.
A - Street address matches, zip code does not
B - Postal code not verified due to incompatible formats
C - Street address and postal code not verified due to incompatible formats.
D - Street address and postal code match
E - AVS data is invalid
G - Non-U.S. issuing bank does not support AVS
I - Address information not verified by international issuer
M - Customer name, billing address and zip match
N - Neither street address nor zip code match
P - Street address not verified due to incompatible format
R - Retry: issuer's system unavailable or timed out
S - U.S. issuing bank does not support AVS
T - Street address does not match, but 9-digit zip code matches
U - Address information is unavailable
W - 9-digit zip matches, street address does not
X - Street address and 9-digit zip match
Y - Street address and 5-digit zip match
|
avsResult |
string |
address verification result. Valid values are:
NOT_CHECKED,
ADDRESS_INCORRECT,
ZIP_INCORRECT,
BOTH_INCORRECT,
MATCH
|
cardholder_firstName |
string |
first name of the cardholder. |
cardholder_lastName |
string |
last name of the cardholder. |
expirationDate |
string |
account expiration date. |
billAddress |
object |
billing address of the customer. |
email |
string |
email address of the customer. |
cardCodeCode |
string |
card security code result. Valid values are:
0 - CVV/CID not provided
M - Match
N - No match
P - Not processed
S - Data not present
U - Issuer unable to process request
Y - Card code matches (Amex only)
|
cardCodeResult |
string |
card security code result. Valid values are: MATCH NOT_MATCH NOT_CHECKED |
accountName |
string |
account name of the bank account. |
accountType |
string |
account type of the bank account. |
accountNumber |
string |
last 4 digits of the bank account number. |
checkNumber |
string |
individual check number. |
traceNumber |
string |
trace number of an ACH check transaction. |
surchargeAmount |
number |
surcharge amount to be added to the transaction. |
cashBackAmount |
number |
cash back amount given to a customer. Commonly used for debit transactions. |
gratuity |
number |
tip amount. |
industrySpecificData |
string |
industry-specific data for ecommerce and moto transactions.
For eCommerce transactions:
P - Physical goods
D - Digital goods
For MO/TO transactions:
0 - Default
1 - Single purchase transaction (AVS is required)
2 - Recurring billing transaction (do not submit AVS)
3 - Installment transaction
|
networkCode |
string |
identifier for the network that returned the transaction response. |
additionalAmount |
number |
remaining balance on a stored value account. |
method |
string |
transaction method. Valid values are:
CC - Credit Card
DB - Debit
ECHECK - Electronic Check
PD - Pinless Debit
SV - Stored Value
EBT - Electronic Benefit Transfer
|
customerId |
string |
customer identifier. |
emailReceipt |
boolean |
indicates whether the functionality to send reciept via email is enabled or not. |
fleetCardInfo |
string |
not currently used |
additionalData1 |
string |
For stored value cards this is the Previous Balance (15 characters long zero filled decimal number with explicit decimal point) followed by Cash Out Amount (15 characters long zero filled decimal number with explicit decimal point). |
additionalData2 |
string |
For stored value cards this is the virtual issued card number. |
additionalData3 |
string |
For EBT transactions, it will contain the Voucher # echoed from the ADDITIONALINFO field of the CARD object. For stored value cards it is the issued card EXP date. |
additionalData4 |
string |
Virtual issued card pin number. Used only for specific stored value card transactions. |
additionalData5 |
string |
P2P Encryption Transaction Response-String (22 Characters): 7-digit Key ID + {1,2} + MMddyyyyHHmmss |
softDescriptor |
string |
displays a description in addition to the merchants DBA. |
dynamicMCC |
string |
displays a 4 characters dynamic merchant category code. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields tied to the transaction, which is used for transaction reporting and settlement only. |
notes |
string |
notes associated with the transaction, which is used for transaction reporting and settlement only. |
invoiceDescription |
string |
invoiceDescription associated with the transaction, which is used for transaction reporting and settlement only. |
CATIndicator |
int |
Value to indicate if the transaction originated from a cardholder activated terminal. Possible values are:
0 - Not a CAT Transaction
1 - ATM with PIN
2 - Self-service terminal
3 - Limited-amount terminal
4 - In-flight commerce
6 - Electronic commerce
7 - Transponder transaction
|
callId |
string |
Visa Checkout transaction ID associated with a payment request. |
name |
type |
description |
planStartDate |
datetime |
plan start date. |
planEndDate |
datetime |
plan end date. |
primaryPaymentMethodId |
string |
primary payment method to be used for billing. |
secondaryPaymentMethodId |
string |
secondary payment method to be used for billing. |
nextPaymentDate |
datetime |
next payment date for the plan. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields tied to the plan, which can be used for reporting. |
scheduledPayments |
array of scheduledPayment |
scheduled payments. |
active |
boolean |
sets the Plan Active or Inactive |
notes |
string |
notes associated with the plan. |
softdescriptor |
string |
displays a description in addition to the merchants DBA. |
dynamicMCC |
string |
displays a 4 characters dynamic merchant category code. |
planId |
int |
plan identifier. Auto-generated by the system and given to the merchant when the plan is added. |
startDate |
dateTime |
plan start date. |
nextPaymentDate |
dateTime |
next scheduled payment date. |
maxRetries |
int |
number of times to retry billing if payment is declined. |
name |
type |
description |
customerId |
string |
customer identifier. |
address |
object |
billing address of the account holder. |
firstName |
string |
first name of the customer. |
lastName |
string |
last name of the customer. |
emailAddress |
string |
email address of the customer. |
sendEmailReceipts |
string |
indicates whether an email receipt should be sent to the customer whenever a transaction is completed. |
company |
string |
company of the customer. |
notes |
string |
notes associated with the customer. |
userDefinedFields |
array of userDefinedField |
custom user-defined fields for reporting purposes. |
paymentMethods |
array of vaultPaymentMethod |
all payment methods on file. |
primaryPaymentMethodId |
string |
primary payment method for the customer. |
variablePaymentPlans |
array of variablePaymentPlan |
all variable payment plans associated with the customer. |
recurringPaymentPlans |
array of recurringPaymentPlan |
all recurring payment plans associated with the customer. |
installmentPaymentPlans |
array of installmentPaymentPlan |
all installment payment plans associated with the customer. |