Get Orders API Specification

JSON Path

Field Name

Description

Type

Example

orderId

Order ID

Unique identifier of the order so the order can be queried and referenced in other contexts.

String

"d121ea2210434ffc8a90daff9cc97e76"

JSON Path

Field Name

Description

Type

Examples

version

Response Version

The version of the Payment Risk endpoint response contract used for this response, as a string containing a three-digit semantic version number. For example, “1.0.0”.

String

"1.0.0"

order

Order Properties Object

An object containing the details of the order that was performed.

Object

order.orderId

Kount Order ID

Unique identifier of the order so the order can be queried and referenced in other contexts. For example, "d121ea2210434ffc8a90daff9cc97e76".

String

"d121ea2210434ffc8a90daff9cc97e76"

order.merchantOrderId

Merchant Order ID

The merchant-provided unique identifier for this order. Uniqueness for this property is not enforced. Example, "d121ea2210434ffc8a90daff9cc97e76".

String

"d121ea2210434ffc8a90daff9cc97e76"

order.channel

Order Channel

Unique identifier of the website or app from where the order originated. For example, "ACME_IOS_APP"

String

"ACME_IOS_APP"

order.deviceSessionId

Device Session ID

Unique identifier for the customer’s end-user’s session on the site/app. Must be the same session ID used in the device data collection from the client-side Kount SDK. Uniqueness for this property is not enforced, but customers should provide unique values. Example: "d121ea2210434ffc8a90daff9cc97e76"

String

"d121ea2210434ffc8a90daff9cc97e76"

order.creationDateTime

Order Creation Date/Time

The date and time that the order was placed.

String

"2019-08-24T14:15:22Z"

order.userIp

User IP Address

The customer/merchant’s end-user’s IPv4 address (in dotted decimal notation) as identified by the customer/merchant.

String

“192.168.1.27”

order.account

User's Account Object

Contains the order account information.

Object

order.account.id

User's Account ID

The merchant-provided unique account ID of the user that placed the order. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.account.type

User's Account Type

Merchant-provided categorization of the account.

String

"PRO_ACCOUNT"

order.account.creationDateTime

User's Account Creation Date/Time

The date and time that the user's account was created in the ISO 8601 format.

Must be in RFC3339 format.

String

"2019-08-24T14:15:22Z"

order.account.username

User's Username

The username of the user's account.

String

"johndoe1983"

order.account.accountIsActive

User's Account Active Status

Indicates whether the user's account is still active.

Boolean

TRUE

order.items

Items in the Order

Shopping cart data array of objects representing each item (separate SKU with quantity) in the order.

Array

order.items.id

Item ID

The merchant-provided unique item ID of the item in the order. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.items.price

Item Price

The price of the single item in the lowest currency factor. For example, The lowest currency in USD is pennies, so $1.00 would have the value of “100”. Must be a natural number including 0.

Integer

100

order.items.description

Item Description

The description of the item being purchased.

String

"Samsung 46\" LCD HDTV"

order.items.name

Item Name

The name of the item being purchased, typically the SKU.

String

"LN46B610"

order.items.quantity

Item Quantity

The quantity of the item being purchased.

Integer

1

items.category

Item Category

A high level or generalized description of the item added to the shopping cart.

String

"TV"

items.subCategory

Item Sub-Category

A lower-level or more specific description of the item added to the shopping cart.

String

"OLED TV"

order.items.isDigital

Item Digital Status

Indicates whether the item being ordered is a physical item or a service (false), or whether it is a digital good or service (true).

Boolean

FALSE

order.items.sku

Item SKU

A string containing the item's SKU, when available.

String

"TSH-000-S"

order.items.upc

Item UPC

A string containing the item's UPC code, when available.

String

"03600029145"

order.items.brand

Item's Brand

The item's brand name.

String

"LG"

order.items.url

Item's Page URL

The URL to the page that describes the item in the merchant's store.

String

"https://www.example.com/store/tsh-000-s"

order.items.imageUrl

Item's Image URL

The URL to the item's thumbnail image.

String

"https://www.example.com/store/tsh-000-s/thumbnail.png"

order.items.physicalAttributes

Item's Physical Properties Object

An object containing data on the physical attributes of a physical good.

Object

order.items.physicalAttributes.color

Item's Color

The color of the item, when there are different color options.

String

"Midnight Purple"

order.items.physicalAttributes.size

Item's Size

The size of the item, when there are different size options.

String

"XL"

order.items.physicalAttributes.weight

Item's Weight

The item's weight and units.

String

"5 lbs."

order.items.physicalAttributes.height

Item's Height

The item's height and units.

String

"12 in."

order.items.physicalAttributes.width

Item's Width

The item's width and units.

String

"6 in."

order.items.physicalAttributes.depth

Item's Depth

The item's depth and units.

String

"36 cm"

order.items.descriptors

Descriptors of the Item

An array of keywords associated with the item.

Array

["halloween", "mask"]

order.items.isService

Item Service Status

Indicates if the item being ordered is a service (true), or if it is a digital or physical product (false).

Boolean

TRUE

order.items.recurring

Recurring Details

Contains the properties of recurring billing for this item.

object

order.items.recurring.startDate

Subscription Start Date

Start date of the subscription. Date is in the ISO-8601 YYYY-MM-DD format.

string

"2025-02-01"

order.items.recurring.endDate

Subscription End Date

End date of the subscription. Date is in the ISO-8601 YYYY-MM-DD format.

string

"2026-02-01"

order.items.recurring.initialBillingAmount

Initial Billing Amount

Initial cost of the subscription in the lowest denomination.

string

1000

order.items.recurring.periodBillingAmount

Periodic Billing Amount

Recurring cost of the subscription in the lowest denomination.

string

500

order.items.recurring.period

Billing Period

Interval between recurring monthly payments.

string

"Monthly"

order.items.recurring.externalSubscriptionId

External Subscription ID

Subscription ID provided by an external party.

string

"SUB-001"

order.items.recurring.status

