Edit

Share via

View purchase protection schemas

  • Article

This article outlines the schemas for real-time APIs and historical data that is bulk-uploaded into Microsoft Dynamics 365 Fraud Protection. For information about the upload procedure, see Upload historical data. If data will be ingested via the application programming interface (API), see Integrate Dynamics 365 Fraud Protection real-time APIs.

Follow these requirements:

  • The files are in CSV UTF-8 (comma, semi-colon, or tab-delimited) format (*.csv or *.tsv).
  • The maximum file size is 10 gigabytes (GB).
  • The following characters are escaped in all columns: commas/semi-colons, new line characters, and multiline characters.
  • 'datetime' columns are in ISO 8601 format. For example, in C# DateTime.UtcNow.ToString("o") would have the format "2019-03-14T20:18:11.254Z".
  • 'double' (decimal) column precision is two decimal places.

Transactions

The following schemas are used in the evaluate and protect experiences.

Purchases

Attribute Type Description
PurchaseId String The identifier of the transaction (or purchase or order).
OriginalOrderId String The original order identifier for payments of recurring billing, such as monthly subscription billing.
CustomerLocalDate DateTime The purchase creation date in the customer's local time zone. The format is ISO 8601.
MerchantLocalDate DateTime The purchase ingestion date in the merchant's local time zone. The format is ISO 8601.
TotalAmount Double The total amount that was charged to the customer including tax. This information is provided by the merchant.
SalesTax Double The sales tax that was charged for the transaction. This information is provided by the merchant.
Currency String The currency of the original purchase as a three-character currency code (for example: USD, which is aligned with the OANDA currency code). This information is provided by the merchant.
DeviceContextId String The session ID of the event's session (provided by Microsoft Device Fingerprinting) or the transaction ID if the session isn't available.
IPAddress String The customer's IP address. This information is provided by Microsoft Device Fingerprinting.
UserId String The customer identifier. This information is provided by the merchant. This attribute is required.
UserFirstName String The customer-provided first name on the customer account.
UserLastName String The customer-provided last name on the customer account.
UserEmail String The customer's email address. This value is case-insensitive.
UserCreationDate DateTime The creation date of the customer account. The format is ISO 8601.
UserUpdateDate DateTime The date when customer data was last changed. The format is ISO 8601.
UserZipCode String The customer's postal code.
UserCountryCode String The customer's country or region. The value should be a two-letter country or region code (for example: US).
UserTimeZone String An empty string.
UserLanguage String The customer's language and language territory (for example: EN-US).
UserPhoneNumber String The customer's phone number. The format should be the country or region code followed by a hyphen (-) and then the phone number (for example: for the US, +1-1234567890).
IsEmailValidated Boolean A True/False value that indicates whether the customer-provided email address has been verified as owned by the customer.
ShippingFirstName String The first name that was provided for the address.
ShippingLastName String The last name that was provided for the address.
ShippingPhoneNumber String The phone number that was provided for the address. The format should be the country or region code followed by a hyphen (-) and then the phone number (for example: for the US, +1-1234567890).
Street1 String The first row that was provided for the address.
Street2 String The second row that was provided for the address. (This value can be blank.)
Street3 String The third row that was provided for the address. (This value can be blank.)
City String The city that was provided for the address.
State String The state or province that was provided for the address.
ZipCode String The postal code that was provided for the address.
CountryCode String The country or region code that was provided for the address. The value should be a two-letter ISO country or region code (for example: US).
CustomData Object An optional user-defined JavaScript Object Notation (JSON) property bag. It's filled in when an API call is instantiated. The attributes can be referenced when you create purchase rules.

Note:

  • The following primitive types are supported: String (Unicode), Int32, UInt32, Double, Boolean, and DateTime (in Coordinated Universal Time [UTC], in conformance to .NET semantics).
  • The string data limit is 256 characters.
  • There is a limit of 100 custom attributes per payload.
  • Don't send sensitive or highly regulated data types. Here are some examples:
    • Data that indicates a protected class (such as gender or race) or private/sensitive categories (such as religious views or sexual orientation)
    • Biometric data or any data that is related to health
  • The custom data retention policy matches the retention policy of the purchase event (six months).

