Dynamics 365 Fraud Protection (Preview)

host url

application/json

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

EnvironmentId

The event name. Should be 'AP.AccountCreation'

The payload version. Should be "0.5"

The identifier of the Account Creation event.

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

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

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

TimeStamp for the event.

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

The customer's IP address.

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

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

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

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

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

The user-provided user name.

The user-provided first name on the account.

The user-provided last name on the account.

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

The user's postal code.

The user's time zone.

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

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

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

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

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

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

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

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

The values are:'Primary', 'Alternative'

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

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

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

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

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

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

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

The user-provided first name associated with the address.

The user-provided last name associated with the address.

The user-provided phone number associated with the address.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

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.

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

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'.

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

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

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.

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

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

The user-provided first name associated with the address.

The user-provided last name associated with the address.

The user-provided phone number associated with the address.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

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

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

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

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

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

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

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

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

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

The date of the campaign starting on the incentive collection.

The date of the campaign expiration on the incentive collection.

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

host url

application/json

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

EnvironmentId

The event name. Should be 'AP.AccountLogin'

The payload version. Should be "0.5"

The identifier of the Login event.

The identifier of the Login event. Can match trackingId.

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

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

TimeStamp for the event.

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

The customer's IP address.

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

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

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

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

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

The user-provided user name.

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

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

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

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

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

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

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

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

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

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

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

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

The date of the campaign starting on the incentive collection.

The date of the campaign expiration on the incentive collection.

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

host url

api name of assessment

application/json

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

EnvironmentId

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

The payload version. Should be "1.0"

The identifier of the Account Creation event.

TimeStamp for the event.

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

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

The user's postal code.

The user's time zone.

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

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

Example on primitive type.

Example field.

Example field.

host url

application/json

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

EnvironmentId

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

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

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

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

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

Merchant identifier (MID) for the bank

Merchant Category Code (MCC) for the bank

Merchant Business Type for this purchase

Merchant Business Segment for this purchase

Signifies that the purchase is a test purchase

Signifies if a free product is part of this purchase

Signifies if the purchase is a recurring charge

Signifies if the purchase is being made via gueest checkout

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

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

Number of days after which the charge recurs

Start date for this purchase, if recurring

End date for this purchase, if recurring

Signifies if the purchase is post paid

Count of unique products sold as part of the purchase

Total count of products sold as part of the purchase

Type of order, for example, Take Out

Discount provided on the original purchase before deriving the total amount

Tip provided on the purchase

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.

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

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

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

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

The unique ID for the recurring charge

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

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

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

The user's shipping email address

Key-value pairs that can be passed in for the use of rules, etc. Learn more at https://docs.microsoft.com/dynamics365/fraud-protection/schema#download-sample-data

The date that the order was shipped

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

The App Name or Web URL where the transaction was created

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

The second level business or industry segment

Year when the item was updated the last time

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

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

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

The user-provided first name on the account.

The user-provided last name on the account.

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

The user's postal code.

The user's time zone.

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

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

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

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

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

The profile name, depending on profileType.

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

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

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

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

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

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

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

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

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

When the customer's password was last updated.

When the customer made their first purchase

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

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

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.

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

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

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

Customer's IP address (provided by Merchant)

The digital signature of the HTTP message.

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

The full list of request headers sent by the browser.

The browser resolution.

The browser default language preference.

The TCP application signature.

The SSL signature.

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

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

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

The aspect ratio of the browser.

The color depth of the screen.

Resolution of device screen in pixels

The site's hostname.

The device operating system.

The operating system's default font.

The device processor.

The unique session ID.

True IP address of device identified by device fingerprinting

IP address of proxy device.

Unique GUID per device generated by device fingerprinting

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

Additional user agent or browser details.

Application version.

List of packages installed on the device.

Manufacturer of the device.

End-user visibile name for the end product.

Build version.

Type of mobile data network.

Device model.

Device name of the machine.

Device version.

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

ISO country code for the mobile service provider.

Mobile network type.

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

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

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

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

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

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

The eWallet checkout provider.

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

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

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'

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

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

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

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

The BIN display name.

The ISO country code associated with the BIN.

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

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

The BIN bank group.

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.

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

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

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

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

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'

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'

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

Currency code for the selected payment instrument.

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

Bank Identifier Code (BIC or SWIFT code)