Subscription Status

Current status of the recurring subscription.

Enumerations are:

string

"ACTIVE"

order.items.recurring.nextBillingDate

Next Billing Date

Date the next billing event occurs. Date is in the ISO-8601 YYYY-MM-DD format.

string

"2025-03-01"

order.items.recurring.nextBillingProduct

Next Billing Product Properties

Contains the properties of the product that will be billed in the next recurring billing cycle.

object

order.items.recurring.nextBillingProduct.name

Next Billing Product Name

Name of the product that will be billed in the next recurring billing cycle.

string

"PROD-200"

order.items.recurring.nextBillingProduct.id

Next Billing Product ID

Product ID for the next recurring billing cycle.

string

"EXT-PROD-200"

order.items.recurring.billingCycle

Billing Cycle Count

Sequence number of the current billing cycle.

integer

3

order.items.recurring.description

Subscription Description

Description of the terms or nature of the subscription.

string

"Gold Tier Monthly"

order.items.externalProductId

External Product ID

Product ID used by an external inventory or catalog system.

string

"5e4e51d8-4dac-4515-91fe-edf48cfc9cb3"

order.fulfillment

Order Fulfillment Properties Array

An array of data properties about the fulfillment of the order.

Array

order.fullfillment.merchantFulfillmentId

Merchant's Fulfillment ID

The merchant-provided unique identifier for this fulfillment. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76”

order.fulfillment.type

Fulfillment Type

A string from an enumeration of types of fulfillment.

String

"SHIPPED"

order.fulfillment.items

Fulfilled Item IDs Array

String values made up of the merchant-provided item IDs that are being fulfilled in this fulfillment.

Array

order.fulfillment.items.id

Fulfillment Item ID

The unique identifier of the item that was specified in the items property of this order that was paid for in this transaction.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.fulfillment.items.quantity

Fulfillment Item Quantity

The quantity of this item that were paid for in this transaction.

Integer (int32)

3

order.fulfillment.status

Fulfillment Status

An enumeration of statuses of the current status of the fulfillment.

String

"PENDING”

order.fulfillment.accessUrl

Digital Access URL

A string containing the URL the customer needs to visit to retrieve the digital good.

String

"https://example.com/digitalgood/1213901281290"

order.fulfillment.shipping

Shipping Properties Object

Contains the shipping details properties.

Object

order.fulfillment.shipping.amount

Shipping Amount

The total amount of the shipping cost in its lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

893

order.fulfillment.shipping.provider

Shipping Provider

The service used to deliver the order to the recipient. If the merchant fulfills the order itself, should have the value "FBM" (fulfilled by merchant).

String

"FEDEX"

"FBM"

order.fulfillment.shipping.trackingNumber

Shipping Tracking Number

Contains the tracking number from the shipping provider for shipped goods.

String

"TBA056059680404"

order.fulfillment.shipping.method

Shipping Method and Class

n enumeration of types of shipping methods used to deliver the goods to the recipient.

String

“STANDARD”

order.fulfillment.shipping.shippedDateTime

Shipped Date/Time

Date and time the item was shipped. Date and time is in the ISO-8601 format YYYY-MM-DDTHH-MM-SSZ.

string

"2025-01-18T12:00:00Z"

order.fulfillment.shipping.deliveredDateTime

Delivered Date/Time

Date and time the item was delivered. Date and time is in the ISO-8601 format YYYY-MM-DDTHH-MM-SSZ.

string

"2025-01-22T14:30:00Z"

order.fulfillment.recipientPerson

Recipient Properties Object

Contains the properties of the recipient of the order.

Object

order.fulfillment.recipientPerson.name

Recipient Name

Contains the properties of the name of the person.

Object

order.fulfillment.recipientPerson.name.first

Recipient First Name

The first name of the person the order is shipped to.

String

"William"

order.fulfillment.recipientPerson.name.middle

Recipient Middle Name

The middle name of the person the order is shipped to.

String

"Sawyer”

order.fulfillment.recipientPerson.name.family

Recipient Last Name

The last name of the person the order is shipped to.

String

"Doe"

order.fulfillment.recipientPerson.name.prefix

Recipient’s Name’s Prefix

The prefix of the name of the person the order is shipped to.

String

“Mr.”

order.fullfillment.recipientPerson.name.suffix

Recipient’s Name’s Suffix

The prefix of the name of the person the order is shipped to.

String

"III"

order.fulfillment.recipientPerson.name.preferred

Recipient Preferred Name

The name the person the order is shipped to would like to be addressed by.

String

"Bill"

order.fulfillment.recipientPerson.dateOfBirth

Recipient Date of Birth

The date that the person was born.

Format is "yyyy-mm-dd", the ISO 8601 calendar date extended format.

String

“1982-08-23”

order.fulfillment.recipientPerson.emailAddress

Recipient Email Address

The email address of the person the order is shipped to.

String

"john.doe@example.com"

order.fulfillment.recipientPerson.phoneNumber

Recipient Phone Number

The phone number of the person the order is being shipped to in the E.123 standard format.

String

"+12081234567"

order.fulfillment.recipientPerson.address

Shipping Address Properties Object

Contains the properties of a physical or mailing address.

Object

order.fulfillment.recipientPerson.address.line1

Shipping Address Line 1

The first line of the shipping address.

String

"12345 MyStreet Ave"

order.fulfillment.recipientPerson.address.line2

Shipping Address Line 2

The second line of the shipping address.

String

"Suite 256”

order.fulfillment.recipientPerson.address.city

Shipping Address City

The city of the shipping address.

String

"Poplar Bluff"

order.fulfillment.recipientPerson.address.region

Shipping Address Region

The state or province of the shipping address.

String

“CO”

order.fulfillment.recipientPerson.address.countryCode

Shipping Address Country Code

The country code of the shipping address in the ISO-3166 format.

String

"US"

order.fulfillment.recipientPerson.address.postalCode

Shipping Address Postal Code

The postal code of the shipping address.

String