For a sample that shows how to use purchase APIs with a custom data object in Fraud Protection, see the Custom data sample section at the end of this article.
MerchantBusinessType String The business or industry vertical (for example: gaming, retail, dining, or social networking).
MerchantIdentifier String The merchant ID (MID) is a specific identification number attached to a business that tells the payment processing systems involved in a transaction where to send which funds. You can think of it like an address for your business. For example, if you don't have a merchant ID, the networks involved won't know where to send your money.
MerchantCategoryCode String The merchant category code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. An MCC is used to classify a business by the types of goods or services it provides.
MerchantBusinessSegment String The subsection of a merchant’s overall operations in which there is an established, separate product line, business line or child brand (for example: Xbox or Surface).
MerchantProductCategory String The merchant-defined product or service category.
StoreId String The store identifier.
StoreName String The store display name.
StoreAddress String The full address (street, city, state, zip) of the store.
IsTest Boolean A value that indicates whether the transaction is a test in production.
IsFreeProductIncluded Boolean A value that indicates whether a free product is included in the transaction.
IsGuestCheckout Boolean A value that indicates whether the purchase was made as a guest.
IsPostAuthCheck Boolean A value that indicates whether there was a post-authentication check.
IsRecurringCharge Boolean A value that indications whether the transaction was a subscription/recurring.
RecurringChargeFrequencyInDays Double How often the recurring purchase is being charged, for example, every 30 days, every half year, every year, etc.
RecurringChargeStartDate DateTime The start date for a recurring transaction.
RecurringChargeEndDate DateTime The end date for a recurring transaction.
IsPostpaid Boolean A value that indicates whether a transaction is postpaid or not.
DiscountAmount Double The discount amount applied to the transaction. For example, if a user purchases 10 of the same XBOX controllers, this item will be number 1. Or, if a user purchase 5 different games and 10 of the same XBOX controllers, this item will be number 5+1, or 6.
TipAmount Double The tip amount applied to the transaction.
DistinctItemCount Double The distinct/unique item count per transaction.
TotalItemCount Double The total item count per transaction. For example, if a user purchases 10 of the same XBOX controllers, this item will be number 10. Or, if a user purchase 5 different games and 10 of the same XBOX controllers, this item will be number 5+10, or 15.
IsLowLiabilityPIType Boolean A value that indicates low liability payment instruments (for example: Apple Pay, Alipay, or UnionPay).
OrderType String The type of transaction (for example: takeout).
IsRetryOrder Boolean A value that indicates whether the order was retried.
AttemptId String The identifier for each transaction retry.
ShippingDate DateTime The date that the order was shipped.
OrderInitiatedChannel String The channel where the transaction was created (for example: ‘AppStore', 'Web', MobileWeb, 'App', ‘InGamePurchase’).
OrderInitiatedChannelName String The App Name or Web URL where the transaction was created.
OrderInitiatedChannelRegionORCountry String The market where the transaction was created (for example: App market).
MerchantBusinessSubSegmentL2 String The second level (L2) business or industry segment.
MidName String The merchant name associated with the MID (merchant identifier).
TransactionProcessingOrder String The order in which the fraud assessment was made during the transaction flow.
RecurringSubscriptionId String The unique ID for the recurring charge
RecurringChargeSequence Int32 The nth (1, 2, 3...) time the recurring charge has occurred for this customer.
TransactionDescription String The transaction processing type
OrganizationLevel1 Object The top level of the organization hierarchy.
OrganizationLevel2 Object The middle level of the organization hierarchy.
OrganizationLevel3 Object The lowest level of the organization hierarchy.
ThreeDS Object Refer to ThreeDS section.
RecipientUser Object Refer to user section.
TravelOverview Object Refer to Vertical-specific attributes TravelOverview section.
CloudBusiness Object Refer to Vertical-specific attributes CloudBusiness section.
MembershipType String The customer's membership status or type. Different levels can be specified such as Premium and Executive.
AuthenticationMethod String The way in which the customer was authenticated prior/during purchase.
LoginInputMethod String The way in which the customer input their credentials.
LastPasswordUpdatedDate DateTimeOffset When the customer's password was last updated.
FirstPurchaseDate DateTimeOffset When the customer made their first purchase
LoginChallengeType String The type of challenge-response test that was initiated.
HttpSignature String The digital signature of the HTTP message.
HttpUserAgent String The request header used to identify the application, operating system, vendor, and/or version.
BrowserHeader String The full list of request headers sent by the browser.
BrowserResolution String The browser resolution.
BrowserLanguage String The browser default language preference.
TcpSignature String The TCP application signature.
SslSignature String The SSL signature.
EnabledCookies Boolean A True/False value that indicates whether cookies are enabled.
EnabledFlash Boolean A True/False value that indicates whether Flash is enabled.
EnabledJavaScript Boolean A True/False value that indicates whether JavaScript is enabled.
ScreenAspectRatio String The aspect ratio of the browser.
ScreenColorDepth String The color depth of the screen.
ScreenResolution String Resolution of device screen in pixels
SiteHostName String The site's hostname.
OS String The device operating system.
OSFonts String The operating system's default font.
DeviceProcessor String The device processor.
SessionId String The unique session ID.
TrueIp String True IP address of device identified by device fingerprinting​
ProxyIp String IP address of proxy device.
DeviceId String Unique GUID per device generated by device fingerprinting
TimeZone String Offset of the local time zone, in hours, with respect to GMT
UserAgentDetails String Additional user agent or browser details.
AppVersion String Application version.
BrowserPackagesList String List of packages installed on the device.
BuildManufacturer String Manufacturer of the device.
BuildModel String User visible name for the end product.
BuildSdkVersion String Build version.
DataNetworkType String Type of mobile data network.
DeviceModelName String Device model.
DeviceSystemName String Device name of the machine.
DeviceSystemVersion String Device version.
IsBluetoothEnabled Boolean A True/False value that indicates whether Bluetooth has been enabled.
SimNetworkCountryISO String ISO country code for the mobile service provider.
SimNetworkType String Mobile network type.
SystemUpTime String The duration of time that the device has been working and available.
PaymentMethod String The top-level payment method category.
IsLowLiabilityPIType Boolean A True/False value indicating whether the payment method is a low liability.
HolderCompanyName Boolean Name of the organization providing the business or company card (for business purchases only).
SettlementApprovalRequired Boolean A True/False value indicating whether or not approval was required for a SEPA transaction.
PaymentCheckoutProvider String The eWallet checkout provider.
BinName String The BIN display name.
BinCountryISO String The ISO country code associated with the BIN.
BinCardType String The BIN card type.
BinCardAssociation String The BIN card association.
BinBankGroup String The BIN bank group.
Currency String Currency code for the selected payment instrument.
IsInternationalMoneyTransfer Boolean A True/False value indicating whether an international money transfer occurred.
BankIdentifierCode String Bank Identifier Code (BIC or SWIFT code)
BankName String The bank name.
BankZipCode String The bank zip code.
BankState String The bank state.
BankCountryISO String The bank ISO country.
PaymentCollectionDate DateTimeOffset The estimated date for payment collection (primarily used for payment service providers).
InstantPaymentSettlement Boolean A True/False value indicating bank redirects (used to support CSV payments).
AutoCaptureEnabled Boolean A True/False value indicating whether the payment was automatically captured for card payments. For redirect payments this is simply an indicator to the partner bank whether to withdraw funds automatically or not.
AccountType String Indicates the type of account to charge for the transaction. UNSPECIFIED is the default. CHEQUE_ACCOUNT uses the card as a debit card. CREDIT_FACILITY uses the card as a credit card.
AuthorizationType String The authorization type. Mastercard and Visa now require merchants to define authorization attempts as either a pre-authorization or a final-authorization.
AuthorizationResultCode String Bank response from the authorization decision.
AuthorizationResultText String Reasons for the authorization decision, especially for declined or pending transactions.
AcquirerId String Acquiring institution identification code.
AcquirerCountryISO String Acquiring institution country code.
CvvVerify String Indicates whether CVV verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
AvsVerify String Indicates whether address verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
CavVerify String Indicates whether cardholder authentication verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
EncryptedCreditCardNumber String The hashed or encrypted credit card number.
OrganizationId String The unique identifier for the merchant or organization.
Name String The name of the organization.
ZipCode String The zip code at where the organization is located.
State String The state at where the organization is located.
CountryISO String The country ISO code for where the organization is located.
ProductBrand String Brand name of the product.
BuyItAgainOrder Boolean True when users re-order a previous order (not just a product from that order).
PreOrderAvailabilityDate DateTimeOffset When the product was first available for preorder.
TerminalId String The unique identifier for the point of sale terminal.
TerminalName String The point of sale terminal name.
IsThreeDSAuth Boolean A True/False value that indicates whether this transaction is authenticated via 3DS.
MessageCategory String Identifies the category of the message for a specific use case.
DeviceChannel String Indicates the type of channel interface being used to initiate the transaction.
ThreeDSServerTransId String Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
ThreeDSRequestorAuthenticationInd String Indicates the type of authentication request.
ThreeRIInd String Indicates the type of 3RI request.
ThreeDSReqPriorAuthMethod String Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
TransStatus String Indicates whether a transaction qualifies as an authenticated transaction or account verification.
TransStatusReason String Provides information on why the Transaction Status field has the specified value.
ThreeDSCompInd String Indicates whether the 3DS Method successfully completed.
AcsChallengeMandated String Indication of whether a challenge is required for the transaction to be authorized due to local/regional mandates or other variable.
ThreeDSRequestorChallengeInd String Indicates whether a challenge is requested for this transaction.
ChallengeCompletionInd String Indicator of the state of the ACS challenge cycle and whether the challenge has completed or will require additional messages.
Values accepted:
Eci String Electronic Commerce Indicator (ECI). Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder.
ShipNameIndicator String Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.
SuspiciousAccActivity String Indicates whether the 3DS requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
ChAccPwChangeInd String Indicates the length of time since the cardholder’s account with the 3DS requestor had a password change or account reset.
ChAccAgeInd String Length of time that the cardholder has had the account with the 3DS requestor.
ProvisionAttemptsDay String Number of Add Card attempts in the last 24 hours.
Length: Maximum 3 characters.

Example values:
  • 2
  • 02
  • 002
ExemptionRaised String

PSD2 exemption requests.

  • Y - exempted
  • N- Not exempted

PaymentInstruments

Attribute Type Description
PurchaseId String The identifier of the transaction (or purchase or order).
MerchantPaymentInstrumentId String The identifier of the payment instrument. This information is provided by the merchant. This is a required attribute.
Type String The type of payment. For more information, see Dynamics 365 Fraud Protection API.
PurchaseAmount Double The total purchase amount that uses this payment instrument for the transaction.
CreationDate DateTime The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.
UpdateDate DateTime The date of the last update for the payment instrument in the merchant's system. The format is ISO 8601.
CardType String This attribute is used only for payments of the CreditCard type.
HolderName String The name of the customer of the payment instrument. This attribute is used only for payments of the CreditCard type.
BIN String This attribute is used only for payments of the CreditCard type.
ExpirationDate String The expiration date for the payment instrument in the merchant's system. The format is ISO 8601. This attribute is used only for payments of the CreditCard type.
LastFourDigits String This attribute is used only for payments of the CreditCard type.
Email String The email address that is associated with the payment instrument. This attribute is used only for payments of the Paypal type.
BillingAgreementId String This attribute is used only for payments of the Paypal type.
PayerId String This attribute is used only for payments of the Paypal type.
PayerStatus String A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type.
AddressStatus String A value that indicates whether PayPal has verified the payer's address. This attribute is used only for payments of the Paypal type.
IMEI String This attribute is used only for payments of the Mobilepayment type.
FirstName String The first name that was provided for the address.
LastName String The last name that was provided for the address.
PhoneNumber String The phone number that was provided for the address. The format should be the country or region code followed by a hyphen (-) and then the phone number (for example: for the US, +1-1234567890).
Street1 String The first row that was provided for the address.
Street2 String The second row that was provided for the address. (This value can be blank.)
Street3 String The third row that was provided for the address. (This value can be blank.)
City String The city that was provided for the address.
State String The state or province that was provided for the address.
ZipCode String The postal code that was provided for the address.
CountryCode String The country/region code that was provided for the address. The value should be a two-letter ISO country or region code (for example: US).
PISource String The payment instrument source (for example: CustomerInput, FromSavedProfile, MobilePay).

Products

Attribute Type Description
PurchaseId String The identifier of the transaction (or purchase or order).
ProductId String The product identifier. This is a required attribute.
PurchasePrice Double The price for the line item of the purchase.
Margin String The margin that was gained by the sale of the item.
Quantity Int32 The number of items that were purchased.
ProductName String The customer-readable product name.
Type String A value that indicates whether the goods were physical or digital.
Category String The category of product (for example: Apparel, Shoes, or Accessories).
Market String The market where the product is offered. The value should be a two-letter ISO country or region code (for example: US).
Sku String The product's stock keeping unit (SKU).
SalesPrice Double The price of the item that was sold excluding tax. This information is provided by the merchant.
Currency String The currency of the original purchase as a three-character currency code (for example: USD, which is aligned with the OANDA currency code). This information is provided by the merchant.
COGS Double The cost of goods sold (that is, the raw material cost of the item). This information is provided by the merchant.
IsRecurring Boolean A value that indicates whether the product is a recurring subscription.
IsFree Boolean A value that indicates whether the product is offered for free.
Language String The language and language territory (for example: EN-US).

Chargebacks

The following schema is used in the evaluate and and protect experiences.

Attribute Type Description
ChargebackId String The chargeback identifier.
Reason String The reason that was provided by the bank.
Status String The status. For more information, see Dynamics 365 Fraud Protection API.
BankEventTimestamp DateTime The timestamp from the bank. The format is ISO 8601.
Amount Double The chargeback amount.
Currency String The currency that is used for the chargeback amount.
UserId String The customer identifier.
PurchaseId String The identifier of the transaction (or purchase or order).
MerchantLocalDate DateTime The purchase ingestion date in the merchant's local time zone. The format is ISO 8601.

Refunds

The following schema is used in the evaluate and protect experiences.

Attribute Type Description
RefundId String The refund identifier.
Reason String The customer-provided reason.
Status String The refund status. For more information, see Dynamics 365 Fraud Protection API.
BankEventTimestamp DateTime The timestamp from the bank. The format is ISO 8601.
Amount Double The refund amount.
Currency String The currency that is used for the sales price amount.
UserId String The customer identifier. This is a required attribute.
PurchaseId String The identifier of the transaction (or purchase or order).
MerchantLocalDate DateTime A date in ISO 8601 format.

PurchaseStatus

The following schema is used in the evaluate and protect experiences.

Attribute Type Description
PurchaseId String The identifier of the transaction (or purchase or order).
StatusType String The type of status. For more information, see Dynamics 365 Fraud Protection API.
StatusDate DateTime The date and time when the status was applied. The format is ISO 8601.
Reason String The reason for the status transition.
MerchantLocalDate DateTime A date in ISO 8601 format.

BankEvents

The following schema is used in the evaluate and protect experiences.

Attribute Type Description
BankEventId String The bank event identifier.
Type String The bank event type. For more information, see Dynamics 365 Fraud Protection API.
BankEventTimestamp DateTime The timestamp from the bank. The format is ISO 8601.
Status String The status. For more information, see Dynamics 365 Fraud Protection API.
BankResponseCode String The bank code on the response.
PaymentProcessor String The processor name (for example: FDC or PayPal).
MRN String The Merchant Reference Number (MRN) that is used to identify the transaction on the merchant side.
MID String The merchant ID (MID) that is used for bank communication.
PurchaseId String The identifier of the transaction (or purchase or order).
MerchantLocalDate DateTime A date in ISO 8601 format.
MerchantPaymentInstrumentId String Multiple PI scenario & PI change scenario.
PaymentMethod String Groupings/categories of payment methods.
CardType String The type of payment.
UpdatedPI String Used different PI than the one in Purchase?
CvvVerify String Indicates whether CVV verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
AvsVerify String Indicates whether address verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
CavVerify String Indicates whether cardholder authentication verification is available and/or successfully verified.
  • Y = Successfully verified
  • N = Not successfully verified
  • U = Unavailable
  • A = Available, but no verification
AuthorizationResultCode String Bank response from the authorization decision.
AuthorizationResultText String Reasons for the authorization decision; especially for declined or pending transactions.
ThreeDS String Refer to Purchase ThreeDS section in Purchase sheet.

Account

The following schemas are used in the evaluate and protect experiences.

UpdateAccount

Attribute Type Description
CustomerLocalDate DateTime A date in ISO 8601 format.
UserId String The customer identifier. This is a required attribute.
UsercreationDate DateTime A date in ISO 8601 format.
UserupdateDate DateTime A date in ISO 8601 format.
FirstName String The customer-provided first name on the customer account.
LastName String The customer-provided last name on the customer account.
CountryCode String The customer's country or region. The value should be a two-letter country or region code (for example: US).
ZipCode String The customer's postal code.
TimeZone String This attribute is obsolete (deprecated). Provide an empty string as the value.
Language String The customer's language and language territory (for example: EN-US).
PhoneNumber String The customer's phone number. The format should be the country/region code followed by a hyphen (-) and then the phone number (for example: for the US, +1-1234567890).
Email String The customer's email address. This value is case-insensitive.
IsEmailValidated Boolean A value that indicates whether the customer-provided email has been verified as owned by the customer.
EmailValidatedDate DateTime The date when the customer-provided email was verified as owned by the customer. The format is ISO 8601.
IsPhoneNumberValidated Boolean A value that indicates whether the customer-provided phone number has been verified as owned by the customer.
PhoneNumberValidatedDate DateTime The date when the customer-provided phone number was verified as owned by the customer. The format is ISO 8601.
DeviceContextId String The session ID of the event's session (provided by Microsoft Device Fingerprinting) or the transaction ID if the session isn't available.
Provider String A value that indicates the source of the deviceContextId value: DFP Fingerprinting or Merchant.
DeviceContextDC String The Microsoft Device Fingerprinting data center for the customer's session ID.
ExternalDeviceId String The customer's device ID. This information is provided and mastered by the merchant.
ExternalDeviceType String The device type as identified by the merchant (for example: PC or Mobile Device).
IpAddress String The customer's IP address. This information is provided by Microsoft Device Fingerprinting.
MerchantLocalDate DateTime A date in ISO 8601 format.
MembershipType String The customer's membership status or type.
LoginInputMethod String The method the customer uses to input their credentials.
LastPasswordUpdatedDate String When the customer's password was last updated.
FirstPurchaseDate String When the customer made their first purchase.
LoginChallengeType String The type of challenge-response test that was initiated.
AddressList String Refer to Purchase Address section.
PaymentInstrumentList String Refer to Purchase PaymentInstrumentList section.
DeviceContext String Refer to Purchase DeviceContext section.

UpdateAddress

Attribute Type Description
UserId String The customer identifier. This is a required attribute.
Addresstype String The address type: Billing, Shipping, Account, or Unknown.
FirstName String The first name that was provided for the address.
LastName String The last name that was provided for the address.
PhoneNumber String The phone number that was provided for the address.
Street1 String The first row that was provided for the address.
Street2 String The second row that was provided for the address. (This value can be blank.)
Street3 String Third row that was provided for the address. (This value can be blank.)
City String The city that was provided for the address.
State String The state or province that was provided for the address.
District String The district that was provided for the address. (This value can be blank.)
ZipCode String The postal code that was provided for the address.
CountryCode String The country or region code that was provided for the address. The value should be a two-letter ISO country or region code (for example: US).

UpdatePaymentInstrument

Attribute Type Description
UserId String The customer identifier. This is a required attribute.
MerchantPaymentInstrumentId String The identifier of the payment instrument. This information is provided by the merchant. This is a required attribute.
PaymentInstrumenttype String The type of payment: CreditCard, Paypal, CH, SEPA, BACS, Mobilepayment, Giftcard, or other.
PaymentInstrumentcreationDate DateTime The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.
PaymentInstrumentupdateDate DateTime The date of the last update for the payment instrument in the merchant's system. The format is ISO 8601.
PaymentInstrumentState String The state of the payment instrument: Active, Block, or Expire.
CardType String This attribute is used only for payments of the CreditCard type.
HolderName String The name of the customer of the payment instrument. This attribute is used only for payments of the CreditCard type.
BIN String This attribute is used only for payments of the CreditCard type.
ExpirationDate String The expiration date for the payment instrument in the merchant's system. This attribute is used only for payments of the CreditCard type.
LastFourDigits String This attribute is used only for payments of the CreditCard type.
Email String The email address that is associated with the payment instrument. This attribute is used only for payments of the Paypal type.
BillingAgreementId String This attribute is used only for payments of the Paypal type.
PayerId String This attribute is used only for payments of the Paypal type.
PayerStatus String A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type.
AddressStatus String A value that indicates whether PayPal has verified the payer's address. This attribute is used only for payments of the Paypal type.
IMEI String This attribute is used only for payments of the Mobilepayment type.
BillingAddressfirstName String The first name that was provided for address.
BillingAddresslastName String The last name that was provided for address.
BillingAddressphoneNumber String The phone number that was provided for address. The format should be the country or region code followed by a hyphen (-) and then the phone number (for example: for the US, +1-1234567890).
Street1 String The first row that was provided for the address.
Street2 String The second row that was provided for the address. (This value can be blank.)
Street3 String Third row that was provided for the address. (This value can be blank.)
City String The city that was provided for the address.
State String The state or province that was provided for the address.
District String The district that was provided for the address. (This value can be blank.)
ZipCode String The postal code that was provided for the address.
CountryCode String The country or region code that was provided for the address. The value should be a two-letter ISO country or region code (for example: US).

Labels

The following schema is used in the evaluate and protect experiences.

Attribute Type Description
TrackingId String The unique ID for each event/record.
MerchantLocalDate DateTime The date in the merchant's time zone. The format is ISO 8601.
EventTimeStamp DateTime The date and time of the event. The format is ISO 8601. For more information, see Dynamics 365 Fraud Protection API.
LabelObjectType String This field indicates the type of label: Purchase, Signup, Custom Fraud Evaluation, Account, Payment instrument, or Email.
LabelObjectId String This is an identifier field for the type of object: PurchaseId, SignupId, UserId, MerchantPaymentInstrumentId, or Email.
LabelSource String This field represents the source of the label.
LabelState String This field indicates the current status of the label. For more information, see Dynamics 365 Fraud Protection API.
LabelReasonCodes String This field indicates the reason codes associated with each type of label. For more information, see Dynamics 365 Fraud Protection API.
Processor String The name of the bank or payment processor. For more information, see Dynamics 365 Fraud Protection API.
EffectiveStartDate DateTime The date from which this label is effective. The format is ISO 8601.
EffectiveEndDate DateTime The end date for this label. The format is ISO 8601.
Amount Double The amount that was charged to the customer. This information is provided by the merchant.
Currency String The currency of the original purchase as a three-character currency code. (For example: USD, which is aligned with the OANDA currency code). This information is provided by the merchant.

Vertical-specific attributes

Attribute Vertical Type Description
TravelOverview
CarRentalIncluded Travel Boolean A True/False value indicating whether a car rental is included.
LodgingIncluded Travel Boolean A True/False value indicating whether lodging is included.
TravelType Travel String The travel category or type.
IsRoundTrip Travel Boolean A True/False value indicating whether the travel is round trip.
IsDiscountOffered Travel Boolean A True/False value indicating whether a discount was offered.
TravelDateTime Travel DateTimeOffset The travel start date and time.
ReturnDateTime Travel DateTimeOffset The travel end or return date and time.
FromCity Travel String The city where the customer is travelling from.
FromState Travel String The state where the customer is travelling from.
FromCountryISO Travel String The ISO country where the customer is travelling from.
FromZipCode Travel String The zip code where the customer is travelling from.
ToCity Travel String The city where the customer is travelling to.
ToState Travel String The state where the customer is travelling to.
ToCountryISO Travel String The ISO country where the customer is travelling to.
ToZipCode Travel String The zip code where the customer is travelling to.
TravelDuration Travel String Deprecated. Do not use.
IsPackagedTour Travel Boolean A True/False value indicating whether this was a packaged tour.
BookingType Travel String The booking type.
WebUrl Travel String The URL where the travel was booked.
IssueDateTime Travel DateTimeOffset The date and time when the tickets were issued.
FlightDetails Travel Object Refer to FlightDetails section.
LodgingDetails Travel Object Refer to LodgingDetails section.
CarRentalDetails Travel Object Refer to CarRentalDetails section.
TravelAgent Travel Object Refer to TravelAgent section.
FlightDetails
TicketNumber Travel String The unique ticket number.
PlaceOfIssue Travel String The location where the ticket was issued.
IsRestrictedTicket Travel Boolean A True/False value indicating whether the ticket is restricted.
RewardsOrVoucherApplied Travel Boolean A True/False value indicating whether rewards or vouchers were applied to the order.
TotalRewardsApplied Travel int32 The total rewards which were applied to the order.
TotalFees Travel decimal The total fees applied to the order.
PassengerCount Travel Int32 The total number of passengers.
NumberOfStops Travel Int32 The number of stops or layovers for the flight.
PurchaserProfileType Travel String The customer's profile or membership type.
IsThirdParty Travel Boolean A True/False value indicating whether the order was placed through a third party site.
IsPurchaserFrequentFlyer Travel Boolean A True/False value indicating whether the customer is a frequent flyer.
FlightSegments Travel Object Refer to FlightSegments section.
Passengers Travel Object Refer to Passengers section.
FlightSegments
AirlineCode Travel String The airline code.
AirlineName Travel String The airline name.
SegmentSequence Travel Int32 The sequence number of the given flight leg (e.g. 2 for the second leg of the flight)
TravelClass Travel String The seat class or cabin.
OperatedBy Travel String The organization operating the flight.
FlightNumber Travel String The flight number.
FromAirportCode Travel String The airport code where the flight is flying from.
ToAirportCode Travel String The airport code where the flight is flying to.
DepartureDateTime Travel DateTimeOffset The departure date and time.
ArrivalDateTime Travel DateTimeOffset The arrival date and time.
FromAirportCity Travel String The airport city where the customer is travelling from.
FromAirportState Travel String The  airport state where the customer is travelling from.
FromAirportZipcode Travel String The airport zip code where the customer is travelling from.
FromAirportCountryISO Travel String The airport ISO country code where the customer is travelling from.
ToAirportCity Travel String The airport city where the customer is travelling to.
ToAirportState Travel String The airport state where the customer is travelling to.
ToAirportZipcode Travel String The airport zip code where the customer is travelling to.
ToAirportCountryISO Travel String The airport ISO country where the customer is travelling to.
Passengers
FirstName Travel String The passenger first name.
LastName Travel String The passenger last name.
CarRentalDetails
PickupLocation Travel String The car rental pickup location.
PickupDateTime Travel DateTimeOffset The car rental pickup date and time.
DropOffLocation Travel String The car rental drop-off location.
DropOffDateTime Travel DateTimeOffset The car rental drop-off date and time
DiscountProgram Travel String The discount program applied to the car rental order.
CarType Travel String The car type or category.
IsPrepaid Travel Boolean A True/False value indicating whether the car rental was prepaid.
InsuranceIncluded Travel Boolean A True/False value indicating whether insurance was included.
ContactEmail Travel String The car renter's email address.
ContactPhoneNumber Travel String The car renter's phone number.
PickupAddress Travel Object Refer to Address section.
DropOffAddress Travel Object Refer to Address section.
TravelAgent
AgencyCode Travel String The travel agency code.
AgencyName Travel String The travel agency name.
AgentCode Travel String The travel agent code.
AgencyLocation Travel Object Refer to AgentAddress section.
AgentAddress
Street1 Travel String The first row that was provided for the address
Street2 Travel String The second row that was provided for the address. (This value can be blank.)
Street3 Travel String The third row that was provided for the address. (This value can be blank.)
City Travel String The city that was provided for the address.
State Travel String The state or province that was provided for the address.
District Travel String The district that was provided for the address.
ZipCode Travel String The postal code that was provided for the address.
Country Travel String The country/region code that was provided for the address. The value should be a two-letter ISO country/region code (for example, US).
AgencyContactPhone Travel String The agency contact phone number.
AgencyContactEmail Travel String The agency contact email address.
LodgingDetails
FolioNumber Lodging String The unique identifier of the lodging property.
CheckInDate Lodging DateTimeOffset The check-in date for the lodging stay.
CheckOutDate Lodging DateTimeOffset The check-out date for the lodging stay.
ReservationConfirmed Lodging Boolean A True/False value indicating whether the reservation has been confirmed.
MembershipDetails Lodging String Additional details on the customer's membership status.
DiscountProgram Lodging String The discount program applied to the lodging order.
AdultCount Lodging Int32 The number of adults included in the stay.
KidCount Lodging Int32 The number of kids included in the stay.
NightsCount Lodging Int32 The number of nights included in the stay.
RoomCount Lodging Int32 The number of rooms included in the stay.
BedType Lodging String The bed type or category.
RoomType Lodging String The room type or category.
PaymentDescription Lodging String Additional details on the lodging payment.
Facility Lodging Object Refer to Facility section.
Facility
Name Lodging String The facility name.
Type Lodging String The facility type.
ContactPhoneNumber Lodging String The phone number used to contact the facility.
ContactEmail Lodging String The email address used to contact the facility.
DailyRoomRate Lodging decimal The daily room rate for the facility.
Currency Lodging String The currency supported by the facility.
DailyRoomTaxAmount Lodging decimal The daily room tax amount charged by the facility.
Address Lodging Object Refer to Address section.
Address
Street1 Car Rental String The first row that was provided for the address
Street2 Car Rental String The second row that was provided for the address. (This value can be blank.)
Street3 Car Rental String The third row that was provided for the address. (This value can be blank.)
City Car Rental String The city that was provided for the address.
State Car Rental String The state or province that was provided for the address.
District Car Rental String The district that was provided for the address.
ZipCode Car Rental String The postal code that was provided for the address.
Country Car Rental String The country/region code that was provided for the address. The value should be a two-letter ISO country/region code (for example, US).
CloudBusiness
OrganizationId CloudBusiness String The unique identifier for the cloud service or organization.
CompanyName CloudBusiness String The cloud service name.
CompanyType CloudBusiness String The cloud company type.
CompanySize CloudBusiness Int32 The cloud company size.
EntityId CloudBusiness String The unique identifier for the legal entity under the organization.
PrimaryContactFirstName CloudBusiness String The first name of the primary contact for the business.
PrimaryContactLastName CloudBusiness String The last name of the primary contact for the business.
PrimaryContactEmail CloudBusiness String The email address of the primary contact for the business.
PrimaryContactPhoneNumber CloudBusiness String The phone number of the primary contact for the business.
SubscriptionCount CloudBusiness Int32 The total number of subscriptions available.
CompanyAddress CloudBusiness Object Refer to Address section.

Download sample data

You can download our sample data files to explore options before using your own internal data.

Custom data sample

The following sample shows how to use purchase APIs with a custom data object in Fraud Protection.

{ 
"CustomData": { 
"EngagementDuration": 120.4, 
"GamerScore": 10, 
"InApp": true, 
"MiscSampleA": "abc" 
} 
}