Orders to RIS API Comparison

Orders API Property 

RIS API Property 

RIS Category 

Notes 

The Bearer token identifies the customer’s org/client.

MERC

System Information

/commerce/v{version number}/orders 

VERS

System Information

merchantOrderId

ORDR

System Information

channel

SITE

System Information

deviceSession Id

SESS

System Information

creationDateTime

N/A

userIp

IPAD

System Information

account

N/A

account.id

UNIQ

Misc Information

account.type

N/A

account.creationDateTime

EPOC

Misc Information

account.username

N/A

account.accountIsActive

N/A

items

N/A

items.id

N/A

items.price

PROD_PRICE[0]

Product Details

items.description

PROD_DESC[0]

Product Details

items.name

N/A

items.quantity

PROD_QUANT[0]

Product Details

items.category

PROD_TYPE[0]

Product Details

items.subCategory

N/A

items.isDigital

N/A

items.sku

PROD_ITEM[0]

Product Details

items.upc

N/A

items.brand

N/A

items.url

N/A

items.imageUrl

N/A

items.physicalAttributes

N/A

items.physicalAttributes.color

N/A

items.physicalAttributes.size

N/A

items.physicalAttributes.weight

N/A

items.physicalAttributes.height

N/A

items.physicalAttributes.width

N/A

items.physicalAttributes.depth

N/A

items.descriptors

N/A

items.isService

N/A

fulfillment

N/A

fullfillment.merchantFulfillmentId

N/A

fulfillment.type

SHIP

Shipping Information

fulfillment.items

N/A

fulfillment.status

N/A

fulfillment.accessUrl

N/A

fulfillment.shipping

N/A

fulfillment.shipping.amount

N/A

fulfillment.shipping.provider

N/A

fulfillment.shipping.trackingNumbers

N/A

fulfillment.shipping.method

SHIP

Shipping Information

fulfillment.recipientPerson

N/A

fulfillment.recipientPerson.name

N/A

fulfillment.recipientPerson.name.first

fulfillment.recipientPerson.name.family

S2NM

Shipping Information

fulfillment.recipientPerson.name.middle

N/A

fulfillment.recipientPerson.name.prefix

N/A

fullfillment.recipientPerson.name.suffix

N/A

fulfillment.recipientPerson.name.preferred

N/A

fulfillment.recipientPerson.dateOfBirth

N/A

fulfillment.recipientPerson.emailAddress

S2EM

Shipping Information

fulfillment.recipientPerson.phoneNumber

S2PN

Shipping Information

fulfillment.recipientPerson.address

N/A

fulfillment.recipientPerson.address.line1

S2A1

Shipping Information

fulfillment.recipientPerson.address.line2

S2A2

Shipping Information

fulfillment.recipientPerson.address.city

S2CI

Shipping Information

fulfillment.recipientPerson.address.region

S2ST

Shipping Information

fulfillment.recipientPerson.address.countryCode

S2CC

Shipping Information

fulfillment.recipient.address.postalCode

S2PC

Shipping Information

fulfillment.store

N/A

fulfillment.store.id

N/A

fulfillment.store.name

N/A

fulfillment.store.address

N/A

fulfillment.store.address.addressType

N/A

fulfillment.store.address.line1

N/A

fulfillment.store.address.line2

N/A

fulfillment.store.address.city

N/A

fulfillment.store.address.region

N/A

fulfillment.store.address.countryCode

N/A

fulfillment.store.address.postalCode

N/A

transactions

N/A

transactions.merchantTransactionId

N/A

transactions.processor

N/A

transactions.processorMerchantId

N/A

transactions.payment

N/A

transactions.payment.type

PTYP

Payment Information

transactions.payment.paymentToken

PTOK

Payment Information

The hashed payment token used in the order.

N/A

PENC

Payment Information

N/A

MASK

Payment Information

transactions.payment.bin

LBIN

Payment Information

The first 6-8 digits of the 16 digit Primary Account Number (PAN).

transactions.payment.last4

LAST4

Payment Information

transactions.subtotal

N/A

transactions.orderTotal

TOTL

Payment Information

transactions.currency

CURR

Payment Information

transactions.tax

N/A

transactions.tax.isTaxable

N/A

transactions.tax.taxableCountryCode

N/A

transactions.tax.taxAmount

N/A

transactions.tax.outOfStateTaxAmount

N/A

transactions.billedPerson

N/A

transactions.billedPerson.name

N/A

transactions.billedPerson.name.first

transactions.billedPerson.name.family

NAME

Billing Information

transactions.billedPerson.name.middle

N/A

transactions.billedPerson.name.prefix

N/A

transactions.billedPerson.name.suffix

N/A

transactions.billedPerson.name.preferred

N/A