"63901-0000"

order.fulfillment.store

Fulfillment Store

Contains the properties of the store where the order is being fulfilled.

Object

order.fulfillment.store.id

Store ID

Contains the merchant-provided unique identifier for the store. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.fulfillment.store.name

Store Name

Contains the human-readable name of the store.

String

“10th & Main Acme Inc.”

order.fulfillment.store.address

Store Address Location

Contains the properties of a physical or mailing address.

Object

order.fulfillment.store.address.line1

Store Address Line 1

The first line of the address.

String

"12345 MyStreet Ave"

order.fulfillment.store.address.line2

Store Address Line 2

The second line of the address.

String

"Suite 256”

order.fulfillment.store.address.city

Store Address City

The city of the address.

String

"Poplar Bluff"

order.fulfillment.store.address.region

Store Address Region

The state or province of the address.

String

“CO”

order.fulfillment.store.address.countryCode

Store Address Country Code

The country code of the address in the ISO-3166 format.

String

"US"

order.fulfillment.store.address.postalCode

Store Address Postal Code

The postal code of the address.

String

"63901-0000"

order.fulfillment.digitalDownloaded

Digital Download

Indicates if a digital purchase has been fulfilled.

boolean

true

order.fulfillment.downloadDeviceIp

Device IP for Download

The IP address of the device that was used to download the digital purchase in dotted decimal notation as identified by the customer/merchant.

string

"192.168.1.27"

order.transactions

Payment Transactions Array

An array containing the properties of the payment transactions made for the order.

Array

order.transactions.merchantTransactionId

Merchant’s Transaction ID

The merchant-provided unique identifier for this transaction. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.transactions.processor

Payment Transaction Processor

The name of the payment processor that processed the transaction.

String

"ADYEN"

order.transactions.processorMerchantId

Payment Processor's Merchant ID

A unique identification number attached to a business that tells the payment processing systems involved in a transaction where to send which funds. Uniqueness for this property is not enforced. The format is processor specific, but is typically a 16-digit number.

String

"5206080947171696"

order.transactions.payment

Payment Properties Object

An object containing the properties of the specific type of payment that was used for this transaction.

Object

order.transactions.payment.type

Payment Type

Payment Type submitted by merchant:

String

"CREDIT_CARD"

order.transactions.payment.paymentToken

Payment Token

The payment token submitted by the merchant for the order (credit card, payer ID, routing/transit, MICR, and account number).

The payment token is hashed with salted SHA256.

If paymentType is set to “NONE” then the paymentToken value should be empty.

String

order.transactions.payment.bin

Payment BIN

The Bank Identification Number. Made up of the first six or eight digits of a credit or debit card.

String

"483312"

order.transactions.payment.last4

Last 4 Digits of PAN

The last 4 digits of the payment token.

String

"1111"

order.transactions.payment.cardBrand

Card Brand

Indicates the brand of card, such as the card network, that the transaction occurred on. Must be on of the following values:

String

"visa"

order.transactions.payment.issuingOrganization

Card Issuing Organization

Name of the organization or financial institution that issued the card.

string

"Wells Fargo Bank"

order.transactions.payment.issuingCountryCode

Card Issuing Country Code

Country code of the card issuer in ISO-3166 format.

string

"US"

order.transactions.payment.expirationMonth

Card Expiration Month

Two-digit month when the card expires.

integer

12

order.transactions.payment.expirationYear

Card Expiration Year

Four-digit year the card expires.

integer

2027

order.transactions.subtotal

Order Subtotal

The total amount of the order without shipping and tax included in its lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

10000

order.transactions.orderTotal

Order Total Amount

The total amount of currency in the transaction in its lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

100

order.transactions.currency

Order Total Currency

The three-letter ISO-4217 code of the currency used in the transaction. If a code is not provided, it defaults to “USD”.

String

"USD"

order.transactions.tax

Tax Properties Object

An object containing the tax details of the payment.

Object

order.transactions.tax.isTaxable

Order Taxable

A boolean indicating whether the order is taxable (true) or not (false).

Boolean

TRUE

order.transactions.tax.taxableCountryCode

Taxable Country Code

The country code of the taxable country in the ISO-3166 format.

String

"US"

order.transactions.tax.taxAmount

Tax Amount

The amount that was charged in taxes for this order in the currency's lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

327

order.transactions.tax.outOfStateTaxAmount

Out of State Tax Amount

The amount that was charged in out-of-state taxes for this order in the currency's lowest denomination. This amount should be included in the taxAmount property. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

285

order.transactions.billedPerson

Person Properties Object

An object containing the properties of the person who placed the order.

Object

order.transactions.billedPerson.name

Name Properties Object

Contains the properties of the person's name.

Object

order.transactions.billedPerson.name.first

Billed Person's First Name

The first name of the person/company billed for the order.

String

"William"

order.transactions.billedPerson.name.middle

Billed Person’s Middle Name

The middle name of the person/company billed for the order.

String

"Sawyer"

order.transactions.billedPerson.name.family

Billed Person's Last Name

The last name of the person/company billed for the order.

String

"Doe"

order.transactions.billedPerson.name.prefix

Billed Person’s Name’s Prefix

The prefix of the name of the person/company billed for the order.

String

"Mr."

order.transactions.billedPerson.name.suffix

Billed Person’s Name’s Suffix

The suffix of the name of the person/company billed for the order.

String

"III"

order.transactions.billedPerson.name.preferred

Billed Person's Preferred Name

The name the person/company billed for the order would like to be addressed by.

String

"Bill"

order.transactions.billedPerson.emailAddress

Billed Person's Email Address

The email address of the person/company billed for the order.

String

"john.doe@example.com"

order.transactions.billedPerson.phoneNumber

Billed Person's Phone Number

The phone number of the person billed for the order in the E.123 standard format.

String

"+15551234567"

order.transactions.billedPerson.address

Billed Person's Address Object

Contains the properties for the billed person's address.

Object

order.transactions.billedPerson.address.line1

