Dynamics 365 Fraud Protection (Preview)

Microsoft Dynamics 365 Fraud Protection provides merchants the capability to obtain risk assessment on fraudulent activity associated with e-commerce purchases, fraudulent account sign up and sign in attempts in their online store

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL https://dynamics.microsoft.com/ai/fraud-protection/
Email dfpconnector@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://docs.microsoft.com/fraud-protection-rest/api/fraud-protection-rest/
Privacy policy https://docs.microsoft.com/dynamics365/fraud-protection/data-processing-protection/
Categories AI

Microsoft Dynamics 365 Fraud Protection connector provides merchants the capability to obtain risk assessment on fraudulent activity associated with e-commerce purchases, fraudulent account sign up and sign in attempts in their online store.

Prerequisites

To use this connector, user should already have a provisioned tenant on Dynamics 365 Fraud Protection, and should already have a account on Power App Platform.

How to get credentials

Steps on how to get credentials is documented here: https://github.com/microsoft/Dynamics-365-Fraud-Protection-Samples/tree/master/power%20apps%20connector

Get started with your connector

For more information about how to get started, see Dynamics 365 Fraud Protection Samples.

Known issues and limitations

For more information, see Dynamics 365 Fraud Protection Samples.

Common errors and remedies

When using the connector to call into Dynamics 365 Fraud Protection, some common issue may occur:

  • 401 Unauthorized: Access token is invalid, check the credentials put in.
  • 403 Forbidden: Authorization failed, check the credentials entered.
  • 400 Bad Request: Some required fields in the payload are missing or in bad format, check the detailed error message.
  • 500 Internal Server Error: Exception happened on server side, note down the correlation ID and contact the DFP team regarding such error.

FAQ

For more information, see Dynamics 365 Fraud Protection Samples.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Provides risk assessment for account creation attempt

This event sends information and context about an incoming new Account Creation attempt. The response contains a decision for the Account Creation

Provides risk assessment for account login attempt

This event sends information and context about an incoming new Account Login attempt. The response contains a decision for the Account Login

Provides risk assessment for custom events

This event allows you to send a structure of their own choosing, triggered by conditions of their own choosing for rule-evaluation. The response contains a decision for the event

Provides risk assessment for online purchase transaction

This event sends information and context about an incoming new purchase transaction. The response contains a decision to either approve or reject the purchase transaction and the appropriate Merchant ID (MID) the merchant should send in the authorization call to their bank

Updates account information for account protection

This event updates or creates user account information for account protection service, for example, Add Payment Instrument, Add Address, or any other user attribute. This is a data ingestion event only

Updates account information for purchase protection

This event updates or creates user account information for purchase protection service, for example, Add Payment Instrument, Add Address, or any other user attribute. This is a data ingestion event only

Updates bank authorization information

This event conveys if a purchase transaction sent to the bank was approved or rejected for bank authorization or bank charge/settlement. This is a data ingestion event only

Updates confirmed fraud information

This event sends information about a previous purchase that the customer disputed with their bank as fraud. This is a data ingestion event only. Many merchants send these events using bulk data upload

Updates fraud label information for account protection

This event sends an update of the label. This is a data ingestion event only

Updates fraud label information for purchase protection

This event sends an update of the label. This is a data ingestion event only

Updates refund information

This event sends information about a previous purchase transaction being refunded. This is a data ingestion event only. Many merchants send these events using bulk data upload

Updates status of a online purchase transaction

This event sends an update of the status of a purchase, for example, if the purchase has been canceled. This is a data ingestion event only

Updates the status of account creation

This event sends an update of the status of an Account Creation, for example, if the Account Creation has been canceled. This is a data ingestion event only

Updates the status of account login

This event sends an update of the status of an Account Login, for example, if the Account login has been canceled. This is a data ingestion event only

Provides risk assessment for account creation attempt

This event sends information and context about an incoming new Account Creation attempt. The response contains a decision for the Account Creation

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

content type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.AccountCreation'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The identifier of the Account Creation event.

signUpId
signUpId True string

The identifier of the Account Creation event. Can match trackingId.

assessmentType
assessmentType string

Indicates the assessment type for the event. Possible values are 'Evaluate' | 'Protect'. If not specified, the default is 'Protect'.

customerLocalDate
customerLocalDate True date-time

The creation date of the Account Creation event, in the customer's local time zone. The format is ISO 8601.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

deviceContextId
deviceContextId True string

The customer's device ID, as provided and mastered by DFP Device Fingerprinting Service.

ipAddress
ipAddress string

The customer's IP address.

provider
provider string

The provider of device info. Possible values are 'DFPFingerprinting'|'Merchant'|'Unknown'. If not specified, the default is 'DFPFingerprinting'.

externalDeviceId
externalDeviceId string

The customer's device ID, as provided and mastered by the merchant.

externalDeviceType
externalDeviceType string

The customer's device type, as provided and mastered by the merchant. Possible values are 'Mobile' , 'Computer' , 'MerchantHardware' , 'Tablet' , 'GameConsole'.

userId
userId string

The user identifier. This information is provided by the merchant.

userType
userType string

The user's profile type. Possible values are 'Consumer'|'Developer'|'Seller'|'Publisher'|'Tenant'.

username
username True string

The user-provided user name.

firstName
firstName string

The user-provided first name on the account.

lastName
lastName string

The user-provided last name on the account.

countryRegion
countryRegion string

The user's CountryRegion. The value should be a two-letter ISO CountryRegion code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

membershipId
membershipId string

The membership ID, if the user already has an existing membership with the merchant.

isMembershipIdUsername
isMembershipIdUsername boolean

membershipId can be used as user name, defaults to False.

phoneType
phoneType True string

The values are: 'Primary'|'Alternative', default to 'Primary'.

phoneNumber
phoneNumber True string

The user'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).

isPhoneNumberValidated
isPhoneNumberValidated boolean

A True/False value that indicates whether the user-provided phone number has been verified as owned by the user.

phoneNumberValidatedDate
phoneNumberValidatedDate date-time

The validation date of the user phone number. The format is ISO 8601.

isPhoneUsername
isPhoneUsername boolean

The phone number can be used as user name, defaults to False.

emailType
emailType True string

The values are:'Primary', 'Alternative'

emailValue
emailValue True string

The user's email address. This value is case-insensitive.

isEmailValidated
isEmailValidated boolean

A True/False value that indicates whether the user-provided email address has been verified as owned by the user.

emailValidatedDate
emailValidatedDate date-time

The validation date of the user email. The format is ISO 8601.

isEmailUsername
isEmailUsername boolean

The email can be used as user name, defaults to False.

authenticationProvider
authenticationProvider True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

displayName
displayName True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

addressType
addressType True string

Address Type. The values are:'Primary'|'Billing'|'Shipping'|'Alternative'. defaults to 'Primary'.

firstName
firstName string

The user-provided first name associated with the address.

lastName
lastName string

The user-provided last name associated with the address.

phoneNumber
phoneNumber string

The user-provided phone number associated with the address.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

countryRegion
countryRegion string

The Country/Region code that was provided for the address. The value should be a two-letter ISO CountryRegion code (for example, US).

merchantPaymentInstrumentId
merchantPaymentInstrumentId True string

The identifier of the payment instrument. This information is provided by the merchant.

type
type True string

The type of payment. Possible values are: 'Other'|'CreditCard'|'DirectDebit'|'PayPal'|'MobileBilling'|'OnlineBankTransfer' |'Invoice' |'MerchantGiftCard'|'MerchantWallet'|'CashOnDelivery'|'Paytm'|'CCAvenue'.

creationDate
creationDate date-time

The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.

updateDate
updateDate date-time

The date of the last update for the payment instrument in the merchant's system. Should not be older than creationDate. The format is ISO 8601.

state
state string

The current state of the PI in merchant's system. Possible values are: 'Active'|'Blocked'|'Expired'

cardType
cardType string

This attribute is used only for payments of the Credit/Debit Card type. Possible values are: 'Visa'|'Mastercard'|'Amex'|'ACH'|'SEPA'|'UnionPay'|'Inicis'|'MobileBillingCarrier'|'Discover'|'AllPay'|'JCB' |'DiscoverDiners'.

holderName
holderName string

The name of the payment instrument's user. This attribute is used only for payments of the Credit/Debit Card type.

bin
bin string

The Credit/Debit card bin. This attribute is used only for payments of the Credit/Debit Card type.

expirationDate
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 Credit/Debit Card type.

lastFourDigits
lastFourDigits string

The last four digits of the Credit/Debit card. This attribute is used only for payments of the Credit/Debit Card type.

addressType
addressType True string

Address Type. The values are:'Primary'|'Billing'|'Shipping'|'Alternative'. defaults to 'Primary'.

firstName
firstName string

The user-provided first name associated with the address.

lastName
lastName string

The user-provided last name associated with the address.

phoneNumber
phoneNumber string

The user-provided phone number associated with the address.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

countryRegion
countryRegion string

The Country/Region code that was provided for the address. The value should be a two-letter ISO CountryRegion code (for example, US).

email
email string

The email address associated with the payment instrument. This attribute is used only for payments of the Paypal type.

billingAgreementId
billingAgreementId string

This attribute is used only for payments of the Paypal type.

payerId
payerId string

This attribute is used only for payments of the Paypal type.

payerStatus
payerStatus string

A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type.

addressStatus
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
imei string

This attribute is used only for payments of the Mobilepayment type.

campaignType
campaignType string

The marketing campaign type. Possible values are 'Direct', 'Email' , 'Referral' , 'PaidSearch', 'OrganicSearch', 'Advertising', 'SocialNetwork' , 'General Marketing', 'Unknown', 'Other'.

trafficSourceReferrer
trafficSourceReferrer string

The source of this user if known. If via existing user referral, provide the original MerchantUserId of the referrer.

trafficSourceReferralLink
trafficSourceReferralLink uri

The source of this user if known. If via other campaign types instead of existing user referral, provide the source URL link.

trafficSourceReferralSite
trafficSourceReferralSite string

The source site of the traffic. Possible values are 'Facebook', 'Instagram', 'Twitter', 'Bing', 'Google', 'Pinterest', 'WhatsApp', etc.

incentiveType
incentiveType string

The incentive type for the new user. Possible values are 'None' , 'CashBack' , 'Discount' , 'FreeTrial' , 'BonusPoints' , 'Gift' , 'Unknown', 'Other'.

incentiveOffer
incentiveOffer string

The exact incentive offer name. Examples: $5 off on first order, free shipping, 5000 points.

campaignStartDate
campaignStartDate date-time

The date of the campaign starting on the incentive collection.

campaignEndDate
campaignEndDate date-time

The date of the campaign expiration on the incentive collection.

incentiveQuantitiyLimit
incentiveQuantitiyLimit string

The incentive quantity limit set by merchant. i.e., max on three 5000 points per user per day.

Returns

Response Object for Dynamics Fraud Protection AccountCreate API

Provides risk assessment for account login attempt

This event sends information and context about an incoming new Account Login attempt. The response contains a decision for the Account Login

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

content type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.AccountLogin'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The identifier of the Login event.