The bank name

The bank zip code

The bank state

The bank ISO country

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

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

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.

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.

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

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

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

Acquiring institution identification code.

Acquiring institution country code

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

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

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

N/A

The hashed or encrypted credit card number.

Total purchase amount using this PI for the transaction

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

First Name provided with the address

Last Name provided with the address

Phone Number provided with the address

The unique identifier for the merchant or organization.

The name of the organization

The zipcode at where the organization is located

The state at where the organization is located

The countryISO at where the organization is located

The unique identifier for the merchant or organization.

The name of the organization

The zipcode at where the organization is located

The state at where the organization is located

The countryISO at where the organization is located

The unique identifier for the merchant or organization.

The name of the organization

The zipcode at where the organization is located

The state at where the organization is located

The countryISO at where the organization is located

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

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

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

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

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)

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

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

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.

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

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.

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

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

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

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

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

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

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

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

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

Product identifier in merchant system.

User-readable product name.

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

Product SKU

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'

Category of product as defined by the merchant in their system

Market in which product is offered

Brand name of the product

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

When the product was first available for preorder

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

Currency used for sales price. Provided by the Merchant.

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

Indicates if product is recurring subscription.

Indicates if product is offered for free.

Language in which product is described.

Price for line item at the purchase.

Margin gained by sale of item.

Quantity of item purchased

Indicates if the product is offered for preorder.

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

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

First Name provided with the address

Last Name provided with the address

Phone Number provided with the address

Store identifier in merchant system

Store name in merchant system

The unique identifier for the point of sale terminal

The point of sale terminal name

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

The user-provided first name on the account.

The user-provided last name on the account.

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

The user's postal code.

The user's time zone.

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

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

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

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

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

The profile name, depending on profileType.

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

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

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

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

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

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

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

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

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

When the customer's password was last updated.

When the customer made their first purchase

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

A True/False value indicating whether airfare is included.

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

A True/False value indicating whether lodging is included.

The travel category or type.

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

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

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

The date and time when the tickets were issued.

The travel start date and time.

The travel end or return date and time.

The booking type. Some possible valuees are WEBSITE, AGENT

The URL where the travel was booked.

The city where the customer is travelling from.

The state where the customer is travelling from.

The ISO country where the customer is travelling from.

The zip code where the customer is travelling from.

The city where the customer is travelling to.

The state where the customer is travelling to.

The ISO country where the customer is travelling to.

The zip code where the customer is travelling to.

The unique ticket number.

The location where the ticket was issued.

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

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

The total rewards which were applied to the order.

The total fees applied to the order.

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

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

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

The total number of passengers.

The number of stops or layovers for the flight.

The airline code.

The airline name.

The organization operating the flight.

The flight number.

The departure date and time.

The arrival date and time.

The airport code where the flight is flying from.

The airport city where the customer is travelling from.

The airport state where the customer is travelling from.

The airport zip code where the customer is travelling from.

The airport ISO country where the customer is travelling from.

The airport code where the flight is flying to.

The airport city where the customer is travelling to.

The airport state where the customer is travelling to.

The airport zip code where the customer is travelling to.

The airport ISO country where the customer is travelling to.

The seat class or cabin.

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

The passenger first name.

The passenger last name.

The unique identifier of the lodging property.

The check-in date for the lodging stay.

The check-out date for the lodging stay.

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

Additional details on the customer's membership status.

The discount program applied to the lodging order.

The number of adults included in the stay.

The number of kids included in the stay.

The number of nights included in the stay.

The number of rooms included in the stay.

The bed type or category.

The room type or category.

Additional details on the loding payment.

The facility name.

The facility type.

The phone number used to contact the facility.

The email address used to contact the facility.

The daily room rate for the facility.

The currency supported by the facility.

The daily room tax amount charged by the facility.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

The car rental pickup location.

The car rental pickup date and time.

The car rental drop-off location.

The car rental drop-off date and time

The discount program applied to the car rental order.

The car type or category.

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

A True/False value indicating whether insurance was included.

The car renter's email address.

The car renter's phone number.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

The travel agency code.

The travel agency name.

N/A

N/A

N/A

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

The unique identifier for the cloud service or organization.

The cloud service name.

The cloud company type.

The cloud company size.

The unique identifier for the legal entity under the organization.

