Loading...
| Name | Description | Type |
|---|---|---|
| ChangeDate | Date in UTC of the change to the check transaction's status. The format is MM/DD/YYYY HH:MM:SS TT, for example, 03/21/2019 04:32:38 AM. | DateTime |
| ChangeType | Indicates any changes to the status of a check transaction. The change is one of the following: • CheckStatus - Status of the check transaction, for example, "Approved" or "Declined". • DepositDate - Date of the deposit of the check transaction. • FundingStatus - Status of the funds, for example, "Pending" or "Debit sent". • LastAdjustmentAmount - Dollar amount of the check transaction if you make a change to it. • LastReturnCode - Processor returns this code when they process the transaction successfully or unsuccessfully. Note: We return the change in CurrentValue. | String |
| CurrentValue | Updated value for the ChangeType. | String |
| PreviousValue | Previous value for the ChangeType. | String |
| Parameter | Description | Type |
|---|---|---|
| CryptogramType | Indicates the type of cryptogram that was generated by the Integrated Circuit Card (ICC), which is one of the following: • AAC – Card declined the transaction and generated an Application Authentication Cryptogram (AAC). • ARQC – Card requested an online authorization and generated an Authorization Request Cryptogram (ARQC). • TC – Card approved the transaction and generated a Transaction Certificate(TC). Note: An ICC contains a chip and is commonly known as a "Chip and PIN" card. | String |
| Cryptogram | Indicates the outcome returned by the Integrated Circuit Card (ICC), which is one of the following: • TC – Card approved the transaction and generated a Transaction Certificate (TC). • AAC – Card declined the transaction and generated an Application Authentication Cryptogram (AAC). | String |
| Parameter | Description | Type |
|---|---|---|
| Aid | Unique identifier for the application. | String |
| ApplicationLabel | Mnemonic associated with the Aid according to ISO/IEC 7816-5. | String |
| ApplicationExpiryDate | Expiration date of the application. | String |
| ApplicationEffectiveDate | Start date from when the application can be used. | String |
| ApplicationInterchangeProfile | Indicates the functions the card can use with the application. | String |
| ApplicationVersionNumber | Version number of the application. | String |
| ApplicationTransactionCounter | Counter maintained by the application in the Integrated Circuit Card (ICC). This is incremented by one for each transaction ran on the card. Note: An ICC contains a chip and is commonly known as a "Chip and PIN" card. | String |
| ApplicationUsageControl | Indicates the issuer's restrictions on the card, for example, whether the cardholder can use the card internationally or at an ATM. | String |
| ApplicationPreferredName | Preferred mnemonic associated with the AID. | String |
| ApplicationDisplayName | Application label as displayed to the customer. | String |
| Parameter | Description | Type |
|---|---|---|
| AccountType | Type of account the customer used for the check transaction. The value is one of the following: • S - Savings account • C - Checking account | String |
| CheckType | Type of check the customer used for the check transaction. The value is one of the following: • PE - Personal check • CO - Company check • PA - Payroll check | String |
| NameOnCheck | Name of the customer as it appears on the check or the checking account. | String |
| Amount | Dollar amount of the check transaction. | Decimal |
| TransitNumber | Routing number of the checking account. | String |
| AccountNumber | Account number of the checking account. | String |
| CheckNumber | Unique number of the check. | String |
| MICR | Indicates if the check transaction contained MICR data. The value is one of the following: • True - Transaction included MICR data. • False - Transaction did not include MICR data. | Boolean |
| Parameter | Description | Type |
|---|---|---|
| Check | Object that contains information about the check transaction. See the Check data structure. | Object |
| PersonalData | Object that contains personal information about the customer using a check or checking account as a payment method. See the PersonalData data structure. | Object |
| HomeAddress | Object that contains the address of the customer using a check or checking account as a payment method. See the HomeAddress data structure. | Object |
| DriverLicense | Object that contains driver license information of the customer using a check or checking account as a payment method. See the DriverLicense data structure. | Object |
| Parameter | Description | Type |
|---|---|---|
| Front | Indicates if the check transaction contained an image of the front of the check. The value is one of the following: • True - Transaction included an image of the front of the check. • False - Transaction did not include an image of the front of the check. | Boolean |
| Back | Indicates if the check transaction contained an image of the back of the check. The value is one of the following: • True - Transaction included an image of the back of the check. • False - Transaction did not include an image of the back of the check. | Boolean |
| Parameter | Description | Type |
|---|---|---|
| PhoneNumber | Customer's phone number. | String |
| DateOfBirth | Customer's date of birth. | String |
| CourtesyCardNumber | Indicates if the customer's courtesy-card number was supplied in the transaction. The value is one of the following: • True - Transaction included a courtesy-card number. • False - Transaction did not include a courtesy-card number. | Boolean |
| Parameter | Description | Type |
|---|---|---|
| ApplicationInformation | Object that contains information about the application in EMV transactions. See the ApplicationInformation data structure. | Object |
| ApplicationCryptogram | Object that contains information about the application's cryptogram in EMV transactions. See the ApplicationCryptogram data structure. | Object |
| CvmResults | Indicates the result of the last cardholder verification method (CVM). The CVM indicates if the cardholder is genuine. | String |
| IssuerApplicationData | Proprietary application data for sending to the issuer in an online transaction. | String |
| TerminalVerificationResults | Indicates any issues that the terminal had while processing the transaction. | String |
| UnpredictableNumber | Value to provide variability and uniqueness to generate the cryptogram. | String |
| PosEntryMode | Indicates how the merchant entered the PAN into the POS. Value comes from the chip data on the payment card. | String |
| TerminalInformation | Object that contains information about the terminal. See the TerminalInformation data structure. | Object |
| TransactionInformation | Object that contains information about the EMV transaction. See the TransactionInformation data structure. | Object |
| CryptogramInformationData | Indicates the type of cryptogram and the actions that were performed by the terminal. | String |
| PinStatement | Indicates if the PIN was verified or if the PIN was locked. | String |
| CvmMethod | Identifies the cardholder verification method (CVM) that the application supports. |
| Parameter | Description | Type |
|---|---|---|
| ExternalReference | Unique identifier for the transaction assigned by Kount. | String |
| Recommendation | Kount's recommendation for the transaction. The value is one of the following: • Decline - Program the POS to refuse the order and void or refund the transaction. • Approve - No further action required. • Review - POS should prompt the merchant to review the transaction and choose to accept or decline the order. • Escalate - POS should prompt the merchant to escalate the transaction within their organization. | String |
| Score | Risk score between 1 and 99. A higher risk score means a greater risk of fraud. | String |
| Status | Indicates if Kount has successfully reviewed the transaction. The value is one of the following: • Success • Failure | String |
| Parameter | Description | Type |
|---|---|---|
| CopayAmount | Dollar amount that is a copayment. | String |
| ClinicalAmount | Dollar amount that is clinical charges. | String |
| DentalAmount | Dollar amount that is dental charges. | String |
| HealthCareTotalAmount | Total dollar amount of the transaction that is eligible healthcare charges. | String |
| PrescriptionAmount | Dollar amount that is prescription charges. | String |
| VisionAmount | Dollar amount that is vision charges. | String |
| Parameter | Description | Type |
|---|---|---|
| StreetAddress1 | First line of the customer's address. | String |
| StreetAddress2 | Second line of the customer's address. | String |
| City | City of the customer's address. | String |
| State | State of the customer's address. | String |
| PostalCode | Zip code of the customer's address. | String |
| Parameter | Description | Type |
|---|---|---|
| TaxIndicator | Indicates whether the dollar amount of the transaction includes tax. The value is one of the following: • NotProvided - Dollar amount does not include tax. • Provided - Dollar amount includes tax. • Exempt - Transaction is exempt from tax. | String |
| ProductDescription | Describes the item the cardholder purchased. | String |
| DiscountAmount | Dollar amount that the merchant deducts as a discount from the cost of the item. | String |
| ShippingAmount | If the merchant needs to ship the item, this is the dollar amount that the cardholder pays for shipping. | String |
| DutyAmount | If the merchant needs to ship the item, this is the dollar amount that the cardholder pays as duty when the shipment enters the destination country. | String |
| DestinationPostalCode | If the merchant needs to ship the item, this is the zip code of the delivery address. | String |
| DestinationCountryCode | If the merchant needs to ship the item, this is the country code of the delivery address. Note: For a list of country codes, see ISO standard 3166. | String |
| ShipFromPostalCode | If the merchant needs to ship the item, this is the zip code of the location the merchant ships the item from. | String |
| LineItem | Object that contains information about the items in the transaction. See the LineItem data structure. | Object |
| Parameter | Description | Type |
|---|---|---|
| CommodityCode | Commodity code of the line item. | String |
| Description | Description of the line item. | String |
| Upc | Universal Product Code (UPC) of the line item. | String |
| Quantity | Number of units contained in the line item. Unit type for the line item is specified in the UnitOfMeasure field. | String |
| UnitOfMeasure | Unit measure for the contents of the line item. | String |
| UnitCost | Cost of a single unit from the line item. | String |
| DiscountAmount | Dollar amount that the merchant deducted as a discount from the cost of the item. | String |
| TotalAmount | Total dollar amount for the line item after the merchant deducted tax and discounts. | String |
| TaxAmount | Dollar amount of the line item that is tax. | String |
| ExtendedAmount | Extended dollar amount of the line item. | String |
| DebitOrCreditIndicator | Indicates whether the line item is credit or debit. The value is one of the following: • Credit • Debit | String |
| NetOrGrossIndicator | Indicates whether the line item includes tax. The value is one of the following: • Net - Excludes tax. • Gross - Includes tax. | String |
| Parameter | Description | Type |
|---|---|---|
| SequenceNumber | Number of times that the merchant has ran a capture as part of a multiple clearing authorization. You must start with 1 and increment by 1 each time. The transaction finalizes when the SequenceNumber matches the SequenceCount. We accept values 1-99. Note: Do not pre-assign a SequenceNumber to shipments. This can cause out of order sequencing. | String |
| SequenceCount | Number of times that a merchant needs to run a capture for the total dollar amount. We accept values 2-99. | String |
| Parameter | Description | Type |
|---|---|---|
| PhoneNumber | Customer's phone number. | String |
| DateOfBirth | Customer's date of birth. | String |
| SocialSecurityNumber | Indicates if the customer's social-security number was supplied in the transaction. The value is one of the following: • True - Transaction included a social security number. • False - Transaction did not include a social security number. | String |
| Parameter | Description | Type |
|---|---|---|
| AdjustmentToken | Reference token the merchant should use to perform a tip adjustment. Note: A blank value or a 0 value indicates that you cannot perform an adjustment on the transaction. | String |
| CaptureToken | Reference token the merchant should use to perform a capture on an authorization. Note: A blank value or a 0 value indicates that you cannot perform a capture on the transaction. | String |
| RefundMaxAmount | Maximum dollar amount that can be refunded for a sale transaction. | String |
| RefundToken | Reference token the merchant should use to refund the transaction. Note: A blank value or a 0 value indicates that you cannot perform a refund on the transaction. | String |
| VoidToken | Reference token that the merchant should use to void the transaction. Note: A blank value or a 0 value indicates that you cannot perform a void on the transaction. | String |
| Parameter | Description | Type |
|---|---|---|
| TerminalType | Indicates the environment of the terminal, its communications capability, and its operational control. | String |
| IfdSerialNumber | Unique and permanent serial number the manufacturer assigned to the interface. | String |
| TerminalCountryCode | Indicates the country where the terminal is located. | String |
| TerminalId | Identifies the unique location of the terminal. | String |
| TerminalActionCodeDefault | Indicates why the issuer rejected the transaction. | String |
| TerminalActionCodeDenial | Indicates why the issuer denied the transaction without trying to process it online. | String |
| TerminalActionCodeOnline | Indicates why the issuer allowed the transaction to be processed online. | String |
| Parameter | Description | Type |
|---|---|---|
| TransactionType | Type of transaction. The value comes from the chip data on the payment card. | Integer |
| TransactionCurrencyCode | Currency code for the transaction. The value comes from the chip data on the payment card. | Integer |
| TransactionStatusInformation | Indicates the functions performed in a transaction. | String |
| String |
| IssuerActionCodeDefault | Indicates why the issuer rejected the transaction. | String |
| IssuerActionCodeDenial | Indicates why the issuer denied the transaction without trying to process it online. | String |
| IssuerActionCodeOnline | Indicates why the issuer allowed the transaction to be processed online. | String |
| AuthorizationResponseCode | Indicates if the transaction was authorized or declined by the entity that made the decision. | String |