Billing Address – Line 1

The first line of the billing address.

String

"5813-5849 Quail Meadows Dr"

order.transactions.billedPerson.address.line2

Billing Address – Line 2

The optional second line of the billing address.

String

“Suite 123”

order.transactions.billedPerson.address.city

Billing Address City

The city of the billing address.

String

"Poplar Bluff"

order.transactions.billedPerson.address.region

Billing Address Region

The state or province of the billing address.

String

"CO"

order.transactions.billedPerson.address.postalCode

Billing Address Postal Code

The postal code of the billing address.

String

"63901-0000"

order.transactions.billedPerson.address.countryCode

Billing Address Country Code

The country code of the billing address in the ISO-3166 format.

String

"US"

order.transactions.billedPerson.dateOfBirth

Billed Person Date of Birth

The date that the person was born. Format is "yyyy-mm-dd", the ISO 8601 calendar date extended format.

String

“1982-08-23”

order.transactions.transactionStatus

Payment Transaction Status

A string containing one of an enumeration of statuses the payment may be in as it is processed.

String

"PENDING"

order.transactions.authorizationStatus

Authorization Status Properties Object

An object containing the details of the authorization status. Everything in this object is expected only after payment authorization has occurred.

Object

order.transactions.authorizationStatus.authResult

Authorization Status

he authorization status returned to the merchant from the payment processor. Orders with a value of "Approved" will aggregate towards the order velocity of the persona while orders with a value of "Declined" will decrement the order velocity of the persona. Orders with a value of "Error" or "Unknown" will not change the velocity.

String

"Approved"

order.transactions.authorizationStatus.dateTime

Authorization Date/Time

The date/time when the transaction was performed. Supported date/time format is RFC 3339.

String

"2022-10-31T22:01:43Z"

order.transactions.authorizationStatus.verificationResponse

Verification Response Properties Object

An object containing the details of the verification responses.

Object

order.transactions.authorizationStatus.verificationResponse.cvvStatus

Card Verification Value Status

The Card Verification Value (CVV, CVS) response returned to the customer/merchant from the payment processor. One value of the following enumerated values: "Unknown", "Match" or "NoMatch".

String

"MATCH"

order.transactions.authorizationStatus.verificationResponse.avsStatus

Address Verification System Status

The Address Verification Service (AVS) conclusion about whether the street in the billing address matched (true) or not (false). Go to AVS Response Codes for more information.

string

"A"

order.transactions.authorizationStatus.declineCode

Card Decline Code

The code returned by the payment provider for the reason a card was declined.

String

"01"

order.transactions.authorizationStatus.processorAuthCode

Processor Auth Code

The payment processor-provided authorization code.

String

"741256"

order.transactions.authorizationStatus.processorTransactionId

Processor Transaction ID

The unique ID the payment processor or gateway uses for the order. This field isn’t required, but it is highly recommended. Uniqueness for this property is not enforced.

String

"NMI0983"

order.transactions.authorizationStatus.acquirerReferenceNumber

Acquirer Reference Number

A unique number for a credit or debit card transaction created during the transfer from the merchant’s bank through the payment processor. Enables identifying the transaction when errors occur. The format is an 11-digit number.

String

"40614857370"

order.transactions.authorizationStatus.gateway

Gateway Properties

Contains the properties of the gateway used to process this transaction.

object

order.transactions.authorizationStatus.gateway.response

Gateway Response

Response code or message from the payment gateway.

string

"Approved"

order.transactions.authorizationStatus.gateway.id

Gateway ID

Identifier for the gateway configuration in the Customer Relationship Management (CRM) system.

string

"CRM_GW_123"

order.transactions.authorizationStatus.eciResponseCode

ECI Response Code

Enumeration of the Electronic Commerce Indicator (ECI) response code value. Indicates the success or failure of a transaction authentication, typically in the context of 3D Secure.

Enumerations are:

string

"05"

order.transactions.items

Transaction Items

Indicates which of the items described in the items array were paid for in this transaction, indicated by an item ID and a quantity.

Array

order.transactions.items.id

Item ID

he unique identifier of the item that was specified in the items property of this order that was paid for in this transaction.

String

"d121ea2210434ffc8a90daff9cc97e76”

order.transactions.items.quantity

Item Quantity

The quantity of this item that were paid for in this transaction.

Integer

3

order.transactions.reversals

Reversals

array of objects that contain the properties of any reversals related to this order.

array

order.transactions.reversals.voidedAmount

Voided Amount

Amount voided for this transaction in its lowest denomination.

integer

100

order.transactions.reversals.voidedDateTime

Voided Date/Time

The date and time the transaction was voided. Date and time is in the ISO-8601 format YYYY-MM-DDTHH-MM-SSZ.

string

"2025-01-20T10:00:00Z"

order.transactions.reversals.refundAmount

Refund Amount

Amount refunded for this transaction in its lowest denomination.

integer

500

order.transactions.reversals.rma

RMA Properties

Contains the properties of the Return Merchant Authorization (RMA).

object

order.transactions.reversals.rma.reason

RMA Reason

Reason for the RMA.

string

"Defective"

order.transactions.reversals.rma.number

RMA Number

Unique identifier for the RMA.

string

"RMA-998877"

order.transactions.acquisitionDate

Acquisition Date

Date the original order was placed in a series of recurring transactions. Date is in the ISO-8601 YYYY-MM-DD format.

string

"2025-01-15"

order.promotions

Promotions Properties Array

An array containing all of the promotions applied to this order.

Array

order.promotions.id

Promotion ID

The merchant-provided identifier for the promotion. Uniqueness for this property is not enforced.

String

"BOGO10"

order.promotions.description

Promotion Description

The merchant-provided promotion description.

String

"Buy one, get one 10% off"

order.promotions.status

Promotion Status

The merchant-provided promotion status.

String

"accepted"

order.promotions.statusReason

Promotion Status Reason

The merchant-provided promotion status reason.

String

"Promotion cannot be combined."

