JSON Path
|
Field Name
|
Description
|
Type
|
Examples
|
Notes
|
merchantOrderId
|
Merchant's Order ID
|
The merchant-provided unique identifier for this order. Uniqueness for this property is not enforced. Example: "d121ea2210434ffc8a90daff9cc97e76".
|
String
|
"d121ea2210434ffc8a90daff9cc97e76"
|
|
channel
|
Customer's Transaction Channel
|
Unique identifier of the website or app from where the order originated. For example, "ACME_IOS_APP"
|
String
|
"ACME_IOS_APP"
|
(FKA: ‘website_ID’)
|
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"
|
|
creationDateTime
|
Order Creation Date/Time
|
The date and time that the order was placed.
|
String
|
"2019-08-24T14:15:22Z"
|
|
userIp
|
User's IP Address
|
The customer/merchant’s end-user’s IPv4 address (in dotted decimal notation) as identified by the customer/merchant. For example, “192.168.1.27”
|
String
|
“192.168.1.27”
|
|
account
|
Account Properties Object
|
An object containing the properties of the account of the user that placed the order.
|
Object
|
|
|
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. Example: "d121ea2210434ffc8a90daff9cc97e76"
|
String
|
"d121ea2210434ffc8a90daff9cc97e76"
|
|
account.type
|
User's Account Type
|
Merchant-provided categorization of the account.
|
String
|
"PRO_ACCOUNT"
|
|
account.creationDateTime
|
User's Account Creation Date/Time
|
The date and time that the user's account was created.
|
String
|
"2019-08-24T14:15:22Z"
|
|
account.username
|
User's Username
|
The username of the user's account.
|
String
|
"johndoe1983"
|
|
account.accountIsActive
|
User's Account Active Status
|
A boolean indicating whether the user's account is still active.
|
Boolean
|
TRUE
|
|
items
|
Items in the Order
|
Shopping cart data array of objects representing each item (separate SKU with quantity) in the order.
|
Array
|
|
|
items.id
|
Item ID
|
The merchant-provided unique item ID of the item in the order. Uniqueness for this property is not enforced. Example: "d121ea2210434ffc8a90daff9cc97e76"
|
String
|
"d121ea2210434ffc8a90daff9cc97e76"
|
|
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. For example, 100.
|
Integer
|
100
|
|
items.description
|
Item Description
|
The description of the item being purchased. For example, "Samsung 46' LCD HDTV".
|
String
|
"Samsung 46'' LCD HDTV"
|
|
items.name
|
Item Name
|
The name of the item being purchased, typically the SKU. For example, "LN46B610".
|
String
|
"LN46B610"
|
|
items.quantity
|
Item Quantity
|
The quantity of the item being purchased. For example, 1.
|
Integer
|
1
|
|
items.category
|
Item Category
|
A high level or generalized description of the item added to the shopping cart. For example, "TV".
|
String
|
"TV"
|
|
items.subCategory
|
Item Sub-Category
|
A lower-level or more specific description of the item added to the shopping cart. For example, "OLED TV".
|
String
|
"OLED TV"
|
|
items.isDigital
|
Item Digital Status
|
A boolean indicating 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
|
|
items.sku
|
Item SKU
|
A string containing the item's SKU, when available. For example: "TSH-000-S"
|
String
|
"TSH-000-S"
|
|
items.upc
|
Item UPC
|
A string containing the item's UPC code, when available. For example: "03600029145"
|
String
|
"03600029145"
|
|
items.brand
|
Item's Brand
|
The item's brand name.
|
String
|
"LG"
|
|
items.url
|
Item's Page URL
|
The URL to the page that describes the item in the merchant's store. For example: "https://www.example.com/store/tsh-000-s"
|
String
|
"https://www.example.com/store/tsh-000-s"
|
|
items.image
|
Item's Image URL
|
The URL to the item's thumbnail image. For example: "https://www.example.com/store/tsh-000-s/thumbnail.png"
|
String
|
"https://www.example.com/store/tsh-000-s/thumbnail.png"
|
|
items.physicalAttributes
|
Item's Physical Properties Object
|
An object containing data on the physical attributes of a physical good.
|
Object
|
|
Shouldn't be provided for digital goods.
|
items.physicalAttributes.color
|
Item's Color
|
The color of the item, when there are different color options. For example: "Midnight Purple"
|
String
|
"Midnight Purple"
|
|
items.physicalAttributes.size
|
Item's Size
|
The size of the item, when there are different size options. For example: "XL"
|
String
|
"XL"
|
|
items.physicalAttributes.weight
|
Item's Weight
|
The item's weight and units. For example: "5 lbs."
|
String
|
"5 lbs."
|
|
items.physicalAttributes.height
|
Item's Height
|
The item's height and units. For example: "12 in."
|
String
|
"12 in."
|
|
items.physicalAttributes.width
|
Item's Width
|
The item's width and units. For example: "6 in."
|
String
|
"6 in."
|
|
items.physicalAttributes.depth
|
Item's Depth
|
The item's depth and units. For example: "36 cm"
|
String
|
"36 cm"
|
|
items.descriptors
|
Descriptors of the Item
|
An array of keywords associated with the item. For example: ["halloween", "mask"]
|
Array
|
["halloween", "mask"]
|
|
fulfillment
|
Order Fulfillment Properties Array
|
An array of data properties about the fulfillment of the order.
|
Array
|
|
Fulfillment is how the consumer acquires the order, which is an array of items (good or service)
|
fulfillment.type
|
Fulfillment Type
|
A string from an enumeration of types of fulfillment. For example: "DIGITAL"
|
String
|
“SHIPPED”
”DIGITAL”
”STORE_PICK_UP”
”LOCAL_DELIVERY”
”STORE_DRIVE_UP”
”IN_PERSON”
|
Fulfillment Classes: All
|
fulfillment.itemsIds
|
Fulfilled Item IDs Array
|
An array of string values made up of the merchant-provided item IDs that are being fulfilled in this fulfillment.
|
Array
|
["d121ea2210434ffc8a90daff9cc97e76", “23e69466888d11eda1eb0242ac120002”]
|
Fulfillment Classes: All
|
fulfillment.status
|
Fulfillment Status
|
A string of an enumeration of statuses of the current status of the fulfillment.
|
String
|
“PENDING”
”UNFULFILLED”
”ON_HOLD”
”FULFILLED”
”SCHEDULED”
”PARTIALLY_FULFILLED”
”DELAYED”
”CANCELED”
|
PENDING – Awaiting fulfillment info
UNFULFILLED – In progress, but not shipped
ON_HOLD – Waiting on upsell opportunities
FULFILLED – Shipped (formerly SUCCESSFUL)
SCHEDULED – Waiting for release (e.g.: prepaid subscriptions)
PARTIALLY_FULFILLED – Portion is shipped
DELAYED – Delayed
CANCELED – Canceled
|
fulfillment.accessUrl
|
Digital Access URL
|
A string containing the URL the customer needs to visit to retrieve the digital good. For example: "https://example.com/digitalgood/1213901281290"
|
String
|
"https://example.com/digitalgood/1213901281290"
|
Fulfillment Classes: DIGITAL
|
fulfillment.shipping
|
Shipping Properties Object
|
An object containing the shipping details properties.
|
Object
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
Should be included even for digital goods. Note that in the description.
|
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
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
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"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
FBM stands for "Fulfilled by Merchant" and would be applicable for digital goods.
|
fulfillment.shipping.trackingNumbers
|
Shipping Tracking Numbers
|
An array containing tracking numbers from the shipping provider for shipped goods. For example: ["TBA056059680404"]
|
Array
|
["TBA056059680404"]
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.shipping.method
|
Shipping Method & Class
|
A string from an enumeration of types of shipping methods used to deliver the goods to the recipient. Types: “STANDARD”, “EXPRESS”, “SAME_DAY”, “NEXT_DAY”, “SECOND_DAY”
|
String
|
“STANDARD”
"EXPRESS"
“SAME_DAY”
”NEXT_DAY”
”SECOND_DAY”
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient
|
Recipient Properties Object
|
The object containing the properties of the recipient of the order.
|
Object
|
|
Fulfillment Classes: All
|
fulfillment.recipient.sameAsBilling
|
Billing Duplicate Address
|
A boolean indicating whether the billing address is the same as the shipping address (true) or not (false). If true, person does not need to be provided and Transaction.billedPerson will be used. If person is provided, it will be used instead of Transaction.billedPerson, regardless of the value of this property.
|
Boolean
|
FALSE
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person
|
Recipient
|
An object containing the properties of the person receiving the goods.
|
Object
|
|
Fulfillment Classes: All
|
fulfillment.recipient.person.name
|
Recipient Name
|
An object containing the properties of the name of the person.
|
Object
|
|
Fulfillment Classes: All
|
fulfillment.recipient.person.name.first
|
Recipient First Name
|
The first name of the person the order is shipped to. For example, “John”.
|
String
|
"William"
|
Fulfillment Classes: All
|
fulfillment.recipient.person.name.last
|
Recipient Last Name
|
The last name of the person the order is shipped to. For example, “Doe”.
|
String
|
"Doe"
|
Fulfillment Classes: All
|
fulfillment.recipient.person.name.preferred
|
Recipient Preferred Name
|
The name the person the order is shipped to would like to be addressed by. For example: "Bill".
|
String
|
"Bill"
|
Fulfillment Classes: All
|
fulfillment.recipient.person.emailAddress
|
Recipient Email Address
|
The email address of the person the order is shipped to. For example, "john.doe@example.com".
|
String
|
"john.doe@example.com"
|
Fulfillment Classes: All
|
fulfillment.recipient.person.phoneNumber
|
Recipient Phone Number
|
The phone number of the person the order is being shipped to in the E.123 standard format. For example, "+12081234567".
|
String
|
"+12081234567"
|
Fulfillment Classes: All
|
fulfillment.recipient.person.shippingAddress
|
Shipping Address Properties Object
|
An object containing the properties of a physical or mailing address.
|
Object
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
Can be excluded for digital goods. Note that in description.
|
fulfillment.recipient.person.shippingAddress.addressType
|
Shipping Address Type
|
Indicates the kind of address. For this property, the value should be "SHIPPING".
|
String
|
"SHIPPING"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
Although this is already clear from the structure, this is one of the properties that's part of the "address" schema.
|
fulfillment.recipient.person.shippingAddress.line1
|
Shipping Address Line 1
|
The first line of the shipping address. For example, "12345 MyStreet Ave".
|
String
|
"12345 MyStreet Ave"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person.shippingAddress.line2
|
Shipping Address Line 2
|
The second line of the shipping address. For example, "Suite 256”.
|
String
|
"Suite 256”
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person.shippingAddress.city
|
Shipping Address City
|
The city of the shipping address. For example, "Poplar Bluff".
|
String
|
"Poplar Bluff"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person.shippingAddress.region
|
Shipping Address Region
|
The state or province of the shipping address. For example, “CO”.
|
String
|
“CO”
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person.shippingAddress.countryCode
|
Shipping Address Country Code
|
The country code of the shipping address in the ISO-3166 format. For example, "US".
|
String
|
"US"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.recipient.person.shippingAddress.postalCode
|
Shipping Address Postal Code
|
The postal code of the shipping address. For example, "63901-0000".
|
String
|
"63901-0000"
|
Fulfillment Classes: SHIPPED, LOCAL_DELIVERY
|
fulfillment.store
|
Fulfillment Store
|
An object containing the properties of the store where the order is being fulfilled.
|
Object
|
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.id
|
Store ID
|
A string containing the merchant-provided unique identifier for the store. Uniqueness for this property is not enforced. Example: "d121ea2210434ffc8a90daff9cc97e76"
|
String
|
"d121ea2210434ffc8a90daff9cc97e76"
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.name
|
Store Name
|
A string containing the human-readable name of the store. Example: “10th & Main Acme Inc.”
|
String
|
“10th & Main Acme Inc.”
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address
|
Store Address Location
|
An object containing the properties of a physical or mailing address.
|
Object
|
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.addressType
|
Store Address Type
|
Indicates the kind of address. For this property, the value should be “SHIPPING”, “BILLING” or “LOCATION”.
|
String
|
“LOCATION”
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.line1
|
Store Address Line 1
|
The first line of the address. For example, "12345 MyStreet Ave".
|
String
|
"12345 MyStreet Ave"
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.line2
|
Store Address Line 2
|
The second line of the address. For example, "Suite 256”.
|
String
|
"Suite 256”
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.city
|
Store Address City
|
The city of the address. For example, "Poplar Bluff".
|
String
|
"Poplar Bluff"
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.region
|
Store Address Region
|
The state or province of the address. For example, “CO”.
|
String
|
“CO”
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.countryCode
|
Store Address Country Code
|
The country code of the address in the ISO-3166 format. For example, "US".
|
String
|
"US"
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
fulfillment.store.address.postalCode
|
Store Address Postal Code
|
The postal code of the address. For example, "63901-0000".
|
String
|
"63901-0000"
|
Fulfillment Classes: STORE_PICK_UP, STORE_DRIVE_UP, IN_PERSON
|
transactions
|
Payment Transactions Array
|
An array containing the properties of the payment transactions made for the order.
|
Array
|
|
|
transactions.processor
|
Payment Transaction Processor
|
The name of the payment processor that processed the transaction. E.g.: "PayPal"
|
String
|
"ADYEN"
|
|
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. For example: "5206080947171696"
|
String
|
"5206080947171696"
|
|
transactions.payment
|
Payment Properties Object
|
An object containing the properties of the specific type of payment that was used for this transaction.
|
Object
|
|
|
transactions.payment.type
|
Payment Type
|
Payment Type submitted by merchant:
APAY - Apple Pay
CREDIT_CARD - Credit Card
DEBIT_CARD - Debit Card
PYPL - PayPal
CHEK - Check
NONE - None
TOKEN - Token provided from payment processor
GDMP - Green Dot Money Pack
GOOG - Google Checkout
BLML - Bill Me Later
GIFT - Gift Card
BPAY - BPAY
NETELLER - Neteller
GIROPAY - GiroPay
ELV - ELV
MERCADE_PAGO - Mercade Pago
SEPA - Single Euro Payments Area
INTERAC - Interac
CARTE_BLEUE - Carte Bleue
POLI - POLi
SKRILL - Skrill/Moneybookers
SOFORT - Sofort
AMZN - Amazon Pay
SAMPAY - Samsung Pay
ALIPAY - AliPay
WCPAY - WeChat Pay
CRYPTO - Crypto Payments
KLARNA - Klarna
AFTRPAY - Afterpay
AFFIRM - Affirm
SPLIT - Splitit
FBPAY - Facebook Pay
|
String
|
"CREDIT_CARD"
|
|
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 left empty.
POST-AUTH CALLS ONLY – If the credit card information is not available and a tokenized value is returned from the payment processor, set paymentType=”TOKEN” and send the token returned from the payment processor in the paymentToken field.
|
String
|
|
|
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"
|
|
transactions.payment.last4
|
Last 4 Digits of PAN
|
The last 4 digits of the payment token.
|
String
|
"1111"
|
|
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
|
|
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
|
|
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"
|
|
transactions.tax
|
Tax Properties Object
|
An object containing the tax details of the payment.
|
Object
|
|
|
transactions.tax.isTaxable
|
Order Taxable
|
A boolean indicating whether the order is taxable (true) or not (false).
|
Boolean
|
TRUE
|
|
transactions.tax.taxableCountryCode
|
Taxable Country Code
|
The country code of the taxable country in the ISO-3166 format. For example, "US".
|
String
|
"US"
|
|
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
|
|
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
|
|
Make this the subset of the taxAmount. I.e.: the total of taxAmount includes the outOfStateTax.
|
transactions.billedPerson
|
Person Properties Object
|
An object containing the properties of the person who placed the order.
|
Object
|
|
|
transactions.billedPerson.name
|
Name Properties Object
|
An object containing the properties of the person's name.
|
Object
|
|
|
transactions.billedPerson.name.first
|
Billed Person's First Name
|
The first name (forename) of the person/company billed for the order. For example, “William”.
|
String
|
"William"
|
|
transactions.billedPerson.name.last
|
Billed Person's Last Name
|
The last name (surname) of the person/company billed for the order. For example, “Doe”.
|
String
|
"Doe"
|
|
transactions.billedPerson.name.preferred
|
Billed Person's Preferred Name
|
The name the person/company billed for the order would like to be addressed by. For example: "Bill".
|
String
|
"Bill"
|
|
transactions.billedPerson.emailAddress
|
Billed Person's Email Address
|
The email address of the person/company billed for the order. For example, “john.doe@example.com”
|
String
|
"john.doe@example.com"
|
|
transactions.billedPerson.phoneNumber
|
Billed Person's Phone Number
|
The phone number of the person billed for the order in the E.123 standard format. For example, "+15551234567".
|
String
|
"+15551234567"
|
|
transactions.billedPerson.address
|
Billed Person's Address Properties Object
|
An object containing the properties of a physical or mailing address.
|
Object
|
|
|
transactions.billedPerson.address.addressType
|
Address Type
|
Indicates the kind of address. For this property, the value should be "BILLING".
|
String
|
"BILLING"
|
|
transactions.billedPerson.address.line1
|
Billing Address – Line 1
|
The first line of the billing address. For example, “12345 Mystreet Ave”.
|
String
|
"5813-5849 Quail Meadows Dr"
|
|
transactions.billedPerson.address.line2
|
Billing Address – Line 2
|
The optional second line of the billing address. For example, “Suite 123”.
|
String
|
“Suite 123”
|
|
transactions.billedPerson.address.city
|
Billing Address City
|
The city of the billing address. For example, "Poplar Bluff"
|
String
|
"Poplar Bluff"
|
|
transactions.billedPerson.address.region
|
Billing Address Region
|
The state or province of the billing address. For example, “CO”.
|
String
|
"CO"
|
|
transactions.billedPerson.address.postalCode
|
Billing Address Postal Code
|
The postal code of the billing address. For example, "63901-0000".
|
String
|
"63901-0000"
|
|
transactions.billedPerson.address.countryCode
|
Billing Address Country Code
|
The country code of the billing address in the ISO-3166 format. For example, "US".
|
String
|
"US"
|
|
transactions.transactionStatus
|
Payment Transaction Status
|
A string containing one of an enumeration of statuses the payment may be in as it is processed. For example: "PENDING"
|
String
|
"PENDING"
"AUTHORIZED"
"REFUSED"
"CAPTURED"
"ERROR"
"EXPIRED"
"CANCELLED"
"SENT_FOR_REFUND"
"REFUNDED"
"REFUND_FAILED"
"SETTLED"
"INFORMATION_REQUESTED"
"INFORMATION_SUPPLIED"
"CHARGED_BACK"
"CHARGEBACK_REVERSED"
"DISPUTE_EXPIRED"
"DISPUTE_RESERVE_RELEASED"
"DISPUTED_FUNDS_HELD"
"DISPUTED_FUNDS_RELEASED"
"CHARGEBACK_REVERSED"
|
|
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
|
|
The presence of the authorizationStatus property indicates that this was called as a post-authentication transaction.
|
transactions.authorizationStatus.authResult
|
Authorization Status
|
The 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"
"Declined"
"Unknown"
"Error"
|
|
transactions.authorizationStatus.dateTime
|
Authorization Date/Time
|
The date/time when the transaction was performed. Supported date/time format is ISO 8601. For example, “2021-03-02T19:01:37Z”.
|
String
|
"2022-10-31T22:01:43Z"
|
|
transactions.authorizationStatus.verificationResponse
|
Verification Response Properties Object
|
An object containing the details of the verification responses.
|
Object
|
|
|
transactions.authorizationStatus.verificationResponse.addressStatus
|
Address Verification System Status
|
The street verification response returned to the customer/merchant from the payment processor as validated by the Address Verification System (AVST). One value of the following enumerated values: "Unknown", "Match" or "NoMatch".
|
String
|
"Match"
|
|
transactions.authorizationStatus.verificationResponse.postalCodeStatus
|
Zip Code AVS Status
|
The Zip Code verification response returned to the customer/merchant from the payment processor as validated by the Address Verification System (AVSZ). One value of the following enumerated values: "Unknown", "Match" or "NoMatch".
|
String
|
"NoMatch"
|
|
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
|
"Unknown"
|
|
transactions.authorizationStatus.paymentCredentials
|
Payment Credentials Properties Object
|
An object containing the properties of the payment credentials, such as tokens used by digital payment methods.
|
Object
|
|
|
transactions.authorizationStatus.paymentCredentials.type
|
Payment Credentials Type
|
The type of payment used, such as specifying a digital payment method. For example, “SEPA”.
|
String
|
“SEPA”
|
|
transactions.authorizationStatus.paymentCredentials.token
|
Payment Credentials Token
|
The token used in the transaction as the credentials for the payment method. For example, “4pwmr0z2fh8qrt2isjdvkujow0”.
|
String
|
“4pwmr0z2fh8qrt2isjdvkujow0”
|
|
transactions.authorizationStatus.declineCode
|
Card Decline Code
|
The code returned by the payment provider for the reason a card was declined.
|
String
|
"01"
|
|
transactions.authorizationStatus.processorAuthCode
|
Processor Auth Code
|
The payment processor-provided authorization code. For example: "741256"
|
String
|
"741256"
|
|
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. Example: "NMI0983"
|
String
|
"NMI0983"
|
|
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. For example: "40614857370"
|
String
|
"40614857370"
|
|
promotions
|
Promotions Properties Array
|
An array containing all of the promotions applied to this order.
|
Array
|
|
|
promotions.id
|
Promotion ID
|
The merchant-provided identifier for the promotion. Uniqueness for this property is not enforced. Example: "BOGO10"
|
String
|
"BOGO10"
|
|
promotions.description
|
Promotion Description
|
The merchant-provided promotion description. For example: "Buy one, get one 10% off"
|
String
|
"Buy one, get one 10% off"
|
|
promotions.status
|
Promotion Status
|
The merchant-provided promotion status. For example: "accepted".
|
String
|
"accepted"
|
|
promotions.statusReason
|
Promotion Status Reason
|
The merchant-provided promotion status reason. For example: "Promotion cannot be combined."
|
String
|
"Promotion cannot be combined."
|
|
promotions.discount
|
Promotion Discount Properties Object
|
The object containing the details of the discount.
|
Object
|
|
|
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
|
|
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
|
|
promotions.credit
|
Credit Properties Object
|
An object containing the details of the amount of credit that was applied to this order.
|
Object
|
|
|
promotions.credit.creditType
|
Credit Type
|
A merchant-defined identifier for the type of credit that was applied. For example: "GIFT_CARD"
|
String
|
"GIFT_CARD"
|
|
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
|
|
loyalty
|
Loyalty Properties Object
|
An object containing the details of a credit that was applied from a loyalty account.
|
Array
|
|
|
loyalty.id
|
Loyalty ID
|
The unique identifier for the loyalty transaction. Uniqueness for this property is not enforced. Example: "d121ea2210434ffc8a90daff9cc97e76"
|
String
|
"d121ea2210434ffc8a90daff9cc97e76"
|
|
loyalty.description
|
Loyalty Description
|
A description of the loyalty program being applied. For example: "Pizza Points"
|
String
|
"Pizza Points"
|
|
loyalty.credit
|
Loyalty Credit Properties Object
|
An object containing the details of the loyalty credit that was applied to the order.
|
Object
|
|
|
loyalty.creditType
|
Loyalty Credit Type
|
A merchant-defined identifier for the type of credit that was applied. For example: "PIZZA_POINTS"
|
String
|
"PIZZA_POINTS"
|
|
loyalty.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
|
|
customFields
|
Custom Fields Array
|
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.
|
Object
|
{
"keyNumber": 42,
"keyBoolean": true,
"keyString": "value",
"keyDate": "2023-03-30T15:41:58Z"
}
|
|