loginId
loginId True string

The identifier of the Login event. Can match trackingId.

assessmentType
assessmentType string

Indicates the assessment type for the event. Possible values are 'Evaluate' | 'Protect'. If not specified, the default is 'Protect'.

customerLocalDate
customerLocalDate True date-time

The login date of the Account Login event, in the customer's local time zone. The format is ISO 8601.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

deviceContextId
deviceContextId True string

The customer's device ID, as provided and mastered by DFP Device Fingerprinting Service.

ipAddress
ipAddress string

The customer's IP address.

provider
provider string

The provider of device info. Possible values are 'DFPFingerprinting'|'Merchant'|'Unknown'. If not specified, the default is 'DFPFingerprinting'.

externalDeviceId
externalDeviceId string

The customer's device ID, as provided and mastered by the merchant.

externalDeviceType
externalDeviceType string

The customer's device type, as provided and mastered by the merchant. Possible values are 'Mobile' , 'Computer' , 'MerchantHardware' , 'Tablet' , 'GameConsole'.

userId
userId True string

The user identifier. This information is provided by the merchant.

userType
userType string

The user's profile type. Possible values are 'Consumer'|'Developer'|'Seller'|'Publisher'|'Tenant'.

username
username True string

The user-provided user name.

authenticationProvider
authenticationProvider True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

displayName
displayName True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

lastPhoneNumberUpdateDate
lastPhoneNumberUpdateDate date-time

Most recent update or create date/time of any phone number.

lastEmailUpdateDate
lastEmailUpdateDate date-time

Most recent update or create date/time of any email.

lastAddressUpdateDate
lastAddressUpdateDate date-time

Most recent update or create date/time of any address.

lastPaymentInstrumentUpdateDate
lastPaymentInstrumentUpdateDate date-time

Most recent update or create date/time of any PaymentInstrument.

campaignType
campaignType string

The marketing campaign type. Possible values are 'Direct', 'Email' , 'Referral' , 'PaidSearch', 'OrganicSearch', 'Advertising', 'SocialNetwork' , 'General Marketing', 'Unknown', 'Other'.

trafficSourceReferrer
trafficSourceReferrer string

The source of this user if known. If via existing user referral, provide the original MerchantUserId of the referrer.

trafficSourceReferralLink
trafficSourceReferralLink uri

The source of this user if known. If via other campaign types instead of existing user referral, provide the source URL link.

trafficSourceReferralSite
trafficSourceReferralSite string

The source site of the traffic. Possible values are 'Facebook', 'Instagram', 'Twitter', 'Bing', 'Google', 'Pinterest', 'WhatsApp', etc.

incentiveType
incentiveType string

The incentive type for the new user. Possible values are 'None' , 'CashBack' , 'Discount' , 'FreeTrial' , 'BonusPoints' , 'Gift' , 'Unknown', 'Other'.

incentiveOffer
incentiveOffer string

The exact incentive offer name. Examples: $5 off on first order, free shipping, 5000 points.

campaignStartDate
campaignStartDate date-time

The date of the campaign starting on the incentive collection.

campaignEndDate
campaignEndDate date-time

The date of the campaign expiration on the incentive collection.

incentiveQuantitiyLimit
incentiveQuantitiyLimit string

The incentive quantity limit set by merchant. i.e., max on three 5000 points per user per day.

Returns

Response Object for Dynamics Fraud Protection APIs

Provides risk assessment for custom events

This event allows you to send a structure of their own choosing, triggered by conditions of their own choosing for rule-evaluation. The response contains a decision for the event

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Assessment Api Name
assessment-api-name True string