order.promotions.discount

Promotion Discount Properties Object

The object containing the details of the discount.

Object

order.promotions.discount.percentage

Discount Percentage

The percentage of the total amount that was reduced due to the promotion being applied, represented as a floating point number. For example, 0.1 means 10% discounted.

Float

0.1

order.promotions.discount.amount

Discount Amount

The amount that the total was reduced by due to the promotion being applied in the currency's lowest denomination. This amount should be included in the taxAmount property. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

100

order.promotions.discount.currency

Promotion Discount Currency

The three-letter ISO-4217 code of the currency used in the promotion’s discount. If a code is not provided, it defaults to "USD”.

String

"USD"

order.promotions.credit

Credit Properties Object

An object containing the details of the amount of credit that was applied to this order.

Object

order.promotions.credit.currency

Promotion Credit Currency

The three-letter ISO-4217 code of the currency used in the promotional credit. If a code is not provided, it defaults to "USD”. If the credit is in a non-monetary format, such as loyalty points, the value of this property should be "XXX”, (no currency).

String

"USD"

order.promotions.credit.creditType

Credit Type

A merchant-defined identifier for the type of credit that was applied.

String

"GIFT_CARD"

order.promotions.credit.amount

Credit Amount

The amount of the total order that was paid for through a credit in the currency's lowest denomination. This amount should be included in the taxAmount property. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

100

order.loyalty

Loyalty Properties Object

An object containing the details of a credit that was applied from a loyalty account.

Array

order.loyalty.id

Loyalty ID

The unique identifier for the loyalty transaction. Uniqueness for this property is not enforced.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.loyalty.description

Loyalty Description

A description of the loyalty program being applied.

String

"Pizza Points"

order.loyalty.credit

Loyalty Credit Properties Object

An object containing the details of the loyalty credit that was applied to the order.

Object

order.loyalty.credit.creditType

Loyalty Credit Type

A merchant-defined identifier for the type of credit that was applied.

String

"PIZZA_POINTS"

order.loyalty.credit.amount

Loyalty Credit Amount

The amount of the total order that was paid for through a loyalty credit in the currency's lowest denomination. This amount should be included in the taxAmount property. For example, the lowest denomination in USD is the penny, so $1.00 has a “total” of “100”. The total must be a natural number, which includes “0”.

Integer

150

order.loyalty.credit.currency

Loyalty Credit Currency

The three-letter ISO-4217 code of the currency used in the loyalty credit. If a code is not provided, it defaults to "USD”. If the credit is in a non-monetary format, such as loyalty points, the value of this property should be "XXX”, (no currency).

String

XXX

order.customFields

Custom Fields

An object that allows passing in Custom Fields. Each key is the custom field's name as a string (max length: 32 characters). Each value is the custom field’s value as a date, boolean, string (max length: 256 characters), or number. Supported date format is RFC 3339 (ex: 2023-03-30T15:41:58Z). No object or array values are allowed.

JSON Object

{
  "keyNumber": 42,
  "keyBoolean": true,
  "keyString": "value",
  "keyDate": "2023-03-30T15:41:58Z"
}

order.riskInquiry

Order Risk Inquiry

An object containing the details of the risk inquiry evaluation performed on the payment.

Object

order.riskInquiry.decision

Payment Decision

The final outcome of the policies configured in the Policy Engine. One of the following enumeration values determining the decision for how to proceed:

String

"Approve"

order.riskInquiry.omniscore

Payment Omniscore

A number between 0 and 100 indicating the machine-learning model’s evaluation of the transaction risk. The higher the score, the safer the transaction was evaluated to be. For example, “99.9”.

Float

99.9

order.riskInquiry.persona

Payment Persona

Properties of the person the machine learning model has associated with this transaction.

Object

order.riskInquiry.persona.uniqueCards

Persona Unique Cards

Number of unique payment tokens (payment methods/cards) associated with the persona. For example, "3".

Integer

3

order.riskInquiry.persona.uniqueDevices

Persona Unique Devices

Number of unique device IDs (browsers/phones) associated with the persona. For example, "5".

Integer

5

order.riskInquiry.persona.uniqueEmails

Persona Unique Emails

Number of unique email addresses associated with the persona.

Integer

2

order.riskInquiry.persona.riskiestCountry

Persona Riskiest Country

The riskiest location identified in the merchant-specific Persona cluster in the ISO-3166 format. For example, "US". This could include billing, shipping or device location.

String

"US"

order.riskInquiry.persona.totalBankApprovedOrders

Persona Total Bank-Approved Orders

The sum of all approved orders authorized by the issuing bank in the merchant-specific Persona cluster in the 14 days before the order.

Integer

3

order.riskInquiry.persona.totalBankDeclinedOrders

Persona Total Bank-Declined Orders

The sum of all orders declined by the issuing bank in the merchant-specific Persona cluster in the 14 days before the order.

Integer

4

order.riskInquiry.persona.maxVelocity

Persona Max Velocity

The velocity of the floating 6-hour period in the 14 days before the event when the most approved and declined orders occurred in the merchant-specific Persona cluster.

Integer

2

order.riskInquiry.persona.riskiestRegion

Persona Riskiest Region

The riskiest location (in ISO-3166 region format), such as a state or province, in the merchant-specific Persona cluster.

String

"US-ID"

order.riskInquiry.device

Device Properties Object

The properties collected from the device (browser, phone/app) that the end user used to place the order.

Object

order.riskInquiry.device.id

Device ID

The unique identifier that was generated by Kount for the device. Example: "7363b8ae6b2247b99f5d56fc81102254"

String

"7363b8ae6b2247b99f5d56fc81102254"

order.riskInquiry.device.collectionDateTime

Device Collection Date/Time

The date/time when the device collection began. Supported date/time format is ISO 8601. For example, “2021-03-02T19:01:37Z”.

String

order.riskInquiry.device.browser

Device Browser Name

The name and the version number of the browser that was used (if any) that the end user used to place the order. For example, "Chrome 106.0.0.0".