transactions.billedPerson.emailAddress

EMAL

Billing Information

transactions.billedPerson.phoneNumber

B2PN

Billing Information

transactions.billedPerson.address

N/A

transactions.billedPerson.address.line1

B2A1

Billing Information

transactions.billedPerson.address.line2

B2A2

Billing Information

transactions.billedPerson.address.city

B2CI

Billing Information

transactions.billedPerson.address.region

B2ST

Billing Information

transactions.billedPerson.address.postalCode

B2PC

Billing Information

transactions.billedPerson.address.countryCode

B2CC

Billing Information

transactions.billedPerson.dateOfBirth

N/A

transactions.transactionStatus

N/A

transactions.authorizationStatus

N/A

transactions.authorizationStatus.authResult

AUTH

Payment Information

transactions.authorizationStatus.dateTime

N/A

transactions.authorizationStatus.verificationResponse

N/A

transactions.authorizationStatus.verificationResponse.avsStatus

AVST

transactions.authorizationStatus.verificationResponse.avsStatus

AVSZ

transactions.authorizationStatus.verificationResponse.cvvStatus

CVVR

transactions.authorizationStatus.declineCode

N/A

transactions.authorizationStatus.processorAuthCode

N/A

transactions.authorizationStatus.processorTransactionId

N/A

transactions.authorizationStatus.acquirerReferenceNumber

N/A

transactions.items

N/A

transactions.items.id

N/A

transactions.items.quantity

N/A

promotions

N/A

promotions.id

N/A

promotions.description

N/A

promotions.status

N/A

promotions.statusReason

N/A

promotions.discount

N/A

promotions.discount.percentage

N/A

promotions.discount.amount

N/A

promotions.discount.currency

N/A

promotions.credit

N/A

promotions.credit.currency

N/A

promotions.credit.creditType

N/A

promotions.credit.amount

N/A

loyalty

N/A

loyalty.id

N/A

loyalty.description

N/A

loyalty.credit

N/A

loyalty.credit.creditType

N/A

loyalty.credit.amount

N/A

loyalty.credit.currency

N/A

customFields

UDF[]

N/A

MACK

System Information

The merchant's acknowledgement to ship/process an order. In Command, this value is hardcoded as Y.

N/A

ANID

System Information

Automatic Number Identification (Caller ID) submitted with an order. If the ANI cannot be determined, set the value to 0123456789. In Command, this is only available in Mode P. 

N/A

CASH

Misc Information

The total monetary value of goods in the order.

N/A

GENDER

Misc Information

M for male or F for female

N/A

UAGT

Misc Information

Customer User-Agent HTTP header.

N/A

FRMT

Misc Information

Specifies the format of the RIS response if the customer is not using an SDK. The options are XML, JSON, and YAML.

Hard code the RIS API to JSON.

Orders API Property 

RIS API Property 

Notes 

The Orders API POST is equivalent to mode Q in Command.

MODE

version

VERS

order

N/A

order.orderId

TRAN

order.merchantOrderId

ORDR

order.channel

SITE

order.deviceSessionId

SESS

order.creationDateTime

N/A

order.riskInquiry

N/A

order.riskInquiry.guidance

N/A

order.riskInquiry.decision

AUTO

order.riskInquiry.omniscore

OMNISCORE

order.riskInquiry.persona

N/A

order.riskInquiry.persona.uniqueCards

N/A

order.riskInquiry.persona.uniqueDevices

DEVICES

order.riskInquiry.persona.uniqueEmails

EMAILS

order.riskInquiry.device

N/A

order.riskInquiry.device.id

FINGERPRINT

KAPT

If the device data collection did not finish collecting (KAPT), then this property will not be populated.

order.riskInquiry.device.collectionDateTime

N/A

order.riskInquiry.device.browser

BROWSER

order.riskInquiry.device.deviceAttributes

N/A

order.riskInquiry.device.deviceAttributes.os

OS

MOBILE_DEVICE

MOBILE_TYPE

The OS can be used to determine whether the device is a mobile device. It can also be used to determine the type/brand of the mobile device. For example, iPhone, Android, or iPad.

order.riskInquiry.device.deviceAttributes.firstSeenDateTime

DDFS

order.riskInquiry.device.deviceAttributes.language

LANGUAGE

order.riskInquiry.device.deviceAttributes.timezoneOffset

TIMEZONE

order.riskInquiry.device.deviceAttributes.mobileSdkType

MOBILE_TYPE

For mobile app integrations using the Device mobile SDKs, this will indicate the mobile type. See order.riskInquiry.device.deviceAttributes.os for browser-based orders.

order.riskInquiry.device.location

N/A

order.riskInquiry.device.location.areaCode

N/A

order.riskInquiry.device.location.city

N/A