The first name of the primary contact for the business.

The last name of the primary contact for the business.

The email address of the primary contact for the business.

The phone number of the primary contact for the business.

The total number of subscriptions available.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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 for the event

TimeStamp for the event

host url

user Id for account update

application/json

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

EnvironmentId

The event name. Should be 'AP.AccountUpdate'

The payload version. Should be "0.5"

The identifier of the Account Update event.

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

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

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

TimeStamp for the event.

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

The customer's IP address.

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

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

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

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

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

The user-provided user name.

The user-provided first name on the account.

The user-provided last name on the account.

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

The user's postal code.

The user's time zone.

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

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

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

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

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

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

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

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

The values are:'Primary', 'Alternative'

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

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

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

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

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

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

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

The user-provided first name associated with the address.

The user-provided last name associated with the address.

The user-provided phone number associated with the address.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

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.

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

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'.

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

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

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.

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

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

The user-provided first name associated with the address.

The user-provided last name associated with the address.

The user-provided phone number associated with the address.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

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

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

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

host url

application/json

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

EnvironmentId

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

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

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

The user-provided first name on the account.

The user-provided last name on the account.

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

The user's postal code.

The user's time zone.

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

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

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

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

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

The profile name, depending on profileType.

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

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

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

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

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

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

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

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

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

When the customer's password was last updated.

When the customer made their first purchase

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

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

The user-provided first name associated with the address.

The user-provided last name associated with the address.

The user-provided phone number associated with the address.

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

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

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

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

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

The eWallet checkout provider.

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

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

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'

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

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

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

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

The BIN display name.

The ISO country code associated with the BIN.

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

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

The BIN bank group.

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.

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

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

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

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

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'

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'

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

Currency code for the selected payment instrument.

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

Bank Identifier Code (BIC or SWIFT code)

The bank name

The bank zip code

The bank state

The bank ISO country

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

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

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.

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.

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

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

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

Acquiring institution identification code.

Acquiring institution country code

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

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

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

N/A

The hashed or encrypted credit card number.

First Name provided with the address

Last Name provided with the address

Phone Number provided with the address

The first row that was provided for the address.

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

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

The city that was provided for the address.

The state or province that was provided for the address.

The district that was provided for the address.

The postal code that was provided for the address.

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

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

Customer's IP address (provided by Merchant)

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.

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

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

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

TrackingId for the event

TimeStamp for the event

host url

application/json

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

EnvironmentId

A unique string identifying this Bank Event

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

Timestamp from Bank

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

Bank code on response

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

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

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

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

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

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

Used different PI than the one in Purchase

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

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

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

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

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

A unique string identifying the purchase

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

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

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

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

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)

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

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

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.

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

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.

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

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

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

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

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

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

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

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

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 for the event

TimeStamp for the event

host url

application/json

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

EnvironmentId

A unique string identifying this chargeback event

Reason provided by bank

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

Timestamp from Bank

The chargeback amount

Currency used for chargeback amount.

The original Purchase Id

A unique string identifying the User

TrackingId for the event

TimeStamp for the event

host url

user Id for label Api

application/json

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

EnvironmentId

The event name. Should be 'AP.Label'

The payload version. Should be "0.5"

The unique ID for each event/record.

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

TimeStamp for the event.

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

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

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

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

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

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

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

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

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

host url

application/json

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

EnvironmentId

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

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

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

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'

The specific LabelSource institution issuing the LabelReasonCodes.

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

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

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

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

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

TrackingId for the event

TimeStamp for the event

host url

application/json

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

EnvironmentId

A unique string identifying this refund event

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

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

Timestamp from Bank

The refund amount

Currency used for sales price amount.

A unique string identifying the User

The original Purchase Id

TrackingId for the event

TimeStamp for the event

host url

application/json

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

EnvironmentId

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

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

The DateTime when this status was applied

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 for the event

TimeStamp for the event

host url

application/json

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

EnvironmentId

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

The payload version. Should be "0.5"

The identifier of the Account Creation Status event.

The identifier of the Account Creation event.

TimeStamp for the event.

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

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

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

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

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

host url

application/json

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

EnvironmentId

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

The payload version. Should be "0.5"

The identifier of the Account Login Status event.

The identifier of the Account Login event.

TimeStamp for the event.

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

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

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

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

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