String

"Chrome 106.0.0.0"

order.riskInquiry.device.deviceAttributes

Device Attributes

The properties of the device hardware/software that the end user used to place the order.

Object

order.riskInquiry.device.deviceAttributes.os

Device Operating System

The operating system that was running on the device when the order was placed. For example, "Android 9.0.0".

String

"Android 9.0.0"

order.riskInquiry.device.deviceAttributes.firstSeenDateTime

Device First Seen Date/Time

The date/time when this device was first seen in the Kount 360 network. Useful to understand whether this is a device with a long history. Supported date/time format is ISO 8601. For example, “2021-03-02T19:01:37Z”.

String

“2021-03-02T19:01:37Z”

order.riskInquiry.device.deviceAttributes.language

Device Language

The language that the operating system or app had set at the time the order was placed. For example, "en-US".

String

"en-US"

order.riskInquiry.device.deviceAttributes.timezoneOffset

Device Timezone Offset

The offset for the device local time zone when compared to GMT (in minutes). For example, "60".

Integer

60

order.riskInquiry.device.deviceAttributes.mobileSdkType

Mobile SDK Type

Which Kount SDK was used during the collection process, either iOS or Android. For example, "Android App SDK".

String

"Android App SDK"

order.riskInquiry.device.deviceAttributes.cookiesEnabled

Cookies Enabled

Whether cookies were enabled in the browser (true) or not (false). Is also false if it is not applicable. For example, if it is a mobile app.

Boolean

"false"

order.riskInquiry.device.deviceAttributes.screenResolution

Device Screen Resolution

The resolution of the device’s screen as the height by the width in number of pixels, delimited by an x. If there is no screen, this value will not be returned.

String

"1080x1920"

order.riskInquiry.device.deviceAttributes.ip

IP Address Properties Object

The properties of the IP addresses associated with this device.

Object

order.riskInquiry.device.deviceAttributes.ip.address

Device IP Address

The IP address of the device or, if it’s using a proxy, the IP address of the proxy.

String

“127.0.0.1”

order.riskInquiry.device.deviceAttributes.ip.organization

IP Address Owner Name

The name of the organization that is the owner of IP address or address block.

String

Equifax

order.riskInquiry.device.deviceAttributes.ip.piercedAddress

Device Pierced IP Address

If the device was using a proxy and we were able to pierce the proxy to discover the original device’s IP address, it contains the device’s IP address. If the proxy was not pierced, this property is not returned.

String

"192.168.0.1"

order.riskInquiry.device.deviceAttributes.ip.piercedOrganization

Pierced IP Address Owner Name

The name of the organization that is the owner of IP address or address block.

String

Equifax

order.riskInquiry.device.deviceAttributes.localTime

Device Local Time

The time (in the RFC 3339 date/time format) local to the device’s location as reported by the device.

String

“2021-03-02T19:01:37Z”

order.riskInquiry.device.deviceAttributes.userAgent

Device User Agent

The user agent string from the HTTP header of the device collection.

String

“Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36”

order.riskInquiry.device.location

Device Location Properties Object

An object containing the location properties that the device collector reported the device was located when the order was placed.

Object

order.riskInquiry.device.location.areaCode

Location Area Code

A string containing the three-digit US Area Code of the device during collection (based on an IP address match from Neustar). For example, "555".

String

"555"

order.riskInquiry.device.location.city

Location City

The name of the city where the device was reportedly located when the order was placed. For example, "Boise".

String

"Boise"

order.riskInquiry.device.location.country

Location Country

The name of the country where the device was reportedly located when the order was placed. For example, "United States of America".

String

"United States of America"

order.riskInquiry.device.location.countryCode

Location Country Code

The country code where the device was reportedly located when the order was placed in the ISO-3166 format. For example, "US".

String

"US"

order.riskInquiry.device.location.latitude

Location Latitude

A floating point number of the latitude where the device was reportedly located when the order was placed. For example, "44.8729"

Float

44.8729

order.riskInquiry.device.location.longitude

Location Longitude

A floating point number of the longitude where the device was reportedly located when the order was placed. For example, "-120.3456".

Float

-120.3456

order.riskInquiry.device.location.postalCode

Location Postal Code

A string containing the postal code where the device was reportedly located when the order was placed. For example, "90210".

String

"90210"

order.riskInquiry.device.location.region

Location Region

The name of the state or province where the device was reportedly located when the order was placed. For example, "Oregon".

String

"Oregon"

order.riskInquiry.device.location.regionCode

Location Region Code

The short code for the state or province where the device was reportedly located when the order was placed. For example, “ID”.

String

“ID”

order.riskInquiry.device.location.localeCountryCode

Locale Country Code

The country code (in ISO-3166 format) reported by the device’s locale setting in the HTTP headers.

String

"US"

order.riskInquiry.device.tor

Device on TOR Network

A boolean indicating whether the IP address is listed as a Tor node.

Boolean

TRUE

order.riskInquiry.segmentExecuted

Segment Executed Poperties

Contains the properties for the executed segement.

object

order.riskInquiry.segmentExecuted.segment

Segment Properties

Contains the properties for the segment.

object

order.riskInquiry.segmentExecuted.segment.id

Segment ID

The unique ID of the segment that was executed during order evaluation.

string

"12345678-1234-1234-1234-123456789012"

order.riskInquiry.segmentExecuted.segment.name

Segment Name

The name of the segment that was executed during order evaluation.

string

"Segment for Catching Fraud"

order.riskInquiry.segmentExecuted.segment.priority

Segment Priority

The priority of the segment that was executed during order evaluation.

integer

0

order.riskInquiry.segmentExecuted.policiesExecuted

Executed Policies

An array containing the policies that were executed during the transaction evaluation.

Array

order.riskInquiry.segmentExecuted.policiesExecuted.id

Policy ID

The unique ID of the policy. For example, "f4ce5e65-a7c7-4cbb-a7bc-c104df90cbea".

string

"12345678-1234-1234-1234-123456789012"