api name of assessment

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The assessment event name. The name should match the API name during assessment creation and the `{assessment-API-name} of the URL.

version
version True string

The payload version. Should be "1.0"

trackingId
trackingId True string

The identifier of the Account Creation event.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

userId
userId string

The user identifier. This information is provided by the merchant.

countryRegion
countryRegion string

The user's CountryRegion. The value should be a two-letter ISO CountryRegion code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

sampleString
sampleString string

This is an example of how the User type can be extended.

isEmployee
isEmployee boolean

Example on primitive type.

amount
amount integer

Example field.

available
available integer

Example field.

Returns

Response Object for Dynamics Fraud Protection APIs

Provides risk assessment for online purchase transaction

This event sends information and context about an incoming new purchase transaction. The response contains a decision to either approve or reject the purchase transaction and the appropriate Merchant ID (MID) the merchant should send in the authorization call to their bank

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

purchaseId
purchaseId True string

Transaction (or purchase/order) identifier in merchant system.

assessmentType
assessmentType string

Indicates the assessment type for the event. Possible values are 'Evaluate' or 'Protect'. If not specified, default is 'Protect'

originalOrderId
originalOrderId string

Original Order identifier in merchant system for payments for recurring billing like monthly subscriptions.

customerLocalDate
customerLocalDate date-time

Purchase creation date as per customer local time-zone. Format is ISO8601

merchantLocalDate
merchantLocalDate True date-time

Purchase creation date as per Merchant time-zone. Format is ISO8601

merchantIdentifier
merchantIdentifier string

Merchant identifier (MID) for the bank

merchantCategoryCode
merchantCategoryCode string

Merchant Category Code (MCC) for the bank

merchantBusinessType
merchantBusinessType string

Merchant Business Type for this purchase

merchantBusinessSegment
merchantBusinessSegment string

Merchant Business Segment for this purchase

isTest
isTest boolean

Signifies that the purchase is a test purchase

isFreeProductIncluded
isFreeProductIncluded boolean

Signifies if a free product is part of this purchase

isRecurringCharge
isRecurringCharge boolean

Signifies if the purchase is a recurring charge

isGuestCheckout
isGuestCheckout boolean

Signifies if the purchase is being made via gueest checkout

isPostAuthCheck
isPostAuthCheck boolean

Signifies if the purchase is being sent to DFP post Bank Auth

isRetryOrder
isRetryOrder boolean

Signifies if the purchase is a retry of a previously failed attempt

recurringChargeFrequencyInDays
recurringChargeFrequencyInDays integer

Number of days after which the charge recurs

recurringChargeStartDate
recurringChargeStartDate date-time

Start date for this purchase, if recurring

recurringChargeEndDate
recurringChargeEndDate date-time

End date for this purchase, if recurring

isPostpaid
isPostpaid boolean

Signifies if the purchase is post paid

distinctItemCount
distinctItemCount double

Count of unique products sold as part of the purchase

totalItemCount
totalItemCount double

Total count of products sold as part of the purchase

orderType
orderType string

Type of order, for example, Take Out

discountAmount
discountAmount double

Discount provided on the original purchase before deriving the total amount

tipAmount
tipAmount double

Tip provided on the purchase

totalAmount
totalAmount double

Total amount charged to the customer; tax and shipping included. Discounts and coupons can be optionally included; there is currently no separate field for them. Provided by the Merchant.

salesTax
salesTax double

Sales tax charged for the transaction. Provided by the Merchant.

currency
currency string

Currency of the original purchase in ISO 4217 code format (USD, GBP, etc).

shippingMethod
shippingMethod string

Indicates the method used to ship the purchase. Possible values 'InStorePickup' | 'Standard' | 'Express' | 'DirectEntitlement' | 'DigitalToken'

transactionProcessingOrder
transactionProcessingOrder string

The order in which the fraud assessment was made during the transaction flow. Possible values are PREAUTHORIZATION, POSTAUTHORIZATION, BEFORE3DS, AFTER3DS

recurringSubscriptionId
recurringSubscriptionId string

The unique ID for the recurring charge

recurringChargeSequence
recurringChargeSequence string

The nth (1, 2, 3...) time the recurring charge has occurred for this customer.

midName
midName string

The merchant name associated with the MID (merchant identifier).

transactionDescription
transactionDescription string

The transaction processing type. Possilbe values are SUBSCRIPTIONFEE, DELAYEDCHARGES, NOSHOW, DEPOSIT

shippingEmail
shippingEmail string

The user's shipping email address

shippingDate
shippingDate date-time

The date that the order was shipped

orderInitiatedChannel
orderInitiatedChannel string

The channel where the transaction was created (for example: 'AppStore', 'Web', 'MobileWeb', 'App', 'InGamePurchase')

orderInitiatedChannelName
orderInitiatedChannelName string

The App Name or Web URL where the transaction was created

orderInitiatedChannelRegionORCountry
orderInitiatedChannelRegionORCountry string

The market where the transaction was created (for example: App market)

merchantBusinessSegmentL2
merchantBusinessSegmentL2 string

The second level business or industry segment

lastUpdateYear
lastUpdateYear integer

Year when the item was updated the last time

userId
userId True string

The user identifier. This information is provided by the merchant.

creationDate
creationDate date-time

The creation date of the user account. The format is ISO 8601.

updateDate
updateDate date-time

The date when user data was last changed. The format is ISO 8601.

firstName
firstName string

The user-provided first name on the account.

lastName
lastName string

The user-provided last name on the account.

country
country string

The user's country or region. The value should be a two-letter ISO country/region code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

phoneNumber
phoneNumber string

The user'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
email string

The user's email address. This value is case-insensitive.

membershipId
membershipId string

The membership ID, if the user already has an existing membership with the merchant.

profileType
profileType string

The user's profile type. Possible values 'Consumer' | 'Seller' | 'Publisher' | 'Tenant' | 'Developer'

profileName
profileName string

The profile name, depending on profileType.

authenticationProvider
authenticationProvider string

The user's authentication provider, if different from the merchant's. Possible valuse 'MSA' | 'Facebook' | 'PSN' | 'MerchantAuth' | 'Google'

authenticationMethod
authenticationMethod string

The way in which the customer was authenticated prior/during purchase. Some possible values are PASSWORD-BASED, MULTI-FACTOR, BIOMETRIC, TOKEN-BASED,

displayName
displayName string

The user's display name. Example: Xbox gamertag value

isEmailValidated
isEmailValidated boolean

A True/False value that indicates whether the user-provided email address has been verified as owned by the user.

emailValidatedDate
emailValidatedDate date-time

The validation date of the user email. The format is ISO 8601.

isPhoneNumberValidated
isPhoneNumberValidated boolean

A True/False value that indicates whether the user-provided phone number has been verified as owned by the user.

phoneNumberValidatedDate
phoneNumberValidatedDate date-time

The validation date of the user phone number. The format is ISO 8601.

membershipType
membershipType string

The customer's membership status or type. Different levels in paid can be specified such as Premium, Executive. Possible values are FREE, PAID, PREMIUM

loginInputMethod
loginInputMethod string

The way in which the customer input their credentials. Possible values are MANUALINPUT, AUTOFILL, SCRIPT, COPYPASTE, SELECTPROFILE

lastPasswordUpdatedDate
lastPasswordUpdatedDate date-time

When the customer's password was last updated.

firstPurchaseDate
firstPurchaseDate date-time

When the customer made their first purchase

loginChallengeType
loginChallengeType string

The type of challenge-response test that was initiated. Possible valuees are TEXT SMS, PHONE SMS, EMAIL PIN, CAPTCHA

deviceContextId
deviceContextId True string

The customer's fingerprinting session ID, or the event ID if the session is not available.

provider
provider string

The provider of device info. Possible values are 'DFPFingerPrinting' | 'Merchant'. If using the DFP Fingerprinting JS script, you must pass 'DFPFingerPrinting' for all data to get properly connected.

deviceContextDC
deviceContextDC string

DEPRECATED: No longer needed for DFP Fingerprinting. The datacenter storing the customer's DFP Fingerprinting session (provided by the DFP Fingerprinting JS script).

externalDeviceId
externalDeviceId string

The customer's device ID, as provided and mastered by the merchant.

externalDeviceType
externalDeviceType string

The customer's device type, as provided and mastered by the merchant. Possible values 'Mobile' | 'Computer' | 'MerchantHardware' | 'Tablet' | 'GameConsole'

ipAddress
ipAddress string

Customer's IP address (provided by Merchant)

httpSignature
httpSignature string

The digital signature of the HTTP message.

httpUserAgent
httpUserAgent string

The request header used to identify the application, operating system, vendor, and/or version.

browserHeader
browserHeader string

The full list of request headers sent by the browser.

browserResolution
browserResolution string

The browser resolution.

browserLanguage
browserLanguage string

The browser default language preference.

tcpSignature
tcpSignature string

The TCP application signature.

sslSignature
sslSignature string

The SSL signature.

enabledCookies
enabledCookies boolean

A True/False value that indicates whether cookies are enabled.

enabledFlash
enabledFlash boolean

A True/False value that indicates whether Flash is enabled.

enabledJavaScript
enabledJavaScript boolean

A True/False value that indicates whether javascript is enabled.

screenAspectRatio
screenAspectRatio string

The aspect ratio of the browser.

screenColorDepth
screenColorDepth string

The color depth of the screen.

screenResolution
screenResolution string

Resolution of device screen in pixels

siteHostName
siteHostName string

The site's hostname.

os
os string

The device operating system.

oSFonts
oSFonts string

The operating system's default font.

deviceProcessor
deviceProcessor string

The device processor.

sessionId
sessionId string

The unique session ID.

trueIp
trueIp string

True IP address of device identified by device fingerprinting

proxyIp
proxyIp string

IP address of proxy device.

deviceId
deviceId string

Unique GUID per device generated by device fingerprinting

timeZone
timeZone string

Offset of the local time zone, in hours, with respect to GMT

userAgentDetails
userAgentDetails string

Additional user agent or browser details.

appVersion
appVersion string

Application version.

browserPackagesList
browserPackagesList string

List of packages installed on the device.

buildManufacturer
buildManufacturer string

Manufacturer of the device.

buildModel
buildModel string

End-user visibile name for the end product.

buildSdkVersion
buildSdkVersion string

Build version.

dataNetworkType
dataNetworkType string

Type of mobile data network.

deviceModelName
deviceModelName string

Device model.

deviceSystemName
deviceSystemName string

Device name of the machine.

deviceSystemVersion
deviceSystemVersion string

Device version.

isBluetoothEnabled
isBluetoothEnabled boolean

A True/False value that indicates whether bluetooth has been enabled.

simNetworkCountryISO
simNetworkCountryISO string

ISO country code for the mobile service provider.

simNetworkType
simNetworkType string

Mobile network type.

systemUpTime
systemUpTime string

The duration of time that the device has been working and available.

merchantPaymentInstrumentId
merchantPaymentInstrumentId string

The identifier of the payment instrument. This information is provided by the merchant.

paymentMethod
paymentMethod string

The top-level payment method category. Possible values are CARD, CASH, DIRECTDEBIT, E-WALLET, MOBILE, E-BANKING, INVOICE, VOUCHERS

type
type True string

The type of payment. Possible values 'CreditCard' | 'DirectDebit' | 'PayPal' | 'MobileBilling' | 'OnlineBankTransfer' | 'Invoice' | 'MerchantGiftCard' | 'MerchantWallet' | 'CashOnDelivery' | 'Paytm' | 'CCAvenue'

creationDate
creationDate date-time

The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.

updateDate
updateDate date-time

The date of the last update for the payment instrument in the merchant's system. The format is ISO 8601.

paymentCheckoutProvider
paymentCheckoutProvider string

The eWallet checkout provider.

isLowLiabilityPIType
isLowLiabilityPIType boolean

A True/False value indicating whether the payment method is a low liability.

state
state string

The current state of the PI in merchant's system. Possible values 'Active' | 'Inactive'

cardType
cardType string

This attribute is used only for payments of the Credit/Debit Card type. The network the card is provided from. Possible values 'Visa' | 'Mastercard' | 'Amex' | 'ACH' | 'SEPA' | 'UnionPay' | 'Inicis' | 'MobileBillingCarrier' | 'Discover' | 'AllPay' | 'JCB' | 'DiscoverDiners'

holderName
holderName string

The name of the payment instrument's user. This attribute is used only for payments of the Credit/Debit Card type.

holderCompanyName
holderCompanyName string

Name of the organization providing the business or company card (for business purchases only).

settlementApprovalRequired
settlementApprovalRequired boolean

A True/False value inidcating whether or not approval was required for a SEPA transaction.

bin
bin string

This attribute is used only for payments of the Credit/Debit Card type.

binName
binName string

The BIN display name.

binCountryISO
binCountryISO string

The ISO country code associated with the BIN.

binCardType
binCardType string

The BIN card type. Possible values are DEBIT, CREDIT, PREPAID, FLEET, CREDITDEBIT

binCardAssociation
binCardAssociation string

The BIN card association. Some possible values are VISA, MASTERCARD, AMEX, DISCOVER, MAESTRO, JCB, UNIONPAY, DINERSCLUB

binBankGroup
binBankGroup string

The BIN bank group.

expirationDate
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 Credit/Debit Card type.

lastFourDigits
lastFourDigits string

This attribute is used only for payments of the Credit/Debit Card type.

email
email string

The email address associated with the payment instrument. This attribute is used only for payments of the Paypal type.

billingAgreementId
billingAgreementId string

This attribute is used only for payments of the Paypal type.

payerId
payerId string

This attribute is used only for payments of the Paypal type.

payerStatus
payerStatus string

A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type. Possible values 'Verified' | 'Unverified'

addressStatus
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. Possible values 'Confirmed' | 'Unconfirmed'

imei
imei string

This attribute is used only for payments of the Mobilepayment type.

currency
currency string

Currency code for the selected payment instrument.

isInternationalMoneyTransfer
isInternationalMoneyTransfer boolean

A True/False value indicating whether an international money transfer occurred.

bankIdentifierCode
bankIdentifierCode string

Bank Identifier Code (BIC or SWIFT code)

bankName
bankName string

The bank name

bankZipCode
bankZipCode string

The bank zip code

bankState
bankState string

The bank state

bankCountryISO
bankCountryISO string

The bank ISO country

paymentCollectionDate
paymentCollectionDate date-time

The estimated date for payment collection (primarily used for payment service providers).

instantPaymentSettlement
instantPaymentSettlement boolean

A True/False value indicating bank redirects (used to support CSV payments).

autoCaptureEnabled
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
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
authorizationType string

The authorization type. Mastercard and Visa now require merchants to define authorization attempts as either a pre-authorization or a final-authorization. Possible values are PRE_AUTHORIZATION, FINAL_AUTHORIZATION

authorizationResultCode
authorizationResultCode string

Bank response from the authorization decision. Possible values are APPROVE, DECLINE, PENDING

authorizationResultText
authorizationResultText string

Reasons for the authorization decision; especially for declined or pending transactions. Possible values are MISMATCH_CVV, MISMATCH_ADDRESS, MISMATCH_EXPIRATIONDATE, NOACCOUNT, INVALIDPIN, LOWFUND, OVERLIMIT SUSPICIOUSACCOUNT

acquirerId
acquirerId string

Acquiring institution identification code.

acquirerCountryISO
acquirerCountryISO string

Acquiring institution country code

cvvVerify
cvvVerify string

Indicates whether CVV verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

avsVerify
avsVerify string

Indicates whether addres verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

cavVerify
cavVerify string

Indicates whether cardholder authentication verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

piInputMethod
piInputMethod string

N/A

encryptedCreditCardNumber
encryptedCreditCardNumber string

The hashed or encrypted credit card number.

purchaseAmount
purchaseAmount double

Total purchase amount using this PI for the transaction

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

firstName
firstName string

First Name provided with the address

lastName
lastName string

Last Name provided with the address

phoneNumber
phoneNumber string

Phone Number provided with the address

organizationId
organizationId True string

The unique identifier for the merchant or organization.

name
name True string

The name of the organization

zipCode
zipCode string

The zipcode at where the organization is located

state
state string

The state at where the organization is located

countryISO
countryISO string

The countryISO at where the organization is located

organizationId
organizationId True string

The unique identifier for the merchant or organization.

name
name True string

The name of the organization

zipCode
zipCode string

The zipcode at where the organization is located

state
state string

The state at where the organization is located

countryISO
countryISO string

The countryISO at where the organization is located

organizationId
organizationId True string

The unique identifier for the merchant or organization.

name
name True string

The name of the organization

zipCode
zipCode string

The zipcode at where the organization is located

state
state string

The state at where the organization is located

countryISO
countryISO string

The countryISO at where the organization is located

isThreeDSAuth
isThreeDSAuth boolean

A True/False value that indicates whether this transaction is authenticated via 3DS.

messageCategory
messageCategory string

Identifies the category of the message for a specific use case. Values accepted: 01 = PA, 02 = NPA, 03-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

deviceChannel
deviceChannel string

Indicates the type of channel interface being used to initiate the transaction. Values accepted: 01 = App-based (APP), 02 = Browser (BRW), 03 = 3DS Requestor Initiated (3RI), 04-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSServerTransId
threeDSServerTransId string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.

threeDSRequestorAuthenticationInd
threeDSRequestorAuthenticationInd string
threeDSRequestorChallengeInd
threeDSRequestorChallengeInd string

Indicates whether a challenge is requested for this transaction. Values accepted: 01 = No preference, 02 = No challenge requested, 03 = Challenge requested (3DS Requestor preference), 04 = Challenge requested (Mandate), 05 = No challenge requested (transactional risk analysis is already performed), 06 = No challenge requested (Data share only), 07 = No challenge requested (strong consumer authentication is already performed), 08 = No challenge requested (utilise whitelist exemption if no challenge required), 09 = Challenge requested (whitelist prompt requested if challenge required)

threeRIInd
threeRIInd string

Indicates the type of 3RI request. Values accepted: 01 = Recurring transaction, 02 = Instalment transaction, 03 = Add card, 04 = Maintain card information, 05 = Account verification, 06 = Split,delayed shipment, 07 = Top-up, 08 = Mail Order, 09 = Telephone Order, 10 = Whitelist status check, 11 = Other payment, 12-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSReqPriorAuthMethod
threeDSReqPriorAuthMethod string

Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Values accepted: 01 = Frictionless authentication occurred by ACS, 02 = Cardholder challenge occurred by ACS, 03 = AVS verified, 04 = Other issuer methods, 05-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

transStatus
transStatus string

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Values accepted: Y = Authentication Verification Successful. N = Not Authenticated,Account Not Verified; Transaction denied. U = Authentication, Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq. A = Attempts Processing Performed; Not Authenticated, Verified, but a proof of attempted authentication,verification is provided. C = Challenge Required; Additional authentication is required using the CReq,CRes. D = Challenge Required; Decoupled Authentication confirmed. R = Authentication,Account Verification Rejected; Issuer is rejecting authentication, verification and request that authorisation not be attempted. I = Informational Only; 3DS Requestor challenge preference acknowledged.

transStatusReason
transStatusReason string

Provides information on why the Transaction Status field has the specified value. Values accepted: 01 = Card authentication failed, 02 = Unknown Device, 03 = Unsupported Device, 04 = Exceeds authentication frequency limit, 05 = Expired card, 06 = Invalid card number, 07 = Invalid transaction, 08 = No Card record, 09 = Security failure, 10 = Stolen card, 11 = Suspected fraud, 12 = Transaction not permitted to cardholder, 13 = Cardholder not enrolled in service, 14 = Transaction timed out at the ACS, 15 = Low confidence, 16 = Medium confidence , 17 = High confidence, 18 = Very High confidence, 19 = Exceeds ACS maximum challenges, 20 = Non-Payment transaction not supported, 21 = 3RI transaction not supported, 22 = ACS technical issue, 23 = Decoupled Authentication required by ACS but not requested by 3DS Requestor, 24 = 3DS Requestor Decoupled Max Expiry Time exceeded, 25 = Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt, 26 = Authentication attempted but not performed by the cardholder, 27-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSCompInd
threeDSCompInd string

Indicates whether the 3DS Method successfully completed. Values accepted: Y = Successfully completed, N = Did not successfully complete, U = Unavailabl 3DS Method URL was not present in the PRes message data for the card range associated with the Cardholder Account Number.

acsChallengeMandated
acsChallengeMandated string

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable. Values accepted: Y = Challenge is mandated, N = Challenge is not mandated

eci
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. Values accepted: 02 (MasterCard)/05 (Visa)= successful authentication 01 (MasterCard)/06/07 (Visa) = all others

shipNameIndicator
shipNameIndicator string

Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted: 01 = Account Name identical to shipping Name, 02 = Account Name different than shipping Name

challengeCompletionInd
challengeCompletionInd string

Indicator of the state of the ACS challenge cycle and whether the challenge has completed or will require additional messages. Values accepted: Y = Challenge completed, and no further challenge message exchanges are required, N = Challenge not completed and additional challenge message exchanges are required

chAccPwChangeInd
chAccPwChangeInd string

Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Values accepted: 01 = No change, 02 = Changed during this transaction, 03 = Less than 30 days, 04 = 30-60 days, 05 = More than 60 days

chAccAgeInd
chAccAgeInd string

Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted: 01 = No account (guest check-out), 02 = Created during this transaction, 03 = Less than 30 days, 04 = 30-60 days, 05 = More than 60 day

provisionAttemptsDay
provisionAttemptsDay string

Number of Add Card attempts in the last 24 hours. Length: maximum 3 characters Example values: 2, 02, 002

exemptionRaised
exemptionRaised string

PSD2 exemption requests, Y - exempted, N - Not exempted

suspiciousAccActivity
suspiciousAccActivity string

Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted: 01 = No suspicious activity has been observed, 02 = Suspicious activity has been observed

productId
productId True string

Product identifier in merchant system.

productName
productName string

User-readable product name.

type
type string

Type of product sold. Possible values 'Digital' | 'Physical'

sku
sku string

Product SKU

category
category string

Category of product. Possible values 'Subscription' | 'Game' | 'GameConsumable' | 'GameDLC' | 'HardwareDevice' | 'HardwareAccessory' | 'SoftwareToken' | 'SoftwareDirectEntitlement' | 'ClothingShoes' | 'RecreationalEquipment' | 'Jewelry' | 'Hotel' | 'Ticket' | 'VehicleRental' | 'GiftCard' | 'Movies' | 'Music' | 'GarageIndustrial' | 'HomeGarden' | 'Tools' | 'Books' | 'HealthBeauty' | 'Furniture' | 'Toys' | 'FoodGrocery'

merchantProductCategory
merchantProductCategory string

Category of product as defined by the merchant in their system

market
market string

Market in which product is offered

productBrand
productBrand string

Brand name of the product

buyItAgainOrder
buyItAgainOrder boolean

True when users re-order a previous order (not just a product from that order)

preOrderAvailabilityDate
preOrderAvailabilityDate date-time

When the product was first available for preorder

salesPrice
salesPrice double

Price of item sold (not including tax). Provided by the Merchant.

currency
currency string

Currency used for sales price. Provided by the Merchant.

cogs
cogs double

Cost of Goods Sold - raw material cost of item. Provided by the Merchant.

isRecurring
isRecurring boolean

Indicates if product is recurring subscription.

isFree
isFree boolean

Indicates if product is offered for free.

language
language string

Language in which product is described.

purchasePrice
purchasePrice double

Price for line item at the purchase.

margin
margin double

Margin gained by sale of item.

quantity
quantity integer

Quantity of item purchased

isPreorder
isPreorder boolean

Indicates if the product is offered for preorder.

shippingMethod
shippingMethod string

Indicates the method used to ship the product. Possible values 'InStorePickup' | 'Standard' | 'Express' | 'DirectEntitlement' | 'DigitalToken'

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

firstName
firstName string

First Name provided with the address

lastName
lastName string

Last Name provided with the address

phoneNumber
phoneNumber string

Phone Number provided with the address

storeId
storeId True string

Store identifier in merchant system

storeName
storeName string

Store name in merchant system

terminalId
terminalId string

The unique identifier for the point of sale terminal

terminalName
terminalName string

The point of sale terminal name

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

userId
userId True string

The user identifier. This information is provided by the merchant.

creationDate
creationDate date-time

The creation date of the user account. The format is ISO 8601.

updateDate
updateDate date-time

The date when user data was last changed. The format is ISO 8601.

firstName
firstName string

The user-provided first name on the account.

lastName
lastName string

The user-provided last name on the account.

country
country string

The user's country or region. The value should be a two-letter ISO country/region code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

phoneNumber
phoneNumber string

The user'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
email string

The user's email address. This value is case-insensitive.

membershipId
membershipId string

The membership ID, if the user already has an existing membership with the merchant.

profileType
profileType string

The user's profile type. Possible values 'Consumer' | 'Seller' | 'Publisher' | 'Tenant' | 'Developer'

profileName
profileName string

The profile name, depending on profileType.

authenticationProvider
authenticationProvider string

The user's authentication provider, if different from the merchant's. Possible valuse 'MSA' | 'Facebook' | 'PSN' | 'MerchantAuth' | 'Google'

authenticationMethod
authenticationMethod string

The way in which the customer was authenticated prior/during purchase. Some possible values are PASSWORD-BASED, MULTI-FACTOR, BIOMETRIC, TOKEN-BASED,

displayName
displayName string

The user's display name. Example: Xbox gamertag value

isEmailValidated
isEmailValidated boolean

A True/False value that indicates whether the user-provided email address has been verified as owned by the user.

emailValidatedDate
emailValidatedDate date-time

The validation date of the user email. The format is ISO 8601.

isPhoneNumberValidated
isPhoneNumberValidated boolean

A True/False value that indicates whether the user-provided phone number has been verified as owned by the user.

phoneNumberValidatedDate
phoneNumberValidatedDate date-time

The validation date of the user phone number. The format is ISO 8601.

membershipType
membershipType string

The customer's membership status or type. Different levels in paid can be specified such as Premium, Executive. Possible values are FREE, PAID, PREMIUM

loginInputMethod
loginInputMethod string

The way in which the customer input their credentials. Possible values are MANUALINPUT, AUTOFILL, SCRIPT, COPYPASTE, SELECTPROFILE

lastPasswordUpdatedDate
lastPasswordUpdatedDate date-time

When the customer's password was last updated.

firstPurchaseDate
firstPurchaseDate date-time

When the customer made their first purchase

loginChallengeType
loginChallengeType string

The type of challenge-response test that was initiated. Possible valuees are TEXT SMS, PHONE SMS, EMAIL PIN, CAPTCHA

airlineIncluded
airlineIncluded boolean

A True/False value indicating whether airfare is included.

carRentalIncluded
carRentalIncluded boolean

A True/False value indicating whether a car rental is included.

lodgingIncluded
lodgingIncluded boolean

A True/False value indicating whether lodging is included.

travelType
travelType string

The travel category or type.

isRoundTrip
isRoundTrip boolean

A True/False value indicating whether the travel is round trip.

isDiscountOffered
isDiscountOffered boolean

A True/False value indicating whether a discount was offered.

isPackagedTour
isPackagedTour boolean

A True/False value indicating whether this was a packaged tour.

issueDateTime
issueDateTime date-time

The date and time when the tickets were issued.

travelDateTime
travelDateTime date-time

The travel start date and time.

returnDateTime
returnDateTime date-time

The travel end or return date and time.

bookingType
bookingType string

The booking type. Some possible valuees are WEBSITE, AGENT

webUrl
webUrl string

The URL where the travel was booked.

fromCity
fromCity string

The city where the customer is travelling from.

fromState
fromState string

The state where the customer is travelling from.

fromCountryISO
fromCountryISO string

The ISO country where the customer is travelling from.

fromZipCode
fromZipCode string

The zip code where the customer is travelling from.

toCity
toCity string

The city where the customer is travelling to.

toState
toState string

The state where the customer is travelling to.

toCountryISO
toCountryISO string

The ISO country where the customer is travelling to.

toZipCode
toZipCode string

The zip code where the customer is travelling to.

ticketNumber
ticketNumber string

The unique ticket number.

placeOfIssue
placeOfIssue string

The location where the ticket was issued.

isRestrictedTicket
isRestrictedTicket boolean

A True/False value indicating whether the ticket is restricted.

rewardsOrVoucherApplied
rewardsOrVoucherApplied boolean

A True/False value indicating whether rewards or vouchers were applied to the order.

totalRewardsApplied
totalRewardsApplied integer

The total rewards which were applied to the order.

totalFees
totalFees double

The total fees applied to the order.

purchaserProfileType
purchaserProfileType string

The customer's profile or membership type. Possiblee values are CORPORATE, INDIVIDUAL

isThirdParty
isThirdParty boolean

A True/False value indicating whether the order was placed through a third party site.

isPurchaserFrequentFlyer
isPurchaserFrequentFlyer boolean

A True/False value indicating whether the order was placed through a third party site.

passengerCount
passengerCount integer

The total number of passengers.

numberOfStops
numberOfStops integer

The number of stops or layovers for the flight.

airlineCode
airlineCode string

The airline code.

airlineName
airlineName string

The airline name.

operatedBy
operatedBy string

The organization operating the flight.

flightNumber
flightNumber string

The flight number.

departureDateTime
departureDateTime date-time

The departure date and time.

arrivalDateTime
arrivalDateTime date-time

The arrival date and time.

fromAirportCode
fromAirportCode string

The airport code where the flight is flying from.

fromAirportCity
fromAirportCity string

The airport city where the customer is travelling from.

fromAirportState
fromAirportState string

The airport state where the customer is travelling from.

fromAirportZipcode
fromAirportZipcode string

The airport zip code where the customer is travelling from.

fromAirportCountryISO
fromAirportCountryISO string

The airport ISO country where the customer is travelling from.

toAirportCode
toAirportCode string

The airport code where the flight is flying to.

toAirportCity
toAirportCity string

The airport city where the customer is travelling to.

toAirportState
toAirportState string

The airport state where the customer is travelling to.

toAirportZipcode
toAirportZipcode string

The airport zip code where the customer is travelling to.

toAirportCountryISO
toAirportCountryISO string

The airport ISO country where the customer is travelling to.

travelClass
travelClass string

The seat class or cabin.

segmentSequence
segmentSequence integer

The sequence number of the given flight leg (e.g. 2 for the second leg of the flight)

firstName
firstName string

The passenger first name.

lastName
lastName string

The passenger last name.

folioNumber
folioNumber string

The unique identifier of the lodging property.

checkInDate
checkInDate date-time

The check-in date for the lodging stay.

checkOutDate
checkOutDate date-time

The check-out date for the lodging stay.

reservationConfirmed
reservationConfirmed boolean

A True/False value indicating whether the reservation has been confirmed.

membershipDetails
membershipDetails string

Additional details on the customer's membership status.

discountProgram
discountProgram string

The discount program applied to the lodging order.

adultCount
adultCount integer

The number of adults included in the stay.

kidCount
kidCount integer

The number of kids included in the stay.

nightsCount
nightsCount integer

The number of nights included in the stay.

roomCount
roomCount integer

The number of rooms included in the stay.

bedType
bedType string

The bed type or category.

roomType
roomType string

The room type or category.

paymentDescription
paymentDescription string

Additional details on the loding payment.

name
name string

The facility name.

type
type string

The facility type.

contactPhoneNumber
contactPhoneNumber string

The phone number used to contact the facility.

contactEmail
contactEmail string

The email address used to contact the facility.

dailyRoomRate
dailyRoomRate double

The daily room rate for the facility.

currency
currency string

The currency supported by the facility.

dailyRoomTaxAmount
dailyRoomTaxAmount double

The daily room tax amount charged by the facility.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

pickupLocation
pickupLocation string

The car rental pickup location.

pickupDateTime
pickupDateTime date-time

The car rental pickup date and time.

dropOffLocation
dropOffLocation string

The car rental drop-off location.

dropOffDateTime
dropOffDateTime date-time

The car rental drop-off date and time

discountProgram
discountProgram string

The discount program applied to the car rental order.

carType
carType string

The car type or category.

isPrepaid
isPrepaid boolean

A True/False value indicating whether the car rental was prepaid.

insuranceIncluded
insuranceIncluded boolean

A True/False value indicating whether insurance was included.

contactEmail
contactEmail string

The car renter's email address.

contactPhoneNumber
contactPhoneNumber string

The car renter's phone number.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

agencyCode
agencyCode string

The travel agency code.

agencyName
agencyName string

The travel agency name.

agentCode
agentCode string

N/A

agencyContactPhone
agencyContactPhone string

N/A

agencyContactEmail
agencyContactEmail string

N/A

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

organizationId
organizationId True string

The unique identifier for the cloud service or organization.

companyName
companyName string

The cloud service name.

companyType
companyType string

The cloud company type.

companySize
companySize integer

The cloud company size.

entityId
entityId string

The unique identifier for the legal entity under the organization.

primaryContactFirstName
primaryContactFirstName string

The first name of the primary contact for the business.

primaryContactLastName
primaryContactLastName string

The last name of the primary contact for the business.

primaryContactEmail
primaryContactEmail string

The email address of the primary contact for the business.

primaryContactPhoneNumber
primaryContactPhoneNumber string

The phone number of the primary contact for the business.

subscriptionCount
subscriptionCount integer

The total number of subscriptions available.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates account information for account protection

This event updates or creates user account information for account protection service, for example, Add Payment Instrument, Add Address, or any other user attribute. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

User Id
UserId True string

user Id for account update

content type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.AccountUpdate'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The identifier of the Account Update event.

accountUpdateId
accountUpdateId True string

The identifier of the Account Update event. Can match trackingId.

assessmentType
assessmentType string

Indicates the assessment type for the event. Possible values are 'Evaluate' | 'Protect'. If not specified, the default is 'Protect'.

customerLocalDate
customerLocalDate True date-time

The creation date of the Account Update event, in the customer's local time zone. The format is ISO 8601.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

deviceContextId
deviceContextId True string

The customer's device ID, as provided and mastered by DFP Device Fingerprinting Service.

ipAddress
ipAddress string

The customer's IP address.

provider
provider string

The provider of device info. Possible values are 'DFPFingerprinting'|'Merchant'|'Unknown'. If not specified, the default is 'DFPFingerprinting'.

externalDeviceId
externalDeviceId string

The customer's device ID, as provided and mastered by the merchant.

externalDeviceType
externalDeviceType string

The customer's device type, as provided and mastered by the merchant. Possible values are 'Mobile' , 'Computer' , 'MerchantHardware' , 'Tablet' , 'GameConsole'.

userId
userId string

The user identifier. This information is provided by the merchant.

userType
userType string

The user's profile type. Possible values are 'Consumer'|'Developer'|'Seller'|'Publisher'|'Tenant'.

username
username True string

The user-provided user name.

firstName
firstName string

The user-provided first name on the account.

lastName
lastName string

The user-provided last name on the account.

countryRegion
countryRegion string

The user's CountryRegion. The value should be a two-letter ISO CountryRegion code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

membershipId
membershipId string

The membership ID, if the user already has an existing membership with the merchant.

isMembershipIdUsername
isMembershipIdUsername boolean

membershipId can be used as user name, defaults to False.

phoneType
phoneType True string

The values are: 'Primary'|'Alternative', default to 'Primary'.

phoneNumber
phoneNumber True string

The user'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).

isPhoneNumberValidated
isPhoneNumberValidated boolean

A True/False value that indicates whether the user-provided phone number has been verified as owned by the user.

phoneNumberValidatedDate
phoneNumberValidatedDate date-time

The validation date of the user phone number. The format is ISO 8601.

isPhoneUsername
isPhoneUsername boolean

The phone number can be used as user name, defaults to False.

emailType
emailType True string

The values are:'Primary', 'Alternative'

emailValue
emailValue True string

The user's email address. This value is case-insensitive.

isEmailValidated
isEmailValidated boolean

A True/False value that indicates whether the user-provided email address has been verified as owned by the user.

emailValidatedDate
emailValidatedDate date-time

The validation date of the user email. The format is ISO 8601.

isEmailUsername
isEmailUsername boolean

The email can be used as user name, defaults to False.

authenticationProvider
authenticationProvider True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

displayName
displayName True string

The user's single sign-on (SSO) authentication provider, if different from the merchant's. Possible valuse are 'MSA'|'Facebook'|'PSN'|'MerchantAuth'|'Google'.

addressType
addressType True string

Address Type. The values are:'Primary'|'Billing'|'Shipping'|'Alternative'. defaults to 'Primary'.

firstName
firstName string

The user-provided first name associated with the address.

lastName
lastName string

The user-provided last name associated with the address.

phoneNumber
phoneNumber string

The user-provided phone number associated with the address.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

countryRegion
countryRegion string

The Country/Region code that was provided for the address. The value should be a two-letter ISO CountryRegion code (for example, US).

merchantPaymentInstrumentId
merchantPaymentInstrumentId True string

The identifier of the payment instrument. This information is provided by the merchant.

type
type True string

The type of payment. Possible values are: 'Other'|'CreditCard'|'DirectDebit'|'PayPal'|'MobileBilling'|'OnlineBankTransfer' |'Invoice' |'MerchantGiftCard'|'MerchantWallet'|'CashOnDelivery'|'Paytm'|'CCAvenue'.

creationDate
creationDate date-time

The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.

updateDate
updateDate date-time

The date of the last update for the payment instrument in the merchant's system. Should not be older than creationDate. The format is ISO 8601.

state
state string

The current state of the PI in merchant's system. Possible values are: 'Active'|'Blocked'|'Expired'

cardType
cardType string

This attribute is used only for payments of the Credit/Debit Card type. Possible values are: 'Visa'|'Mastercard'|'Amex'|'ACH'|'SEPA'|'UnionPay'|'Inicis'|'MobileBillingCarrier'|'Discover'|'AllPay'|'JCB' |'DiscoverDiners'.

holderName
holderName string

The name of the payment instrument's user. This attribute is used only for payments of the Credit/Debit Card type.

bin
bin string

The Credit/Debit card bin. This attribute is used only for payments of the Credit/Debit Card type.

expirationDate
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 Credit/Debit Card type.

lastFourDigits
lastFourDigits string

The last four digits of the Credit/Debit card. This attribute is used only for payments of the Credit/Debit Card type.

addressType
addressType True string

Address Type. The values are:'Primary'|'Billing'|'Shipping'|'Alternative'. defaults to 'Primary'.

firstName
firstName string

The user-provided first name associated with the address.

lastName
lastName string

The user-provided last name associated with the address.

phoneNumber
phoneNumber string

The user-provided phone number associated with the address.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

countryRegion
countryRegion string

The Country/Region code that was provided for the address. The value should be a two-letter ISO CountryRegion code (for example, US).

email
email string

The email address associated with the payment instrument. This attribute is used only for payments of the Paypal type.

billingAgreementId
billingAgreementId string

This attribute is used only for payments of the Paypal type.

payerId
payerId string

This attribute is used only for payments of the Paypal type.

payerStatus
payerStatus string

A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type.

addressStatus
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
imei string

This attribute is used only for payments of the Mobilepayment type.

Returns

Dynamics Fraud Protection Success Object

Updates account information for purchase protection

This event updates or creates user account information for purchase protection service, for example, Add Payment Instrument, Add Address, or any other user attribute. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

userId
userId True string

The user identifier. This information is provided by the merchant.

creationDate
creationDate date-time

The creation date of the user account. The format is ISO 8601.

updateDate
updateDate date-time

The date when user data was last changed. The format is ISO 8601.

firstName
firstName string

The user-provided first name on the account.

lastName
lastName string

The user-provided last name on the account.

country
country string

The user's country or region. The value should be a two-letter ISO country/region code (for example, US).

zipCode
zipCode string

The user's postal code.

timeZone
timeZone string

The user's time zone.

language
language string

The user's language and territory (for example, EN-US).

phoneNumber
phoneNumber string

The user'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
email string

The user's email address. This value is case-insensitive.

membershipId
membershipId string

The membership ID, if the user already has an existing membership with the merchant.

profileType
profileType string

The user's profile type. Possible values 'Consumer' | 'Seller' | 'Publisher' | 'Tenant' | 'Developer'

profileName
profileName string

The profile name, depending on profileType.

authenticationProvider
authenticationProvider string

The user's authentication provider, if different from the merchant's. Possible valuse 'MSA' | 'Facebook' | 'PSN' | 'MerchantAuth' | 'Google'

authenticationMethod
authenticationMethod string

The way in which the customer was authenticated prior/during purchase. Some possible values are PASSWORD-BASED, MULTI-FACTOR, BIOMETRIC, TOKEN-BASED,

displayName
displayName string

The user's display name. Example: Xbox gamertag value

isEmailValidated
isEmailValidated boolean

A True/False value that indicates whether the user-provided email address has been verified as owned by the user.

emailValidatedDate
emailValidatedDate date-time

The validation date of the user email. The format is ISO 8601.

isPhoneNumberValidated
isPhoneNumberValidated boolean

A True/False value that indicates whether the user-provided phone number has been verified as owned by the user.

phoneNumberValidatedDate
phoneNumberValidatedDate date-time

The validation date of the user phone number. The format is ISO 8601.

membershipType
membershipType string

The customer's membership status or type. Different levels in paid can be specified such as Premium, Executive. Possible values are FREE, PAID, PREMIUM

loginInputMethod
loginInputMethod string

The way in which the customer input their credentials. Possible values are MANUALINPUT, AUTOFILL, SCRIPT, COPYPASTE, SELECTPROFILE

lastPasswordUpdatedDate
lastPasswordUpdatedDate date-time

When the customer's password was last updated.

firstPurchaseDate
firstPurchaseDate date-time

When the customer made their first purchase

loginChallengeType
loginChallengeType string

The type of challenge-response test that was initiated. Possible valuees are TEXT SMS, PHONE SMS, EMAIL PIN, CAPTCHA

type
type string

Possible values 'Shipping' | 'Billing' | 'Signup'

firstName
firstName string

The user-provided first name associated with the address.

lastName
lastName string

The user-provided last name associated with the address.

phoneNumber
phoneNumber string

The user-provided phone number associated with the address.

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

merchantPaymentInstrumentId
merchantPaymentInstrumentId string

The identifier of the payment instrument. This information is provided by the merchant.

paymentMethod
paymentMethod string

The top-level payment method category. Possible values are CARD, CASH, DIRECTDEBIT, E-WALLET, MOBILE, E-BANKING, INVOICE, VOUCHERS

type
type True string

The type of payment. Possible values 'CreditCard' | 'DirectDebit' | 'PayPal' | 'MobileBilling' | 'OnlineBankTransfer' | 'Invoice' | 'MerchantGiftCard' | 'MerchantWallet' | 'CashOnDelivery' | 'Paytm' | 'CCAvenue'

creationDate
creationDate date-time

The date of the first entry for the payment instrument in the merchant's system. The format is ISO 8601.

updateDate
updateDate date-time

The date of the last update for the payment instrument in the merchant's system. The format is ISO 8601.

paymentCheckoutProvider
paymentCheckoutProvider string

The eWallet checkout provider.

isLowLiabilityPIType
isLowLiabilityPIType boolean

A True/False value indicating whether the payment method is a low liability.

state
state string

The current state of the PI in merchant's system. Possible values 'Active' | 'Inactive'

cardType
cardType string

This attribute is used only for payments of the Credit/Debit Card type. The network the card is provided from. Possible values 'Visa' | 'Mastercard' | 'Amex' | 'ACH' | 'SEPA' | 'UnionPay' | 'Inicis' | 'MobileBillingCarrier' | 'Discover' | 'AllPay' | 'JCB' | 'DiscoverDiners'

holderName
holderName string

The name of the payment instrument's user. This attribute is used only for payments of the Credit/Debit Card type.

holderCompanyName
holderCompanyName string

Name of the organization providing the business or company card (for business purchases only).

settlementApprovalRequired
settlementApprovalRequired boolean

A True/False value inidcating whether or not approval was required for a SEPA transaction.

bin
bin string

This attribute is used only for payments of the Credit/Debit Card type.

binName
binName string

The BIN display name.

binCountryISO
binCountryISO string

The ISO country code associated with the BIN.

binCardType
binCardType string

The BIN card type. Possible values are DEBIT, CREDIT, PREPAID, FLEET, CREDITDEBIT

binCardAssociation
binCardAssociation string

The BIN card association. Some possible values are VISA, MASTERCARD, AMEX, DISCOVER, MAESTRO, JCB, UNIONPAY, DINERSCLUB

binBankGroup
binBankGroup string

The BIN bank group.

expirationDate
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 Credit/Debit Card type.

lastFourDigits
lastFourDigits string

This attribute is used only for payments of the Credit/Debit Card type.

email
email string

The email address associated with the payment instrument. This attribute is used only for payments of the Paypal type.

billingAgreementId
billingAgreementId string

This attribute is used only for payments of the Paypal type.

payerId
payerId string

This attribute is used only for payments of the Paypal type.

payerStatus
payerStatus string

A value that indicates whether PayPal has verified the payer. This attribute is used only for payments of the Paypal type. Possible values 'Verified' | 'Unverified'

addressStatus
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. Possible values 'Confirmed' | 'Unconfirmed'

imei
imei string

This attribute is used only for payments of the Mobilepayment type.

currency
currency string

Currency code for the selected payment instrument.

isInternationalMoneyTransfer
isInternationalMoneyTransfer boolean

A True/False value indicating whether an international money transfer occurred.

bankIdentifierCode
bankIdentifierCode string

Bank Identifier Code (BIC or SWIFT code)

bankName
bankName string

The bank name

bankZipCode
bankZipCode string

The bank zip code

bankState
bankState string

The bank state

bankCountryISO
bankCountryISO string

The bank ISO country

paymentCollectionDate
paymentCollectionDate date-time

The estimated date for payment collection (primarily used for payment service providers).

instantPaymentSettlement
instantPaymentSettlement boolean

A True/False value indicating bank redirects (used to support CSV payments).

autoCaptureEnabled
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
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
authorizationType string

The authorization type. Mastercard and Visa now require merchants to define authorization attempts as either a pre-authorization or a final-authorization. Possible values are PRE_AUTHORIZATION, FINAL_AUTHORIZATION

authorizationResultCode
authorizationResultCode string

Bank response from the authorization decision. Possible values are APPROVE, DECLINE, PENDING

authorizationResultText
authorizationResultText string

Reasons for the authorization decision; especially for declined or pending transactions. Possible values are MISMATCH_CVV, MISMATCH_ADDRESS, MISMATCH_EXPIRATIONDATE, NOACCOUNT, INVALIDPIN, LOWFUND, OVERLIMIT SUSPICIOUSACCOUNT

acquirerId
acquirerId string

Acquiring institution identification code.

acquirerCountryISO
acquirerCountryISO string

Acquiring institution country code

cvvVerify
cvvVerify string

Indicates whether CVV verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

avsVerify
avsVerify string

Indicates whether addres verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

cavVerify
cavVerify string

Indicates whether cardholder authentication verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

piInputMethod
piInputMethod string

N/A

encryptedCreditCardNumber
encryptedCreditCardNumber string

The hashed or encrypted credit card number.

firstName
firstName string

First Name provided with the address

lastName
lastName string

Last Name provided with the address

phoneNumber
phoneNumber string

Phone Number provided with the address

street1
street1 string

The first row that was provided for the address.

street2
street2 string

The second row that was provided for the address. (This value can be blank.)

street3
street3 string

The third row that was provided for the address. (This value can be blank.)

city
city string

The city that was provided for the address.

state
state string

The state or province that was provided for the address.

district
district string

The district that was provided for the address.

zipCode
zipCode string

The postal code that was provided for the address.

country
country 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).

deviceContextId
deviceContextId True string

The customer's fingerprinting session ID, or the event ID if the session is not available.

ipAddress
ipAddress string

Customer's IP address (provided by Merchant)

provider
provider string

The provider of device info. Possible values are 'DFPFingerPrinting' | 'Merchant'. If using the DFP Fingerprinting JS script, you must pass 'DFPFingerPrinting' for all data to get properly connected.

deviceContextDC
deviceContextDC string

DEPRECATED: No longer needed for DFP Fingerprinting. The datacenter storing the customer's DFP Fingerprinting session (provided by the DFP Fingerprinting JS script).

externalDeviceId
externalDeviceId string

The customer's device ID, as provided and mastered by the merchant.

externalDeviceType
externalDeviceType string

The customer's device type, as provided and mastered by the merchant. Possible values 'Mobile' | 'Computer' | 'MerchantHardware' | 'Tablet' | 'GameConsole'

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates bank authorization information

This event conveys if a purchase transaction sent to the bank was approved or rejected for bank authorization or bank charge/settlement. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

bankEventId
bankEventId True string

A unique string identifying this Bank Event

type
type True string

Bank Event Type. Possible values 'Auth' | 'AuthCancel' | 'ChargeReversal' | 'Charge'

bankEventTimestamp
bankEventTimestamp date-time

Timestamp from Bank

status
status string

Possible values 'Approved' | 'Unknown' | 'Declined'

bankResponseCode
bankResponseCode string

Bank code on response

paymentProcessor
paymentProcessor string

Processor name. Possible values 'FDC' | 'Adyen' | 'TSYS' | 'WorldPay' | 'Chase' | 'Stripe' | 'PayPal'

mrn
mrn string

Merchant Reference Number, used to identify the transaction from the merchant side

mid
mid string

Merchant ID (MID) sent to the bank and/or received back from it.

merchantPaymentInstrumentId
merchantPaymentInstrumentId string

The identifier of the payment instrument. This information is provided by the merchant.

paymentMethod
paymentMethod string

Groupings/categories of payment methods. Possible values are CARD, CASH, DIRECTDEBIT, E-WALLET, MOBILE, E-BANKING, INVOICE, VOUCHERS

cardType
cardType string

The type of payment. Possible values are VISA , MASTERCARD , AMEX , ACH , SEPA , UNIONPAY , INICIS , MOBILEBILLINGCARRIER , DISCOVER , ALLPAY , JCB , DISCOVERDINERS

updatedPI
updatedPI boolean

Used different PI than the one in Purchase

cvvVerify
cvvVerify string

Indicates whether CVV verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

avsVerify
avsVerify string

Indicates whether addres verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

cavVerify
cavVerify string

Indicates whether cardholder authentication verification is available and/or sucessfully verified. Y = Successfully verified, N = Did not successfully vefified, U = Unavailable, A = Available, but no verification

authResultCode
authResultCode string

Bank response from the authorization decision. Possible values are APPROVE, DECLINE, PENDING

authResultText
authResultText string

Reasons for the authorization decision; especially for declined or pending transactions. Possible values are MISMATCH_CVV, MISMATCH_ADDRESS, MISMATCH_EXPIRATIONDATE, NOACCOUNT, INVALIDPIN, LOWFUND, OVERLIMIT SUSPICIOUSACCOUNT

purchaseId
purchaseId True string

A unique string identifying the purchase

isThreeDSAuth
isThreeDSAuth boolean

A True/False value that indicates whether this transaction is authenticated via 3DS.

messageCategory
messageCategory string

Identifies the category of the message for a specific use case. Values accepted: 01 = PA, 02 = NPA, 03-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

deviceChannel
deviceChannel string

Indicates the type of channel interface being used to initiate the transaction. Values accepted: 01 = App-based (APP), 02 = Browser (BRW), 03 = 3DS Requestor Initiated (3RI), 04-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSServerTransId
threeDSServerTransId string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.

threeDSRequestorAuthenticationInd
threeDSRequestorAuthenticationInd string
threeDSRequestorChallengeInd
threeDSRequestorChallengeInd string

Indicates whether a challenge is requested for this transaction. Values accepted: 01 = No preference, 02 = No challenge requested, 03 = Challenge requested (3DS Requestor preference), 04 = Challenge requested (Mandate), 05 = No challenge requested (transactional risk analysis is already performed), 06 = No challenge requested (Data share only), 07 = No challenge requested (strong consumer authentication is already performed), 08 = No challenge requested (utilise whitelist exemption if no challenge required), 09 = Challenge requested (whitelist prompt requested if challenge required)

threeRIInd
threeRIInd string

Indicates the type of 3RI request. Values accepted: 01 = Recurring transaction, 02 = Instalment transaction, 03 = Add card, 04 = Maintain card information, 05 = Account verification, 06 = Split,delayed shipment, 07 = Top-up, 08 = Mail Order, 09 = Telephone Order, 10 = Whitelist status check, 11 = Other payment, 12-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSReqPriorAuthMethod
threeDSReqPriorAuthMethod string

Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Values accepted: 01 = Frictionless authentication occurred by ACS, 02 = Cardholder challenge occurred by ACS, 03 = AVS verified, 04 = Other issuer methods, 05-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

transStatus
transStatus string

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Values accepted: Y = Authentication Verification Successful, N = Not Authenticated,Account Not Verified; Transaction denied, U = Authentication, Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq, A = Attempts Processing Performed; Not Authenticated, Verified, but a proof of attempted authentication,verification is provided, C = Challenge Required; Additional authentication is required using the CReq,CRes, D = Challenge Required; Decoupled Authentication confirmed, R = Authentication,Account Verification Rejected; Issuer is rejecting authentication, verification and request that authorisation not be attempted, I = Informational Only; 3DS Requestor challenge preference acknowledged.

transStatusReason
transStatusReason string

Provides information on why the Transaction Status field has the specified value. Values accepted: 01 = Card authentication failed, 02 = Unknown Device, 03 = Unsupported Device, 04 = Exceeds authentication frequency limit, 05 = Expired card, 06 = Invalid card number, 07 = Invalid transaction, 08 = No Card record, 09 = Security failure, 10 = Stolen card, 11 = Suspected fraud, 12 = Transaction not permitted to cardholder, 13 = Cardholder not enrolled in service, 14 = Transaction timed out at the ACS, 15 = Low confidence, 16 = Medium confidence , 17 = High confidence, 18 = Very High confidence, 19 = Exceeds ACS maximum challenges, 20 = Non-Payment transaction not supported, 21 = 3RI transaction not supported, 22 = ACS technical issue, 23 = Decoupled Authentication required by ACS but not requested by 3DS Requestor, 24 = 3DS Requestor Decoupled Max Expiry Time exceeded, 25 = Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt, 26 = Authentication attempted but not performed by the cardholder, 27-79 = Reserved for EMVCo future use (values invalid until defined by EMVCo), 80-99 = Reserved for DS use

threeDSCompInd
threeDSCompInd string

Indicates whether the 3DS Method successfully completed. Values accepted: Y = Successfully completed, N = Did not successfully complete, U = Unavailabl 3DS Method URL was not present in the PRes message data for the card range associated with the Cardholder Account Number.

acsChallengeMandated
acsChallengeMandated string

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable. Values accepted: Y = Challenge is mandated, N = Challenge is not mandated

eci
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. Values accepted: 02 (MasterCard)/05 (Visa)= successful authentication 01 (MasterCard)/06/07 (Visa) = all others

shipNameIndicator
shipNameIndicator string

Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted: 01 = Account Name identical to shipping Name, 02 = Account Name different than shipping Name

challengeCompletionInd
challengeCompletionInd string

Indicator of the state of the ACS challenge cycle and whether the challenge has completed or will require additional messages. Values accepted: Y = Challenge completed, and no further challenge message exchanges are required, N = Challenge not completed and additional challenge message exchanges are required

chAccPwChangeInd
chAccPwChangeInd string

Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset. Values accepted: 01 = No change, 02 = Changed during this transaction, 03 = Less than 30 days, 04 = 30-60 days, 05 = More than 60 days

chAccAgeInd
chAccAgeInd string

Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted: 01 = No account (guest check-out), 02 = Created during this transaction, 03 = Less than 30 days, 04 = 30-60 days, 05 = More than 60 day

provisionAttemptsDay
provisionAttemptsDay string

Number of Add Card attempts in the last 24 hours. Length: maximum 3 characters Example values: 2, 02, 002

exemptionRaised
exemptionRaised string

PSD2 exemption requests, Y - exempted, N - Not exempted

suspiciousAccActivity
suspiciousAccActivity string

Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted: 01 = No suspicious activity has been observed, 02 = Suspicious activity has been observed

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates confirmed fraud information

This event sends information about a previous purchase that the customer disputed with their bank as fraud. This is a data ingestion event only. Many merchants send these events using bulk data upload

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

chargebackId
chargebackId True string

A unique string identifying this chargeback event

reason
reason string

Reason provided by bank

status
status string

Possible values 'Inquiry' | 'Accepted' | 'Disputed' | 'Reversed' | 'ResubmittedRequest'

bankEventTimestamp
bankEventTimestamp date-time

Timestamp from Bank

amount
amount double

The chargeback amount

currency
currency string

Currency used for chargeback amount.

purchaseId
purchaseId True string

The original Purchase Id

userId
userId string

A unique string identifying the User

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates fraud label information for account protection

This event sends an update of the label. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

User Id
UserId True string

user Id for label Api

Contect Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.Label'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The unique ID for each event/record.

userId
userId True string

The user identifier. This information is provided by the merchant.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

eventTimeStamp
eventTimeStamp True date-time

The date and time of the event. Possible values: Chargeback Date or Review Date. The format is ISO 8601.

labelObjectType
labelObjectType True string

This field indicates the type of label: 'Purchase'|'AccountCreation'|'AccountLogin'|'AccountUpdate'|'CustomFraudEvaluation'|'Account'|'PaymentInstrument'|'Email'.

labelObjectId
labelObjectId True string

This is an identifier field for the object: PurchaseId, AccountCreationId, AccountLoginId, AccountUpdateId, UserId, MerchantPaymentInstrumentId, or Email.

labelSource
labelSource string

This field represents the source of the label: 'CustomerEscalation'|'Chargeback'|'TC40_SAFE'|'ManualReview'|'Refund'|'OfflineAnalysis'|'AccountProtectionReview'.

labelState
labelState True string

This field indicates the current status of the label: 'InquiryAccepted'|'Fraud'|'Disputed'|'Reversed'|'Abuse'|'ResubmittedRequest'|'AccountCompromised'|'AccountNotCompromised'.

labelReasonCode
labelReasonCode string

This field indicates the reason codes associated with each type of label: 'ProcessorResponseCode'|'BankResponseCode'|'FraudRefund'|'AccountTakeOver'|'PaymentInstrumentFraud'|'AccountFraud'|'Abuse'|'FriendlyFraud'|'AccountCredentialsLeaked'|'PassedAccountProtectionChecks'

processor
processor string

The name of the bank or payment processor that is generating the TC40 or SAFE information.

effectiveStartDate
effectiveStartDate date-time

The date from which this label is effective. The format is ISO 8601.

effectiveEndDate
effectiveEndDate date-time

The end date for this label. The format is ISO 8601. Must not be older than effectiveStartDate.

Returns

Dynamics Fraud Protection Success Object

Updates fraud label information for purchase protection

This event sends an update of the label. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

labelObjectType
labelObjectType True string

EntityName to which this label entity applies. If set to Email, the User id is looked-up from an email LabelObjectId. Possible values are PURCHASE , SIGNUP , CUSTOMFRAUDEVALUATION , ACCOUNT , PI , EMAIL

labelObjectId
labelObjectId True string

The Id value within the LabelObjectType to which this label entity applies.

labelSource
labelSource string

The authority issuing this label's LabelReasonCodes or LabelState. Possible values 'CustomerEscalation' | 'Chargeback' | 'TC40_SAFE' | 'ManualReview' | 'Refund' | 'OfflineAnalysis'

labelReasonCodes
labelReasonCodes string
labelState
labelState string

If the LabelSource has state-transitions, the current state of this label. Ex. "Accepted" to mean a prior fraud suspicion has been cleared. Possible values 'Inquiry' | 'Accepted' | 'Fraud' | 'Disputed' | 'Reversed' | 'ResubmittedRequest'

processor
processor string

The specific LabelSource institution issuing the LabelReasonCodes.

eventTimeStamp
eventTimeStamp date-time

The event's ultimate creation as reported from LabelSource/Processor. Format is ISO8601.

effectiveStartDate
effectiveStartDate date-time

The beginning of when this Label applies in Merchant time-zone (if different from MerchantLocalDate). Format is ISO8601.

effectiveEndDate
effectiveEndDate date-time

The end of when this Label applies in Merchant time-zone or null for not-applicable/indeterminate. Format is ISO8601.

amount
amount double

The monetary amount this label pertains to, e.g. of a partial refund. Units given by Currency field.

currency
currency string

Which currency the Amount is in, e.g. "USD"

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates refund information

This event sends information about a previous purchase transaction being refunded. This is a data ingestion event only. Many merchants send these events using bulk data upload

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

refundId
refundId True string

A unique string identifying this refund event

reason
reason string

User provided reason. Possible values 'FraudRefund' | 'CustomerRequest' | 'NonFraudRefund'

status
status string

Possible values 'Approved' | 'Declined' | 'Unknown'

bankEventTimestamp
bankEventTimestamp date-time

Timestamp from Bank

amount
amount double

The refund amount

currency
currency string

Currency used for sales price amount.

userId
userId string

A unique string identifying the User

purchaseId
purchaseId True string

The original Purchase Id

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates status of a online purchase transaction

This event sends an update of the status of a purchase, for example, if the purchase has been canceled. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

Content Type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

purchaseId
purchaseId True string

Transaction (or purchase/order) identifier in merchant system.

statusType
statusType True string

The type of the status. Possible values 'Approved' | 'Pending' | 'Rejected' | 'Failed' | 'Canceled'

statusDate
statusDate True date-time

The DateTime when this status was applied

reason
reason string

Reason of the status transition. Possible values 'RuleEngine' | 'MerchantOverride' | 'ChallengeSolved' | 'ChallengeFailed' | 'CustomerRequest' | 'FufillmentFailed' | 'InlineManualReview_General' | 'InlineManualReview_Fraud' | 'InlineManualReview_AccountCompromise' | 'OfflineManualReview_General' | 'OfflineManualReview_Fraud' | 'OfflineManualReview_AccountCompromise' | 'Safelist' | 'Blocklist'

trackingId
trackingId string

TrackingId for the event

merchantTimeStamp
merchantTimeStamp date-time

TimeStamp for the event

Returns

Result details

Updates the status of account creation

This event sends an update of the status of an Account Creation, for example, if the Account Creation has been canceled. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

content type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.AccountCreation.Status'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The identifier of the Account Creation Status event.

signUpId
signUpId True string

The identifier of the Account Creation event.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

userId
userId True string

The user identifier. This information is provided by the merchant.

statusType
statusType True string

The type of status: 'Approved'|'Rejected'|'Pending'.

reasonType
reasonType string

The type of reason: 'None'|'ChallengeAbandoned'|'ChallengeFailed'|'ChallengePassed'|'ChallengePending'|'ReviewFailed'|'ReviewPassed'|'ReviewPendinge'. Defaults to 'None'.

challengeType
challengeType string

The type of review status: 'SMS'|'Email'|'Phone'|'Other'|'None'. Defaults to 'None'.

statusDate
statusDate True date-time

The date and time when the status was applied. The format is ISO 8601.

Returns

Dynamics Fraud Protection Success Object

Updates the status of account login

This event sends an update of the status of an Account Login, for example, if the Account login has been canceled. This is a data ingestion event only

Parameters

Name Key Required Type Description
hosturl
hostUrl True string

host url

content type
Content-Type True string

application/json

Correlation Id
x-ms-correlation-id string

A unqiue, per-request Correlation-Id helpful in tracing runtime issues.

Environment Id
x-ms-dfpenvid string

EnvironmentId

name
name True string

The event name. Should be 'AP.AccountLogin.Status'

version
version True string

The payload version. Should be "0.5"

trackingId
trackingId True string

The identifier of the Account Login Status event.

loginId
loginId True string

The identifier of the Account Login event.

merchantTimeStamp
merchantTimeStamp True date-time

TimeStamp for the event.

userId
userId True string

The user identifier. This information is provided by the merchant.

statusType
statusType True string

The type of status: 'Approved'|'Rejected'|'Pending'.

reasonType
reasonType string

The type of reason: 'None'|'ChallengeAbandoned'|'ChallengeFailed'|'ChallengePassed'|'ChallengePending'|'ReviewFailed'|'ReviewPassed'|'ReviewPendinge'. Defaults to 'None'.

challengeType
challengeType string

The type of review status: 'SMS'|'Email'|'Phone'|'Other'|'None'. Defaults to 'None'.

statusDate
statusDate True date-time

The date and time when the status was applied. The format is ISO 8601.

Returns

Dynamics Fraud Protection Success Object

Definitions

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.AccountCreateEnrichment

A class represent the enrichment features for Account Create assessment

Name Path Type Description
deviceAttributes
deviceAttributes Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.DeviceAttributes

A class representing the features derived from the user's device attributes.

calculatedFeatures
calculatedFeatures Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.CalculatedFeatures

A class representing the features calculated during assessment

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.AccountCreateResponseSuccessDetails

Response Object for Dynamics Fraud Protection AccountCreate API

Name Path Type Description
name
name string

N/A

version
version string

N/A

code
code string

N/A

description
description string

N/A

resultDetails
resultDetails array of Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.ResultDetail

AssessmentResultDetail collection

transactionReferenceId
transactionReferenceId string

Unique id to identify individual transactions

enrichment
enrichment Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.AccountCreateEnrichment

A class represent the enrichment features for Account Create assessment

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.AccountProtectionEnrichment

A class representing the enrichment features

Name Path Type Description
deviceAttributes
deviceAttributes Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.DeviceAttributes

A class representing the features derived from the user's device attributes.

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.CalculatedFeatures

A class representing the features calculated during assessment

Name Path Type Description
emailDomain
emailDomain string

Domain of email parsed from assessment payload

emailPattern
emailPattern string

Pattern of email handle calculated from the email. All upper case letters in the email prefix are replaced with 'U', lower case letters replaced with 'I', digits replaced with 'd'. Repeated 'I' and 'U's are collapsed, and the remaining characters are left unchanged. For example, the email 'kAyla.277@contoso.com' would return the email pattern 'lUl.ddd'

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.DeviceAttributes

A class representing the features derived from the user's device attributes.

Name Path Type Description
trueIp
trueIp string

True IP address of device identified by device fingerprinting

proxyIp
proxyIp string

Proxy IP address of device proxy identified by device fingerprinting

realtimeTimezoneOffset
realtimeTimezoneOffset string

Timezone offset that takes daylight saving schedule into consideration

sld
sld string

Second Level Domain related to true IP

timeZone
timeZone string

TimeZone offset with respect to Greenwich Mean Time

proxyLastDetected
proxyLastDetected string

The most recent date when the device IP is identified to be active proxy

deviceId
deviceId string

Unique deviceid generated by device fingerprinting

deviceCountryCode
deviceCountryCode string

Device location country of true IP

deviceState
deviceState string

Device location state of true IP

deviceCity
deviceCity string

Device location city of true IP

devicePostalCode
devicePostalCode string

Device location postal code of true IP

deviceAsn
deviceAsn string

ASN of device identified by device fingerprinting

platform
platform string

Operating system platform of device

browserUserAgentLanguages
browserUserAgentLanguages string

Languages stored in the user agent

browserUserAgent
browserUserAgent string

Browser used in the session

tcpDistance
tcpDistance string

Number of network hops in connection

carrier
carrier string

ISP of the identified true IP

ipRoutingType
ipRoutingType string

Routing type of IP

proxy
proxy string

Flag that determines if the caller is a proxy

proxyType
proxyType string

Type of the proxy if detected

userAgentPlatform
userAgentPlatform string

Browser version

userAgentBrowser
userAgentBrowser string

Browser family

userAgentOperatingSystem
userAgentOperatingSystem string

Operating system version

sdkType
sdkType string

The SDK used by the device to make the call (Android, iOS, or Web)

dataNetworkType
dataNetworkType string

The type of network used (Wifi or Mobile). For Android and iOS devices.

localIpv4
localIpv4 string

The device's local IPV4 address. For Android and iOS devices.

isDeviceEmulator
isDeviceEmulator string

Indicates whether the device is emulated. For Android and iOS devices.

isDeviceRooted
isDeviceRooted string

Indicates whether the device has been rooted. For Android and iOS devices.

isWifiEnabled
isWifiEnabled string

Indicates whether the device's wifi is enabled or disabled. For Android devices.

deviceSystemVersion
deviceSystemVersion string

The current version of the operating system. For iOS devices.

deviceModelName
deviceModelName string

The device model name. For iOS devices.

localIpv6
localIpv6 string

The device's local IPV6 address. For iOS devices.

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.ResponseSuccess

Dynamics Fraud Protection Success Object

Name Path Type Description
name
name string

N/A

version
version string

N/A

code
code string

N/A

description
description string

N/A

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.ResponseSuccessDetails

Response Object for Dynamics Fraud Protection APIs

Name Path Type Description
name
name string

N/A

version
version string

N/A

code
code string

N/A

description
description string

N/A

resultDetails
resultDetails array of Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.ResultDetail

AssessmentResultDetail collection

transactionReferenceId
transactionReferenceId string

Unique id to identify individual transactions

enrichment
enrichment Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.AccountProtectionEnrichment

A class representing the enrichment features

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.ResultDetail

AssessmentResultDetail

Name Path Type Description
decision
decision string

The type of the decision made

challengeType
challengeType string

The type of challenge

reasons
reasons array of string

A list of reasons

rule
rule string

The rule that the payload matched

clauseName
clauseName string

The rule-clause friendly-name that made the decision

supportMessages
supportMessages array of string

List of messages that support the decision

other
other object

any additional data

scores
scores array of Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.Score

List of different scores

ruleEvaluations
ruleEvaluations array of Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.RuleEvaluation

The path of rulesets consulted to arrive at this decision

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.RuleEvaluation

A record of ruleset execution on the way to a

Name Path Type Description
rule
rule string

The ruleset's friendly name

clauseNames
clauseNames array of string

The clause(s) this rule fired, in order, with the last being the final deicion reached

Microsoft.DynamicsFraudProtection.Models.AccountProtection.Response.Score

Score object

Name Path Type Description
scoreType
scoreType string

The score type

scoreValue
scoreValue double

the score value. Max value is 999

reason
reason string

The reason for the score value

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.BankEventActivity.BankEvent

Name Path Type Description
object

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.BankEventActivity.BankEventResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.BankEventActivity.BankEvent

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.ChargebackActivity.Chargeback

Name Path Type Description
object

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.ChargebackActivity.ChargebackResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.ChargebackActivity.Chargeback

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.LabelActivity.Label

Name Path Type Description
object

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.LabelActivity.LabelResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.LabelActivity.Label

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseActivity.PurchaseResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseActivity.PurchaseWrapper

Purchase response payload

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseActivity.PurchaseWrapper

Purchase response payload

Name Path Type Description
riskScore
riskScore integer

Risk score calculated by Fraud Protection risk models in the range from -1 to 1000. -1 indicates an error determining a risk score.

merchantRuleDecision
merchantRuleDecision string

Decision made by the Merchant Rules after getting Risk Score for a transaction. Possible values 'Approve' | 'Reject'

ruleEvaluations
ruleEvaluations array of

Contains the name of the rules evaluated to come to a decision.

clauseName
clauseName string

Contains the name of the clause that gave the decision.

midFlag
midFlag string

Recommended Merchant ID (MID) flag. Possible values 'Program' | 'Standard' | 'Control'

reasonCodes
reasonCodes string

Reason codes explaining the decision.

policyApplied
policyApplied string

The name of the merchant rule or default rule that lead to the merchant rule decision.

bankName
bankName string

Bank (issuer) which DFP called for this transaction.

hashedEvaluationId
hashedEvaluationId string

HashedEvaluationId as computed by DFP

diagnostics
diagnostics object

Diagnostic objects keyed by namespace

purchaseId
purchaseId string

Transaction (or purchase/order) identifier in merchant system.

deviceAttributes
deviceAttributes object

Device attributes from DFP Fingerprinting

succeeded
succeeded string

Is request successful

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseStatusActivity.PurchaseStatus

Name Path Type Description
object

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseStatusActivity.PurchaseStatusResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.PurchaseStatusActivity.PurchaseStatus

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.RefundActivity.Refund

Name Path Type Description
object

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.RefundActivity.RefundResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.RefundActivity.Refund

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.UpdateAccountActivity.UpdateAccount

UpdateAccount response payload

Name Path Type Description
deviceAttributes
deviceAttributes object

Device attributes from DFP Fingerprinting

succeeded
succeeded string

Is request successful

Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.UpdateAccountActivity.UpdateAccountResponseWrapper

Result details

Name Path Type Description
resultDetails
resultDetails Microsoft.DynamicsFraudProtection.v1.MerchantResponse.Models.UpdateAccountActivity.UpdateAccount

UpdateAccount response payload