order.riskInquiry.device.location.country

N/A

order.riskInquiry.device.location.countryCode

COUNTRY

order.riskInquiry.device.location.latitude

N/A

order.riskInquiry.device.location.longitude

N/A

order.riskInquiry.device.location.postalCode

N/A

order.riskInquiry.device.location.region

REGION

order.riskInquiry.device.location.regionCode

N/A

order.riskInquiry.device.tor

N/A

order.riskInquiry.segmentExecuted

N/A

order.riskInquiry.segmentExecuted.segment

N/A

order.riskInquiry.segmentExecuted.segment.id

N/A

order.riskInquiry.segmentExecuted.segment.name

N/A

order.riskInquiry.segmentExecuted.policiesExecuted

RULES_TRIGGERED

order.riskInquiry.segmentExecuted.policiesExecuted.id

RULE_ID_X

order.riskInquiry.segmentExecuted.policiesExecuted.name

RULE_DESCRIPTION_X

order.riskInquiry.segmentExecuted.policiesExecuted.outcome

N/A

order.riskInquiry.segmentExecuted.policiesExecuted.outcome.type

N/A

order.riskInquiry.segmentExecuted.policiesExecuted.outcome.value

N/A

order.fulfillments

N/A

order.fulfillments.fulfillmentId

N/A

order.fulfillments.merchantFulfillmentId

N/A

order.transactions.kountTransactionId

N/A

The HTTP error code and the response body will indicate the errors.

ERROR

Errors 

A required data point is misconfigured which prevented the risk analysis.

The HTTP error code and the response body will indicate the errors.

ERROR_COUNT

Errors 

Number of errors the customer's RIS POST created.

The HTTP error code and the response body will indicate the errors.

ERROR_N

Errors 

The error code displayed in RIS response.

N/A

WARNING_COUNT

Errors 

Number of warnings the merchant RIS POST created.

N/A

WARNING_N

Errors 

The warning code displayed in RIS response.

N/A

BRND

Brand of credit card used when payment type is credit card, such as Visa or MasterCard.

N/A

DEVICE_LAYERS

Device (Intentionally Excluded) 

Five device layers representing the operating system.

N/A

COOKIES

Device 

A flag to indicate if the device placing order has cookies enabled or not.

N/A

DSR

Device 

The device screen resolution.

N/A

FLASH

Device (Obsolete – Intentionally Excluded) 

A flag to indicate if the device placing order has flash enabled or not.

N/A

HTTP_COUNTRY

Device 

The home country the device owner has set in the device’s control panel.

N/A

IP_IPAD

Device 

IP address of proxy:

N/A

PIP_IPAD

Device 

The pierced IP address: 

N/A

JAVASCRIPT

Device 

A flag to indicate if the device placing order has JavaScript enabled or not.

N/A

LOCALTIME

Device 

The local time of the device that the owner has set in the device’s Control Panel.

N/A

MOBILE_FORWARDER

Device 

Determines if the mobile device is using a forwarder to process the carrier’s service.

N/A

NETW

Device (Intentionally Excluded) 

Riskiest network type associated with persona within the last 14 days: 

N/A

PC_REMOTE

Device 

Indicates if the device is enabled to use PC remote software.

N/A

PROXY

Device 

Indicates if a proxy server is detected with this order.

N/A

UAS

Device 

The user agent string.

N/A

VOICE_DEVICE

Device 

Indicates if the device is voice activated (related to mobile devices).

N/A

CARDS

Persona 

Total number of credit cards associated to persona as seen by Equifax.

N/A

GEOX

Persona 

The Persona related country with highest probability of fraud.

N/A

REGN

Persona 

The region associated to the GEOX location.

N/A

SCOR

Persona 

The Persona score.

N/A

VELLO

Persona 

The quantity of orders seen from the Persona within last 14 days. AUTH field must be equal to A.

N/A

VMAX

Persona 

The quantity of orders from the Persona within the most active six hour window in last 14 days. AUTH field must be equal to A.

N/A

COUNTER_NAME_X

Rules/Counters 

N/A

COUNTER_VALUE_X

Rules/Counters 

N/A

COUNTERS_TRIGGERED

Rules/Counters 

Number of unique counter names triggered during rules evaluation.

N/A

REASON_CODE

Rules/Counters 

The Custom Reason Code associated with Rule Action.

N/A

3D_SECURE_MERCHANT_RESPONSE

3DS 

The 3D Secure recommendation based on policies defined within Equifax.

N/A

PREVIOUSLY_WHITELISTED

3DS 

Related to a 3DS workflow.

N/A

KYCF

Whether or not the system knows your customer flag.

N/A

MERC

(Intentionally Excluded) 

Merchant ID assigned to the merchant by Equifax.