order.riskInquiry.segmentExecuted.policiesExecuted.name

Policy Name

The name of the policy. For example, "Disallowed Countries".

string

"Policy for Catching Fraud"

order.riskInquiry.segmentExecuted.policiesExecuted.outcome

Outcome Properties Object

An object containing the type of an outcome that occurred on a policy and the value of the outcome for that type of outcome.

Object

order.riskInquiry.segmentExecuted.policiesExecuted.outcome.type

Outcome Type

The type of the outcome.

string

"guidance"

order.riskInquiry.segmentExecuted.policiesExecuted.outcome.value

Outcome Value

The value of the outcome.

string

"Approve"

order.riskInquiry.segmentExecuted.tags

Tags

An array of strings with the tags used in the segment.

array

order.riskInquiry.email

Email Insights Properties Object

An object containing the properties of the email insights analysis on the order.

Object

order.riskInquiry.email.isVerifiedDomain

Email Verified Domain

A boolean indicating whether the domain of the email address is considered a real and valid domain.

Boolean

TRUE

order.riskInquiry.email.firstSeen

Email First Seen

The date/time when the email address was first seen in the Kount network of orders. Supported date/time format is RFC 3339.

String

“2023-01-15T10:30:00Z"

order.riskInquiry.email.mostRecent

Email Most Recent

The date/time when the email address was most recently seen in an order prior to this one. Supported date/time format is RFC 3339.

String

“2023-01-15T10:30:00Z"

order.riskInquiry.policyManagement

Policy Management Properties

An object containing the properties of the policy set, segments and policies fired as part of analyzing the order.

Object

order.riskInquiry.policyManagement.decision

Policy Engine Decision

The final outcome of the policies configured in the Policy Engine. One of the following enumeration values determine the decision for how to proceed:

String

"Approve"

order.riskInquiry.policyManagement.setExecuted

Policy Set Object

An object containing the properties of the policy set that executed as part of analyzing the order.

Object

order.riskInquiry.policyManagement.setExecuted.name

Policy Set Name

The name of the policy set that was executed to perform the risk inquiry on this order.

String

"Black Friday"

order.riskInquiry.policyManagement.setExecuted.version

Policy Set Version

The version of the policy set that was executed to perform the risk inquiry on this order in the format of ISO 8601 date/time when the version was created.

String

“2023-01-15T10:30:00Z”

order.riskInquiry.policyManagement.segmentExecuted

Segment Properties Object

An object containing the properties of the segment that was fired as part of the executed policy set.

Object

order.riskInquiry.policyManagement.segmentExecuted.id

Segment ID

The unique ID of the segment that was executed during order evaluation.

String

"f28eb8fc-3e71-41ae-a02f-a095046aa682"

order.riskInquiry.policyManagement.segmentExecuted.name

Segment Name

The name of the segment that was executed during order evaluation.

String

"Devices Outside United States"

order.riskInquiry.policyManagement.segmentExecuted.priority

Segment Priority

The priority of the segment that was executed during order evaluation.

Integer (int32)

0

order.riskInquiry.policyManagement.policiesExecuted

Executed Policies

An array containing objects containing the properties of the policies that were executed during the order evaluation.

Array

order.riskInquiry.policyManagement.policiesExecuted.id

Policy ID

The unique ID of the policy.

String

"f4ce5e65-a7c7-4cbb-a7bc-c104df90cbea"

order.riskInquiry.policyManagement.policiesExecuted.name

Policy Name

The name of the policy.

String

"High Risk Device"

order.riskInquiry.policyManagement.policiesExecuted.outcome

Policy Outcome

Contains the properties for the outcome of the policy executed.

Object

order.riskInquiry.policyManagement.policiesExecuted.outcome.type

Outcome Type

The type of the outcome.

String

"guidance"

order.riskInquiry.policyManagement.policiesExecuted.outcome.value

Outcome Value

The value of the outcome.

String

"Approve"

order.riskInquiry.policyManagement.tags

Tags

An array of strings containing the name of the tags that were applied to this order by segments or policies that evaluated to true.

Array

["risky_device", "unverified_location"]

order.riskInquiry.policyManagement.tagWeights

Tag Weights

An array of objects containing the details of tags that were applied to this order by segments or policies that evaluated to true and each tag’s associated weight after the tags' values were fully resolved.

Array

order.riskInquiry.policyManagement.tagWeights.name

Tag Weight Name

The name of the tag weight.

String

"risky_device"

order.riskInquiry.policyManagement.tagWeights.value

Tag Weight Value

The value of the tag weight.

Integer

1

order.riskInquiry.policyManagement.tagWeights.weight

Tag Weight Value

The numerical weight associated with the tag weight after the tags' values were fully resolved.

Integer

110

order.riskInquiry.reasonCode

Risk Inquiry Reason Code

The reason code associated with the risk inquiry.

String

"10.2"

order.riskInquiry.set

Set Properties

An object containing the properties of the set that was fired as part of the executed policy set.

Object

order.riskInquiry.set.name

Set Name

The name of the policy set that was executed to perform the risk inquiry on this order.

String

"Black Friday"

order.riskInquiry.set.version

Set Version

The version of the policy set that was executed to perform the risk inquiry on this order in the format of the ISO 8601 date/time when the version was created.

String

"2023-01-15T10:30:00Z"

order.riskInquiry.segment

Segment Properties

An object containing the properties of the segment that was fired as part of the executed policy set.

Object

order.riskInquiry.segment.id

Segment ID

The unique ID of the segment that was executed during order evaluation.

String

"12345678-1234-1234-1234-123456789012"

order.riskInquiry.segment.name

Segment Name

The name of the segment that was executed during order evaluation.

String

"Policy for Catching Fraud"

order.riskInquiry.segment.priority

Segment Priority

The priority of segment that was executed during order evaluation.

String

0

order.assignedAgent

Assigned Agent Properties Object

An object that contains the properties about the fraud agent that is assigned to this order.

Object

order.assignedAgent.name

Assigned Agent Name

A string containing the name of the fraud agent that is assigned to this order.

String

"Jane Doe"

order.assignedAgent.id

Assigned Agent ID

A string containing the unique identifier of the fraud agent assigned to this order.

String

"d121ea2210434ffc8a90daff9cc97e76"

order.reversals

Reversals Properties Object

An object containing the properties of chargebacks, refunds and fraud statuses related to this order.

Object

order.reversals.chargeback

Chargeback Properties Object

An object containing the properties of any chargeback associated with this order.

Object

order.reversals.chargeback.isChargeback

Has Chargeback

Indicates whether a chargeback has been occurred on this order.

Boolean

"TRUE"

order.reversals.chargeback.reasonCode

Chargeback Reason Code

For an order with a chargeback, contains the reason code associated with the chargeback.

String

“10.2”

order.reversals.chargeback.cardType

Chargeback Card Type

Indicates the type of card that the chargeback occurred on. Must be on of these enumerated values:

String

“americanexpress”

order.reversals.refund

Refund Properties Object

An object containing the properties of any refund associated with this order.

Object

order.reversals.refund.isRefund

Has Refund

Indicates whether the order has been refunded.

Boolean

"FALSE"

order.reversals.refunddateTime

Refund Date/Time

The date/time when the refund was issued in the ISO 8601 format.

String

“2019-08-24T14:15:22Z”

order.reversals.refundamount

Refund Amount

The amount of the refund in the lowest currency factor. For example, The lowest currency in USD is pennies, so $1.00 would have the value of “100”. Must be a natural number including 0. For example, 100.

Integer

250

order.reversals.refund.currency

Refund Currency

The three-letter ISO-4217 code of the currency used for the refund. If a code is not provided, it defaults to “USD”.

String

"USD"

order.reversals.fraudReportType

Fraud Report Type

If a fraud report type is associated with this order, indicates which kind from one of the following enumerated values:

String

“TC40”

order.notes

Notes Array

Objects that contain the details of all of the notes that have been associated with this object.

Array

order.notes.agentActor

Notes Agent Properties Object

Contains the properties associated with the fraud agent or system agent that added the note.

Object

order.notes.agentActor.name

Note Agent Author Name

Contains the name of the fraud agent or system agent that added the note.

String

“Jane Doe”

order.notes.agentActor.id

Note Agent Author ID

Contains the unique identifier of the fraud agent or system agent that added the note.

String

“d121ea2210434ffc8a90daff9cc97e76”

order.notes.note

Note Contents

Contains the content of the note.

String

"This is a manual note."

order.notes.timestamp

Note Date/Time

Contains the date and time that the note was added in the ISO 8601 format.

String

"2019-08-24T14:15:22Z"

order.notes.isAutomated

Is Note Automated

Indicates whether the note was added by an automated system.

Boolean

FALSE

order.merchantCategoryCode

Merchant Category Code

The Merchant Category Code assigned to the merchant classifies the merchant into specific categories based on the type of business, trade, or services. The code is supplied in the ISO 18245 format.

Integer

5942

order.merchant

Merchant Properties

Contains properties related to the merchant that transacted the order.

object

order.merchant.name

Merchant Name

Doing-business-as name associated with the Merchant ID (MID).

string

"Acme Inc."

order.merchant.storeName

Merchant Store Name

Name of the physical or virtual store or website where the order was placed.

string

"10th and Main Acme Inc."

order.merchant.websiteUrl

Merchant Website URL

URL link to the product or store website.

string

"5e4e51d8-4dac-4515-91fe-edf48cfc9cb3"

order.merchant.id

Merchant ID

Unique identifier for the doing-business-as merchant.

string

“543210087654321”

order.merchant.contactEmail

Merchant Contact Email

Contains the email address that customers can use to contact the merchant.

string

"support@acme.com"

order.merchant.contactPhoneNumber

Merchant Contact Phone Number

Contains the phone number that customers can use to contact the merchant. Phone number uses E.123 standard format.

string

"+12081234567"

order.advertising

Advertising Properties

Contains properties related to the advertising channels that led to the order.

object

order.advertising.channel

Advertising Channel

Highest level of advertising channel used.

string

"Affiliate"

order.advertising.campaign

Campaign Properties

An object containing properties related to the advertising campaign that led to the order.

object

order.advertising.campaign.id

Campaign ID

Merchant-provided unique identifier for the marketing or sales campaign.

string

"HOLIDAY2026"

order.advertising.campaign.name

Campaign Name

Human-readable name for the associated marketing or sales campaign.

string

"2026 Holiday Promo"

order.advertising.affiliate

Affiliate Identifier

Unique ID of the affiliate involved in the sale.

string

"Aff123"

order.advertising.subAffiliate

Sub-Affiliate Identifier

Optional sub-identifier for the affiliate.

string

"SubA_456"

order.advertising.events

Advertising Events

array of objects detailing conversion events prior to the order.

array

order.advertising.events.type

Event Type

Type of marketing event.

string

"conversion"

order.advertising.events.value

Event Value

Value or ID associated with the event.

string

"product_page_view"

order.links

Order Links Properties

Contains the properties of the website links for various actions to perform on the order.

object

order.links.viewOrderUrl

View Order URL

URL link for the customer to view the order details.

string

"https://site.com/orders/1"

order.links.requestRefundUrl

Request Refund URL

URL link for the customer to initiate a refund.

string

"https://site.com/refund/1"

order.links.buyAgainUrl

Buy Again URL

URL link for the customer to repurchase the items.

string

"https://site.com/cart/reorder/1"

order.links.writeReviewUrl

Write Review URL

URL link for the customer to leave a review for the order.

string

"https://site.com/review/1"

sourceCrm

Order Data Source CRM

If you use a Customer Relationship Management (CRM) system configured to provide order data, this field contains an enumeration that indicates which CRM-populated data is included in the order.

Enumerations are:

string

"SOURCE_CRM_AUTHNET