Fraudio Data Schema
info
Here is Fraudio's full data schema, containing all of the data fields that we use, along with other useful information such as data type, priority level (by product), field description, and the API Endpoint that uses that field.
The schema is organised by API endpoint, which enables you to quickly locate all relevant fields associated with each endpoint.
User guide
First, select the Fraudio product you're using:
- Payment Fraud Detection (for issuers)
- Payment Fraud Detection (for acquirers or payment processors)
- Merchant-Initiated Fraud Detection, or AML (Anti Money Laundering)
Filtering results
You can then optionally:
- Filter by API endpoint to show only the fields which relate to that endpoint
- Filter data fields by priority level
- Use the search bar to quickly find the information you need
- Sort by any column you'd like
Data Schema
Select Fraudio product:
API Endpoint | Field | Data Type | Payment Fraud (Acquirer / Processor) | Description |
---|---|---|---|---|
Payment Fraud Score | transactionid | String | Critical & Required | The unique identifier of the transaction event. Every transaction event, so auth , capture , auth_capture , etc., has its own unique ID. |
Payment Fraud Score | transactiontype | String | Critical & Required | The type of transaction event, for events that need to be scored. Possible values are: auth , auth_capture . Details about each possible value below.auth : An authorization is used to reserve funds on the customer's card without yet deducting them.auth_capture : A simultaneous combination of auth and capture in the same transaction, for when there is no need to perform these operations separately. |
Payment Fraud Score | timestamp | Double | Critical & Required | The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted. |
Payment Fraud Score | amount | Double | Critical & Required | The transaction amount in the unit specified by the 'currencyunit' field. Note: The unit used in this field should be explicitly stated in the 'currencyunit' field. |
Payment Fraud Score | currency | String | Critical & Required | The 3-digit ISO code for the currency used in the transaction. |
Payment Fraud Score | currencyunit | String | Critical & Required | This field defines the unit of currency used in the 'amount' field. Accepts only major (e.g., 12.30) or minor (e.g., 1230) unit values. This choice should align with the unit used in the 'amount' field. |
Payment Fraud Score | channel | String | Critical & Required | Indicates the specific type of channel used for a transaction. Accepted values with their description: - ecom : Ecommerce transaction, this is a card-not-present transaction done over the internet.- pos : Point of Sale transaction, also known as card-present.- moto : A mail or telephone order is a card-not-present transaction where the cardholder gives permission to process the transaction by providing order and payment details by mail (not email), fax, or telephone. |
Payment Fraud Score | customer | String | Critical & Required | The name of Fraudio's client that makes the API call. |
Payment Fraud Score | merchant | String | Critical & Required | The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted. |
Payment Fraud Score | mcccode | String | Critical & Required | A Merchant Category Code (MCC) is a four-digit number listed for financial services. An MCC is used to classify a business by the types of goods or services it provides. Only ISO 18245 mcc codes are accepted. |
Payment Fraud Score | cardbin | String | Critical & Required | The Bank Identification Number (BIN), also known as the Issuer Identification Number (IIN), is the first six or eight digits of the card number. |
Payment Fraud Score | responsecode | String | Critical & Required | The response code is a numerical code that indicates the outcome of authorization checks of issuing banks. The code must be a 2 character ISO8583-1987 response. |
Payment Fraud Score | success | String | Critical & Required | This indicates the overall result of the transaction: - true : - Transaction fully completed without any failures (both technical and non-technical).- false : Any part of the transaction failed or did not meet the necessary criteria, regardless of technical success.- none : The outcome of the transaction is uncertain or not yet known.Please use true only for fully successful transactions. Use false if there's any doubt or known issues, and none when outcome information is incomplete. |
Payment Fraud Score | acceptorcountry | String | Important | Countrycode of country where the card acceptor is located. Only ISO 3166-1 numeric country codes are accepted. |
Payment Fraud Score | acceptorip | String | Important | The acceptor IP address is the IP address of the card acceptor's terminal. For card-present transactions this terminal, which is used by the merchant to process payments, is typically located on the merchant's premises. |
Payment Fraud Score | avsresult | String | Important | AVS (Address Verification System) result is the outcome of a check performed for Card-not-Present and MOTO transactions on the billing address provided by the shopper to see if the provided address matches the address on file with the card issuer. This helps verify the identity of the shopper vs the actual cardholder. It is more likely that the shopper is the cardholder when the billing address details match. Accepted values are: - A: Addresses match/ZIP codes do not. - B: Street addresses match, but ZIP codes not verified due to incompatible formats. - C: Street address and postal/ZIP codes not verified due to incompatible formats. - D: Street addresses and postal/ZIP codes match (VISA). Customer name incorrect, ZIP codes match (AMEX / JCB). - E: Customer name incorrect, billing address and ZIP code match. - F: Street addresses and postal codes match (VISA). Customer name incorrect, billing address matches (AMEX / JCB). - G: Address information not verified for international transaction. - I: Address information not verified. - K: Customer name matches. - L: Customer name and ZIP code match. - M: Street addresses and postal/ZIP codes match. - N: No match. - O: Customer name and billing address match. - P: Postal/ZIP codes match. Acquirer sent both postal/ZIP code and street address, but street address not verified due to incompatible formats. - R: Retry: System unavailable or timed out. Issuer ordinarily performs address verification but was unavailable. - S: AVS not supported. - T: Nine-digit zip code matches, address does not match. - U: Information is unavailable. - W: For U.S. Addresses, nine-digit postal code matches, address does not. For address outside the U.S. postal code matches, address does not (MasterCard / Discover). Customer name, billing address, and postal code are all correct ( AMEX / JCB). - X: For U.S. addresses, nine-digit postal code and addresses matches. For addresses outside the U.S., postal code and address match. - Y: Street address and postal/ZIP match. - Z: Postal/ZIP match, street addresses do not match or street address not included in request. - none : Unknown. |
Payment Fraud Score | avsused | String | Important | Indicates if AVS (Address Verification System) is enabled. AVS checks are performed for Card-not-Present and MOTO transactions on the billing address provided by the shopper to see if the provided address matches the address on file with the card issuer. This helps verify the identity of the shopper vs the actual cardholder. It is more likely that the shopper is the cardholder when the billing address details match. Before authentication it can already be known whether AVS is enabled, the result (avsresult) will only be known after authentication. Accepted values are: - true : AVS enabled.- false : AVS disabled.- none : Unknown. |
Payment Fraud Score | cardexpirydate | String | Important | The expiry date of the card. Accepted format: MM/yy. |
Payment Fraud Score | cardtoken | String | Important | The card token is the encryption that is used to identify the credit card. Any salted hash is accepted. |
Payment Fraud Score | cavvresult | String | Important | The Cardholder Authentication Verification Value (CAVV) is a value that allows VISA to validate the integrity of the Verified by Visa (VbV) transaction data for VISA 3Ds transactions. Accepted values are: - 0: CAVV authentication results invalid, no verification performed. - 1: CAVV failed verification (authentication), Issuer approves authorization. - 2: CAVV passed verification (authentication), Issuer approves authorization. - 3: CAVV passed verification (attempt), Issuer approves authorization. - 4: CAVV failed verification (attempt), Issuer approves authorization. - 5: Not Used - Reserved. - 6: CAVV not verified (VisaNet flag for Issuer not selected), Issuer approves authorization. - 7: CAVV failed verification (attempt), Issuer approves authorization. - 8: CAVV passed verification (attempt), Issuer approves authorization. - 9: CAVV failed verification (attempt), Issuer approves authorization. - A: CAVV passed verification (attempt), Issuer approves authorization. - B: CAVV passed verification (authentication). - C: CAVV failed verification (attempt). - D: CAVV failed verification (authentication). - none : Unknown. |
Payment Fraud Score | cavvused | String | Important | Indicates if Cardholder Authentication Verification Value (CAVV) is enabled for the transaction. Before authentication it can already be known whether CAVV is enabled, the result (cavvresult) will only be known after authentication. Accepted values are: - true : CAVV enabled.- false : CAVV disabled.- none : Unknown. |
Payment Fraud Score | channelsubtype | String | Important | Indicates the subtype of channel used for a transaction. This is a subfield of channel. Accepted values with their description: - paymentlink : The payment is done using a link that is shared by the merchant, also known as PayByLink transactions.- telephoneorder : MoTo transactions where the order and payment details are provided by telephone.- mailorder : MoTo transactions where the order and payment details are provided by mail (not email).- none : Unknown. |
Payment Fraud Score | cvvresult | String | Important | Card Verification Value (CVV) result is the outcome of a check performed on the security code provided by the shopper to see if it matches the code on file with the card issuer. Accepted values: - M : CVV2 Match.- N : CVV2 No Match.- P : Not processed.- S : CVV2 should be on the card.- U : Issuer does not participate in CVV2 service, or participates but has not provided the encryption keys, or both.- X : No response from association.- none : Unknown. |
Payment Fraud Score | cvvused | String | Important | Indicates if Card Verification Value (CVV) checks are done for the transaction. Card Verification Value (CVV) checs are performed on the security code provided by the shopper to see if it matches the code on file with the card issuer. Before authentication it can already be known whether CVV is enabled, the result (cvvresult) will only be known after authentication. Accepted values are: - true : CVV checks are done.- false : CVV checks are not done.- none : Unknown. |
Payment Fraud Score | eci | String | Important | The Electronic Commerce Indicator (ECI) is the value indicating the outcome of 3D-Secure (3DS) authentication attempted on transactions where 3DS is enabled. Different card schemes use different values. Accepted values for Visa / American Express / JCB / Discover / Diners are: - 05 : Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.- 06 : Either cardholder or card issuing bank is not 3D enrolled.- 07 : Authentication is unsuccessful or not attempted.- none : Unknown.Accepted values for MasterCard are: - 02 : Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.- 01 : Either cardholder or card issuing bank is not 3D enrolled.- 00 : Authentication is unsuccessful or not attempted.- none : Unknown. |
Payment Fraud Score | lastfourdigits | String | Important | The last four digits of the card number. |
Payment Fraud Score | merchantcountry | String | Important | Countrycode of country where the merchant is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Fraud Score | merchantip | String | Important | The IP address of the merchant refers to the IP address where the merchant is registered. It is important to distinguish between the acceptor IP and the merchant IP. The acceptor IP is the location of the merchant's server where the payment is received. Therefore, a merchant can have multiple acceptor IPs, but only one merchant IP. |
Payment Fraud Score | mid | String | Important | The MID, or Merchant ID, is a unique identifier assigned to a merchant by their payment processor. It's important to note that the MID does not uniquely identify the merchant, but rather it identifies the merchant's account. This is because a merchant can have multiple MIDs, as they may have separate merchant accounts for different aspects of their business. |
Payment Fraud Score | parenttransactionid | String | Important | The identifier that links separate events of one transaction. The parenttransactionid can link auths with captures, voids and refunds and it can link auth_captures with refunds and voids. Any name or unique identifier is accepted. For example: In order to link a capture with an authorization, you need to specify the transactionid of the corresponding auth or auth_capture as the parenttransactionid |
Payment Fraud Score | posentrymode | String | Important | The Point of Sale (POS) entry mode is the code (3 digits) that identifies the method used to capture the PAN entry mode and the PIN entry capability. ISO 8583 (field 22) POS entry mode consists of 2 parts: 1. PAN (Primary Account Number) entry mode (the first 2 digits): - 00 : Unknown.- 01: Key entered / Manual. 02: Magnetic stripe. 03: Bar code. 05: ICC (integrated circuit card, that is, chip). 07: Auto entry via contactless EMV. 10: Merchant has Cardholder Credentials on File. 80: Fallback from integrated circuit card (ICC) to magnetic stripe. 81: Electronic commerce. 91: Auto entry via contactless magnetic stripe. 0: Unknown 1: Terminal can accept PINs. 2: Terminal cannot accept PINs. none`: Completely unknown posentrymode. |
Payment Fraud Score | recurring | String | Important | Indicates if the payment is recurring or not. Accepted values are true , false or none .- true : Is recurring.- false : is not recurring.- none : Unknown. |
Payment Fraud Score | threedsused | String | Important | Indicates if 3D-Secure (3DS) is enabled for the transaction. Before authentication it can already be known whether 3DS is enabled, the result (eci) will only be known after authentication. Accepted values are: - true : 3-D Secure has been used.- false : 3-D Secure has not been used.- none : Unknown. |
Payment Fraud Score | transactioncountry | String | Important | The country code of the shopper's device from which the card-not-present transaction is made. Only ISO 3166-1 numeric country codes are accepted. |
Payment Fraud Score | transactionip | String | Important | IP-address of the shopper's device with which the card-not-present transaction is made. |
Payment Fraud Score | gatewaydeclinereason | String | Important | The gateway decline reason is a code provided by the payment gateway indicating the reason for a declined transaction. Declinecodes differ from gateway to gateway, therefore the reason of the decline is preferred. Any declinereason is accepted. E.g. Application Incomplete, Duplicate, Fraud, Risk Thresholds, Card Disabled. |
Payment Fraud Score | shopperemail | String | Supplementary | The email address of the shopper. |
Payment Fraud Score | shoppername | String | Supplementary | The name or identifier of the shopper. Any name or unique identifier is accepted. |
Payment Fraud Score | shopperphonenumber | String | Supplementary | The phone number of the shopper. |
Payment Fraud Score | acceptorcity | String | Supplementary | City where the card acceptor is located. Any city name is accepted. |
Payment Fraud Score | acceptorid | String | Supplementary | The name or identifier of the acceptor. Any name or unique identifier is accepted. |
Payment Fraud Score | acceptorpostalcode | String | Supplementary | Postal code where the card acceptor is located. Any postal code is accepted. |
Payment Fraud Score | acceptorstatecode | String | Supplementary | State where the card acceptor is located. Any state code is accepted. |
Payment Fraud Score | acceptorstreetaddress | String | Supplementary | Street address where the card acceptor is located. Without acceptorip this field becomes important. Any street address is accepted. |
Payment Fraud Score | acquirer | String | Supplementary | The acquirer is a financial institution with whom the merchant has a bank account. |
Payment Fraud Score | acquirercountry | String | Supplementary | Countrycode of country where the acquirer is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Fraud Score | authresult | String | Supplementary | Indicates if the transaction successfully passed all authentication and authorization checks. Accepted values are: - fail: failed authentication and authorization. - success: successful authentication and authorization. - none : Unknown. |
Payment Fraud Score | cardaccess | String | Supplementary | Information on how the card was accessed. Accepted values are: - pinaccess: Card is accessed by using a pincode. - signatureaccess: Card is accessed by using a signature. - hybrid: Card is accessed by using a pincode and a signature. - none : Unknown. |
Payment Fraud Score | cardholder | String | Supplementary | The name or identifier of the cardholder. This is not the same as the cardtoken, as a cardholder can have multiple credit cards (cardtokens). Any name or unique identifier is accepted. |
Payment Fraud Score | cardholderemail | String | Supplementary | The email address of the card holder. |
Payment Fraud Score | cardholderphonenumber | String | Supplementary | The phone number of the card holder. |
Payment Fraud Score | ddresult | String | Supplementary | The dynamic descriptor result returned by the processor is the text that represents businesses on bank account statements. Can be up to 22 characters long. |
Payment Fraud Score | deviceid | String | Supplementary | The mobile device id or any other device id. Any id is accepted. |
Payment Fraud Score | deviceos | String | Supplementary | The operating system (os) of the mobile device. Any os is accepted. |
Payment Fraud Score | devicephonenumber | String | Supplementary | The phone number of the mobile device. Any phone number is accepted. |
Payment Fraud Score | initialrecurring | String | Supplementary | Indicates if the transaction is the first of a series of recurring transactions. Accepted values are: - true : The transaction is the first of a series of recurring transactions.- false : The transaction is not the first of a series of recurring transactions.- none : Unknown. |
Payment Fraud Score | merchantadvicecode | String | Supplementary | The merchant advice code is a code provided by the merchant's payment processor that indicates the reason for a declined transaction, and how it can be retried. |
Payment Fraud Score | merchantcity | String | Supplementary | City where the merchant is registered. Without merchantip this field becomes important. Any city is accepted. |
Payment Fraud Score | merchantpostalcode | String | Supplementary | Postal code where the merchant is registered. Without merchantip this field becomes important. Any postal code is accepted. |
Payment Fraud Score | merchantstatecode | String | Supplementary | State where the merchant is registered. Without merchantip this field becomes important. Any state code is accepted. |
Payment Fraud Score | merchantstreetaddress | String | Supplementary | Street address where the merchant is registered. Without merchantip this field becomes important. Any street address is accepted. |
Payment Fraud Score | processor | String | Supplementary | A payment processor is a company (often a third party) appointed by a merchant to handle transactions from various channels such as credit cards and debit cards for merchant acquiring banks. |
Payment Fraud Score | proxyused | String | Supplementary | Indicates whether a proxy server was used. |
Payment Fraud Score | recurringparentid | String | Supplementary | The identifier that links back to the initial recurring transaction (the first of a series of recurring transactions). |
Payment Fraud Score | submerchant | String | Supplementary | The name or identifier of the submerchant, which is a merchant that processes under a payment service provider or payment facilitator. These services use one merchant account to process the transactions of many sub-merchants, thereby eliminating the need for each sub-merchant to open and maintain a fully-fledged merchant account. Any name or unique identifier is accepted. |
Payment Fraud Score | terminaltype | String | Supplementary | The type of unattended POS terminal, also known as Cardholder-Activated Terminal (CAT) types. Accepted values are: - cat1: Automated Dispensing Machine - cat2: Self Service Terminal - cat3: Limited Amount Terminal - cat4: InFlight Terminal - cat6: Electronic Commerce - cat7: Transponder - cat9: MPOS (mobile POS) - none : Unknown. |
Payment Fraud Score | transactioncity | String | Supplementary | City of the shopper's device with which the card-not-present transaction is made |
Payment Fraud Score | transactionpostalcode | String | Supplementary | Postal code of the shopper's device with which the card-not-present transaction is made. |
Payment Fraud Score | transactionstatecode | String | Supplementary | State of the shopper's device with which the card-not-present transaction is made. |
Payment Fraud Score | transactionstreetaddress | String | Supplementary | Street address of the shopper's device with which the card-not-present transaction is made. |
Payment Fraud Score | ucafindicator | String | Supplementary | The Universal Cardholder Authentication (UCAF) indicator indicates to what extend the UCAF data collection is supported for MasterCard 3DS transactions. Accepted values are: - 0: UCAF data collection is not supported by the merchant. - 1: UCAF data collection is supported by the merchant, and UCAF data may be present and contain an attempted AAV. - 2: UCAF data collection is supported by the merchant and UCAF data must be present and contain a fully authenticated AAV. - none : Unknown. |
Payment Fraud Score | kyclevel | String | Supplementary | The Know-Your-Customer level of the merchant. Any indication level is accepted. |
Payment Fraud Score | limitprofile | String | Supplementary | The limit profile of a merchant is a set of limits imposed on the daily/weekly/monthly transaction amounts. A low limit profile number denotes low limits on all transactions. |
Payment Fraud Score | merchantemail | String | Supplementary | The email address of the merchant. |
Payment Fraud Score | merchantturnover | String | Supplementary | Expected monthly turnover (auths and authcaptures) to be processed through the merchant’s account in euros. |
Payment Fraud Score | merchanturl | String | Supplementary | URL of merchant web site or page where transaction took place. Any URL is accepted. |
Payment Fraud Score | registrationdate | Double | Supplementary | The time UTC at which the merchant got registered. Only Unix Timestamps are accepted. |
Payment Fraud Score | ubo | String | Supplementary | The full name of the Ultimate Beneficial Owner (UBO). The UBO is the individual that is registered as the owner of the merchant account. |
Payment Fraud Score | ubocountry | String | Supplementary | Countrycode of country where the ubo is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Fraud Score | gateway | String | Supplementary | A payment gateway is a merchant service that facilitates a payment transaction by the transfer of information between a payment portal (such as a website, mobile phone or interactive voice response service) and the front end processor or acquiring bank. |
Payment Fraud Score | iso | String | Supplementary | The full name of the Independent Sales Organisation (ISO) that accepts credit card payments for the merchant account that is in its portfolio. |
Payment Fraud Score | isocountry | String | Supplementary | The country of the ISO. |
Payment Fraud Score | kyclevelnorm | Double | Supplementary | A normalized know-your-customer level of the merchant between 0 and 1, where 0 is a totally unknown and untrusted merchant and 1 is a fully known and absolutely trusted merchant. |
Payment Fraud Score | ocptenabled | String | Supplementary | Indicates if ocpt is enabled for this merchant. When ocpt is enabled, payout back to the cardholder is supported. |
Payment Fraud Score | payfac | String | Supplementary | The full name of the Payment Facilitator that has the merchant account in its portfolio. |
Payment Fraud Score | payfaccountry | String | Supplementary | The country of the Payment Facilitator. |
Payment Fraud Score | uboemail | String | Supplementary | The email address of the ubo. |
Payment Fraud Score | ubophonenumber | String | Supplementary | The phone number of the ubo. |
Payment Fraud Score | ubostreetaddress | String | Supplementary | Street address where the ubo is registered. Without merchantip this field becomes important. Any street address is accepted. |
Payment Events Enrichment | transactionid | String | Critical & Required | The unique identifier of the transaction event. Every transaction event, so auth , capture , auth_capture , etc., has its own unique ID. |
Payment Events Enrichment | transactiontype | String | Critical & Required | The type of transaction event, for events that do not need scoring. Possible values are: auth , capture , auth_capture , refund , void , top_up , incremental_auth , atm or reversal . Details about each possible value below.auth : An authorization is used to reserve funds on the customer's card without yet deducting them.capture : A capture is used to immediately deduct authorised funds (up to the amount auth'd) from a customer's card. A capture should always be linked to at least one authorization via the parenttransactionid .auth_capture : A simultaneous combination of auth and capture in the same transaction, for when there is no need to perform these operations separately.refund : A refund transaction returns credit to a customer's payment method.void : A void transaction is the explicit discarding of authorization of funds.top_up : Increases the available credit of a credit card.incremental_auth : A transaction that increases the authorised amount of a confirmed auth transaction that has not yet been captured.atm : An automated teller machine (atm) transaction.reversal : A reversal annuls the transaction and re-credits the customer's payment method. This happens directly after the transaction has taken place but before the funds have been fully processed.none : Use only when the transactiontype is unknown. |
Payment Events Enrichment | timestamp | Double | Critical & Required | The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted. |
Payment Events Enrichment | amount | Double | Critical & Required | The transaction amount in the unit specified by the 'currencyunit' field. Note: The unit used in this field should be explicitly stated in the 'currencyunit' field. |
Payment Events Enrichment | currency | String | Critical & Required | The 3-digit ISO code for the currency used in the transaction. |
Payment Events Enrichment | currencyunit | String | Critical & Required | This field defines the unit of currency used in the 'amount' field. Accepts only major (e.g., 12.30) or minor (e.g., 1230) unit values. This choice should align with the unit used in the 'amount' field. |
Payment Events Enrichment | channel | String | Critical & Required | Indicates the specific type of channel used for a transaction. Accepted values with their description: - ecom : Ecommerce transaction, this is a card-not-present transaction done over the internet.- pos : Point of Sale transaction, also known as card-present.- moto : A mail or telephone order is a card-not-present transaction where the cardholder gives permission to process the transaction by providing order and payment details by mail (not email), fax, or telephone. |
Payment Events Enrichment | customer | String | Critical & Required | The name of Fraudio's client that makes the API call. |
Payment Events Enrichment | merchant | String | Critical & Required | The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted. |
Payment Events Enrichment | mcccode | String | Critical & Required | A Merchant Category Code (MCC) is a four-digit number listed for financial services. An MCC is used to classify a business by the types of goods or services it provides. Only ISO 18245 mcc codes are accepted. |
Payment Events Enrichment | cardbin | String | Critical & Required | The Bank Identification Number (BIN), also known as the Issuer Identification Number (IIN), is the first six or eight digits of the card number. |
Payment Events Enrichment | responsecode | String | Critical & Required | The response code is a numerical code that indicates the outcome of authorization checks of issuing banks. The code must be a 2 character ISO8583-1987 response. |
Payment Events Enrichment | success | String | Critical & Required | This indicates the overall result of the transaction: - true : - Transaction fully completed without any failures (both technical and non-technical).- false : Any part of the transaction failed or did not meet the necessary criteria, regardless of technical success.- none : The outcome of the transaction is uncertain or not yet known.Please use true only for fully successful transactions. Use false if there's any doubt or known issues, and none when outcome information is incomplete. |
Payment Events Enrichment | acceptorcountry | String | Important | Countrycode of country where the card acceptor is located. Only ISO 3166-1 numeric country codes are accepted. |
Payment Events Enrichment | acceptorip | String | Important | The acceptor IP address is the IP address of the card acceptor's terminal. For card-present transactions this terminal, which is used by the merchant to process payments, is typically located on the merchant's premises. |
Payment Events Enrichment | avsresult | String | Important | AVS (Address Verification System) result is the outcome of a check performed for Card-not-Present and MOTO transactions on the billing address provided by the shopper to see if the provided address matches the address on file with the card issuer. This helps verify the identity of the shopper vs the actual cardholder. It is more likely that the shopper is the cardholder when the billing address details match. Accepted values are: - A: Addresses match/ZIP codes do not. - B: Street addresses match, but ZIP codes not verified due to incompatible formats. - C: Street address and postal/ZIP codes not verified due to incompatible formats. - D: Street addresses and postal/ZIP codes match (VISA). Customer name incorrect, ZIP codes match (AMEX / JCB). - E: Customer name incorrect, billing address and ZIP code match. - F: Street addresses and postal codes match (VISA). Customer name incorrect, billing address matches (AMEX / JCB). - G: Address information not verified for international transaction. - I: Address information not verified. - K: Customer name matches. - L: Customer name and ZIP code match. - M: Street addresses and postal/ZIP codes match. - N: No match. - O: Customer name and billing address match. - P: Postal/ZIP codes match. Acquirer sent both postal/ZIP code and street address, but street address not verified due to incompatible formats. - R: Retry: System unavailable or timed out. Issuer ordinarily performs address verification but was unavailable. - S: AVS not supported. - T: Nine-digit zip code matches, address does not match. - U: Information is unavailable. - W: For U.S. Addresses, nine-digit postal code matches, address does not. For address outside the U.S. postal code matches, address does not (MasterCard / Discover). Customer name, billing address, and postal code are all correct ( AMEX / JCB). - X: For U.S. addresses, nine-digit postal code and addresses matches. For addresses outside the U.S., postal code and address match. - Y: Street address and postal/ZIP match. - Z: Postal/ZIP match, street addresses do not match or street address not included in request. - none : Unknown. |
Payment Events Enrichment | avsused | String | Important | Indicates if AVS (Address Verification System) is enabled. AVS checks are performed for Card-not-Present and MOTO transactions on the billing address provided by the shopper to see if the provided address matches the address on file with the card issuer. This helps verify the identity of the shopper vs the actual cardholder. It is more likely that the shopper is the cardholder when the billing address details match. Before authentication it can already be known whether AVS is enabled, the result (avsresult) will only be known after authentication. Accepted values are: - true : AVS enabled.- false : AVS disabled.- none : Unknown. |
Payment Events Enrichment | cardexpirydate | String | Important | The expiry date of the card. Accepted format: MM/yy. |
Payment Events Enrichment | cardtoken | String | Important | The card token is the encryption that is used to identify the credit card. Any salted hash is accepted. |
Payment Events Enrichment | cavvresult | String | Important | The Cardholder Authentication Verification Value (CAVV) is a value that allows VISA to validate the integrity of the Verified by Visa (VbV) transaction data for VISA 3Ds transactions. Accepted values are: - 0: CAVV authentication results invalid, no verification performed. - 1: CAVV failed verification (authentication), Issuer approves authorization. - 2: CAVV passed verification (authentication), Issuer approves authorization. - 3: CAVV passed verification (attempt), Issuer approves authorization. - 4: CAVV failed verification (attempt), Issuer approves authorization. - 5: Not Used - Reserved. - 6: CAVV not verified (VisaNet flag for Issuer not selected), Issuer approves authorization. - 7: CAVV failed verification (attempt), Issuer approves authorization. - 8: CAVV passed verification (attempt), Issuer approves authorization. - 9: CAVV failed verification (attempt), Issuer approves authorization. - A: CAVV passed verification (attempt), Issuer approves authorization. - B: CAVV passed verification (authentication). - C: CAVV failed verification (attempt). - D: CAVV failed verification (authentication). - none : Unknown. |
Payment Events Enrichment | cavvused | String | Important | Indicates if Cardholder Authentication Verification Value (CAVV) is enabled for the transaction. Before authentication it can already be known whether CAVV is enabled, the result (cavvresult) will only be known after authentication. Accepted values are: - true : CAVV enabled.- false : CAVV disabled.- none : Unknown. |
Payment Events Enrichment | channelsubtype | String | Important | Indicates the subtype of channel used for a transaction. This is a subfield of channel. Accepted values with their description: - paymentlink : The payment is done using a link that is shared by the merchant, also known as PayByLink transactions.- telephoneorder : MoTo transactions where the order and payment details are provided by telephone.- mailorder : MoTo transactions where the order and payment details are provided by mail (not email).- none : Unknown. |
Payment Events Enrichment | cvvresult | String | Important | Card Verification Value (CVV) result is the outcome of a check performed on the security code provided by the shopper to see if it matches the code on file with the card issuer. Accepted values: - M : CVV2 Match.- N : CVV2 No Match.- P : Not processed.- S : CVV2 should be on the card.- U : Issuer does not participate in CVV2 service, or participates but has not provided the encryption keys, or both.- X : No response from association.- none : Unknown. |
Payment Events Enrichment | cvvused | String | Important | Indicates if Card Verification Value (CVV) checks are done for the transaction. Card Verification Value (CVV) checs are performed on the security code provided by the shopper to see if it matches the code on file with the card issuer. Before authentication it can already be known whether CVV is enabled, the result (cvvresult) will only be known after authentication. Accepted values are: - true : CVV checks are done.- false : CVV checks are not done.- none : Unknown. |
Payment Events Enrichment | eci | String | Important | The Electronic Commerce Indicator (ECI) is the value indicating the outcome of 3D-Secure (3DS) authentication attempted on transactions where 3DS is enabled. Different card schemes use different values. Accepted values for Visa / American Express / JCB / Discover / Diners are: - 05 : Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.- 06 : Either cardholder or card issuing bank is not 3D enrolled.- 07 : Authentication is unsuccessful or not attempted.- none : Unknown.Accepted values for MasterCard are: - 02 : Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful.- 01 : Either cardholder or card issuing bank is not 3D enrolled.- 00 : Authentication is unsuccessful or not attempted.- none : Unknown. |
Payment Events Enrichment | lastfourdigits | String | Important | The last four digits of the card number. |
Payment Events Enrichment | merchantcountry | String | Important | Countrycode of country where the merchant is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Events Enrichment | merchantip | String | Important | The IP address of the merchant refers to the IP address where the merchant is registered. It is important to distinguish between the acceptor IP and the merchant IP. The acceptor IP is the location of the merchant's server where the payment is received. Therefore, a merchant can have multiple acceptor IPs, but only one merchant IP. |
Payment Events Enrichment | mid | String | Important | The MID, or Merchant ID, is a unique identifier assigned to a merchant by their payment processor. It's important to note that the MID does not uniquely identify the merchant, but rather it identifies the merchant's account. This is because a merchant can have multiple MIDs, as they may have separate merchant accounts for different aspects of their business. |
Payment Events Enrichment | parenttransactionid | String | Important | The identifier that links separate events of one transaction. The parenttransactionid can link auths with captures, voids and refunds and it can link auth_captures with refunds and voids. Any name or unique identifier is accepted. For example: In order to link a capture with an authorization, you need to specify the transactionid of the corresponding auth or auth_capture as the parenttransactionid |
Payment Events Enrichment | posentrymode | String | Important | The Point of Sale (POS) entry mode is the code (3 digits) that identifies the method used to capture the PAN entry mode and the PIN entry capability. ISO 8583 (field 22) POS entry mode consists of 2 parts: 1. PAN (Primary Account Number) entry mode (the first 2 digits): - 00 : Unknown.- 01: Key entered / Manual. 02: Magnetic stripe. 03: Bar code. 05: ICC (integrated circuit card, that is, chip). 07: Auto entry via contactless EMV. 10: Merchant has Cardholder Credentials on File. 80: Fallback from integrated circuit card (ICC) to magnetic stripe. 81: Electronic commerce. 91: Auto entry via contactless magnetic stripe. 0: Unknown 1: Terminal can accept PINs. 2: Terminal cannot accept PINs. none`: Completely unknown posentrymode. |
Payment Events Enrichment | recurring | String | Important | Indicates if the payment is recurring or not. Accepted values are true , false or none .- true : Is recurring.- false : is not recurring.- none : Unknown. |
Payment Events Enrichment | threedsused | String | Important | Indicates if 3D-Secure (3DS) is enabled for the transaction. Before authentication it can already be known whether 3DS is enabled, the result (eci) will only be known after authentication. Accepted values are: - true : 3-D Secure has been used.- false : 3-D Secure has not been used.- none : Unknown. |
Payment Events Enrichment | transactioncountry | String | Important | The country code of the shopper's device from which the card-not-present transaction is made. Only ISO 3166-1 numeric country codes are accepted. |
Payment Events Enrichment | transactionip | String | Important | IP-address of the shopper's device with which the card-not-present transaction is made. |
Payment Events Enrichment | gatewaydeclinereason | String | Important | The gateway decline reason is a code provided by the payment gateway indicating the reason for a declined transaction. Declinecodes differ from gateway to gateway, therefore the reason of the decline is preferred. Any declinereason is accepted. E.g. Application Incomplete, Duplicate, Fraud, Risk Thresholds, Card Disabled. |
Payment Events Enrichment | shopperemail | String | Supplementary | The email address of the shopper. |
Payment Events Enrichment | shoppername | String | Supplementary | The name or identifier of the shopper. Any name or unique identifier is accepted. |
Payment Events Enrichment | shopperphonenumber | String | Supplementary | The phone number of the shopper. |
Payment Events Enrichment | acceptorcity | String | Supplementary | City where the card acceptor is located. Any city name is accepted. |
Payment Events Enrichment | acceptorid | String | Supplementary | The name or identifier of the acceptor. Any name or unique identifier is accepted. |
Payment Events Enrichment | acceptorpostalcode | String | Supplementary | Postal code where the card acceptor is located. Any postal code is accepted. |
Payment Events Enrichment | acceptorstatecode | String | Supplementary | State where the card acceptor is located. Any state code is accepted. |
Payment Events Enrichment | acceptorstreetaddress | String | Supplementary | Street address where the card acceptor is located. Without acceptorip this field becomes important. Any street address is accepted. |
Payment Events Enrichment | acquirer | String | Supplementary | The acquirer is a financial institution with whom the merchant has a bank account. |
Payment Events Enrichment | acquirercountry | String | Supplementary | Countrycode of country where the acquirer is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Events Enrichment | authresult | String | Supplementary | Indicates if the transaction successfully passed all authentication and authorization checks. Accepted values are: - fail: failed authentication and authorization. - success: successful authentication and authorization. - none : Unknown. |
Payment Events Enrichment | cardaccess | String | Supplementary | Information on how the card was accessed. Accepted values are: - pinaccess: Card is accessed by using a pincode. - signatureaccess: Card is accessed by using a signature. - hybrid: Card is accessed by using a pincode and a signature. - none : Unknown. |
Payment Events Enrichment | cardholder | String | Supplementary | The name or identifier of the cardholder. This is not the same as the cardtoken, as a cardholder can have multiple credit cards (cardtokens). Any name or unique identifier is accepted. |
Payment Events Enrichment | cardholderemail | String | Supplementary | The email address of the card holder. |
Payment Events Enrichment | cardholderphonenumber | String | Supplementary | The phone number of the card holder. |
Payment Events Enrichment | ddresult | String | Supplementary | The dynamic descriptor result returned by the processor is the text that represents businesses on bank account statements. Can be up to 22 characters long. |
Payment Events Enrichment | deviceid | String | Supplementary | The mobile device id or any other device id. Any id is accepted. |
Payment Events Enrichment | deviceos | String | Supplementary | The operating system (os) of the mobile device. Any os is accepted. |
Payment Events Enrichment | devicephonenumber | String | Supplementary | The phone number of the mobile device. Any phone number is accepted. |
Payment Events Enrichment | initialrecurring | String | Supplementary | Indicates if the transaction is the first of a series of recurring transactions. Accepted values are: - true : The transaction is the first of a series of recurring transactions.- false : The transaction is not the first of a series of recurring transactions.- none : Unknown. |
Payment Events Enrichment | merchantadvicecode | String | Supplementary | The merchant advice code is a code provided by the merchant's payment processor that indicates the reason for a declined transaction, and how it can be retried. |
Payment Events Enrichment | merchantcity | String | Supplementary | City where the merchant is registered. Without merchantip this field becomes important. Any city is accepted. |
Payment Events Enrichment | merchantpostalcode | String | Supplementary | Postal code where the merchant is registered. Without merchantip this field becomes important. Any postal code is accepted. |
Payment Events Enrichment | merchantstatecode | String | Supplementary | State where the merchant is registered. Without merchantip this field becomes important. Any state code is accepted. |
Payment Events Enrichment | merchantstreetaddress | String | Supplementary | Street address where the merchant is registered. Without merchantip this field becomes important. Any street address is accepted. |
Payment Events Enrichment | processor | String | Supplementary | A payment processor is a company (often a third party) appointed by a merchant to handle transactions from various channels such as credit cards and debit cards for merchant acquiring banks. |
Payment Events Enrichment | proxyused | String | Supplementary | Indicates whether a proxy server was used. |
Payment Events Enrichment | recurringparentid | String | Supplementary | The identifier that links back to the initial recurring transaction (the first of a series of recurring transactions). |
Payment Events Enrichment | submerchant | String | Supplementary | The name or identifier of the submerchant, which is a merchant that processes under a payment service provider or payment facilitator. These services use one merchant account to process the transactions of many sub-merchants, thereby eliminating the need for each sub-merchant to open and maintain a fully-fledged merchant account. Any name or unique identifier is accepted. |
Payment Events Enrichment | terminaltype | String | Supplementary | The type of unattended POS terminal, also known as Cardholder-Activated Terminal (CAT) types. Accepted values are: - cat1: Automated Dispensing Machine - cat2: Self Service Terminal - cat3: Limited Amount Terminal - cat4: InFlight Terminal - cat6: Electronic Commerce - cat7: Transponder - cat9: MPOS (mobile POS) - none : Unknown. |
Payment Events Enrichment | transactioncity | String | Supplementary | City of the shopper's device with which the card-not-present transaction is made |
Payment Events Enrichment | transactionpostalcode | String | Supplementary | Postal code of the shopper's device with which the card-not-present transaction is made. |
Payment Events Enrichment | transactionstatecode | String | Supplementary | State of the shopper's device with which the card-not-present transaction is made. |
Payment Events Enrichment | transactionstreetaddress | String | Supplementary | Street address of the shopper's device with which the card-not-present transaction is made. |
Payment Events Enrichment | ucafindicator | String | Supplementary | The Universal Cardholder Authentication (UCAF) indicator indicates to what extend the UCAF data collection is supported for MasterCard 3DS transactions. Accepted values are: - 0: UCAF data collection is not supported by the merchant. - 1: UCAF data collection is supported by the merchant, and UCAF data may be present and contain an attempted AAV. - 2: UCAF data collection is supported by the merchant and UCAF data must be present and contain a fully authenticated AAV. - none : Unknown. |
Payment Events Enrichment | kyclevel | String | Supplementary | The Know-Your-Customer level of the merchant. Any indication level is accepted. |
Payment Events Enrichment | limitprofile | String | Supplementary | The limit profile of a merchant is a set of limits imposed on the daily/weekly/monthly transaction amounts. A low limit profile number denotes low limits on all transactions. |
Payment Events Enrichment | merchantemail | String | Supplementary | The email address of the merchant. |
Payment Events Enrichment | merchantturnover | String | Supplementary | Expected monthly turnover (auths and authcaptures) to be processed through the merchant’s account in euros. |
Payment Events Enrichment | merchanturl | String | Supplementary | URL of merchant web site or page where transaction took place. Any URL is accepted. |
Payment Events Enrichment | registrationdate | Double | Supplementary | The time UTC at which the merchant got registered. Only Unix Timestamps are accepted. |
Payment Events Enrichment | ubo | String | Supplementary | The full name of the Ultimate Beneficial Owner (UBO). The UBO is the individual that is registered as the owner of the merchant account. |
Payment Events Enrichment | ubocountry | String | Supplementary | Countrycode of country where the ubo is registered. Only ISO 3166-1 numeric country codes are accepted. |
Payment Events Enrichment | gateway | String | Supplementary | A payment gateway is a merchant service that facilitates a payment transaction by the transfer of information between a payment portal (such as a website, mobile phone or interactive voice response service) and the front end processor or acquiring bank. |
Payment Events Enrichment | iso | String | Supplementary | The full name of the Independent Sales Organisation (ISO) that accepts credit card payments for the merchant account that is in its portfolio. |
Payment Events Enrichment | isocountry | String | Supplementary | The country of the ISO. |
Payment Events Enrichment | kyclevelnorm | Double | Supplementary | A normalized know-your-customer level of the merchant between 0 and 1, where 0 is a totally unknown and untrusted merchant and 1 is a fully known and absolutely trusted merchant. |
Payment Events Enrichment | ocptenabled | String | Supplementary | Indicates if ocpt is enabled for this merchant. When ocpt is enabled, payout back to the cardholder is supported. |
Payment Events Enrichment | payfac | String | Supplementary | The full name of the Payment Facilitator that has the merchant account in its portfolio. |
Payment Events Enrichment | payfaccountry | String | Supplementary | The country of the Payment Facilitator. |
Payment Events Enrichment | uboemail | String | Supplementary | The email address of the ubo. |
Payment Events Enrichment | ubophonenumber | String | Supplementary | The phone number of the ubo. |
Payment Events Enrichment | ubostreetaddress | String | Supplementary | Street address where the ubo is registered. Without merchantip this field becomes important. Any street address is accepted. |
Payment Post-Authorization Enrichment | transactionid | String | Critical & Required | The unique identifier of the transaction event. Every transaction event, so auth , capture , auth_capture , etc., has its own unique ID. |
Payment Post-Authorization Enrichment | timestamp | Double | Critical & Required | The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted. |
Payment Post-Authorization Enrichment | transactiontype | String | Critical & Required | The type of transaction event. Possible values are: auth , capture , auth_capture , refund , void , top_up , incremental_auth , atm or reversal . Details about each possible value below.auth : An authorization is used to reserve funds on the customer's card without yet deducting them.capture : A capture is used to immediately deduct authorised funds (up to the amount auth'd) from a customer's card. A capture should always be linked to at least one authorization via the parenttransactionid .auth_capture : A simultaneous combination of auth and capture in the same transaction, for when there is no need to perform these operations separately.refund : A refund transaction returns credit to a customer's payment method.void : A void transaction is the explicit discarding of authorization of funds.top_up : Increases the available credit of a credit card.incremental_auth : A transaction that increases the authorised amount of a confirmed auth transaction that has not yet been captured.atm : An automated teller machine (atm) transaction.reversal : A reversal annuls the transaction and re-credits the customer's payment method. This happens directly after the transaction has taken place but before the funds have been fully processed.none : Use only when the transactiontype is unknown. |
Payment Post-Authorization Enrichment | customer | String | Critical & Required | The name of Fraudio's client that makes the API call. |
Payment Post-Authorization Enrichment | success | String | Critical & Required | This indicates the overall result of the transaction: - true : - Transaction fully completed without any failures (both technical and non-technical).- false : Any part of the transaction failed or did not meet the necessary criteria, regardless of technical success.- none : The outcome of the transaction is uncertain or not yet known.Please use true only for fully successful transactions. Use false if there's any doubt or known issues, and none when outcome information is incomplete. |
Payment Post-Authorization Enrichment | responsecode | String | Critical & Required | The response code is a numerical code that indicates the outcome of authorization checks of issuing banks. The code must be a 2 character ISO8583-1987 response. |
Payment Post-Authorization Enrichment | avsresult | String | Important | AVS (Address Verification System) result is the outcome of a check performed for Card-not-Present and MOTO transactions on the billing address provided by the shopper to see if the provided address matches the address on file with the card issuer. This helps verify the identity of the shopper vs the actual cardholder. It is more likely that the shopper is the cardholder when the billing address details match. Accepted values are: - A: Addresses match/ZIP codes do not. - B: Street addresses match, but ZIP codes not verified due to incompatible formats. - C: Street address and postal/ZIP codes not verified due to incompatible formats. - D: Street addresses and postal/ZIP codes match (VISA). Customer name incorrect, ZIP codes match (AMEX / JCB). - E: Customer name incorrect, billing address and ZIP code match. - F: Street addresses and postal codes match (VISA). Customer name incorrect, billing address matches (AMEX / JCB). - G: Address information not verified for international transaction. - I: Address information not verified. - K: Customer name matches. - L: Customer name and ZIP code match. - M: Street addresses and postal/ZIP codes match. - N: No match. - O: Customer name and billing address match. - P: Postal/ZIP codes match. Acquirer sent both postal/ZIP code and street address, but street address not verified due to incompatible formats. - R: Retry: System unavailable or timed out. Issuer ordinarily performs address verification but was unavailable. - S: AVS not supported. - T: Nine-digit zip code matches, address does not match. - U: Information is unavailable. - W: For U.S. Addresses, nine-digit postal code matches, address does not. For address outside the U.S. postal code matches, address does not (MasterCard / Discover). Customer name, billing address, and postal code are all correct ( AMEX / JCB). - X: For U.S. addresses, nine-digit postal code and addresses matches. For addresses outside the U.S., postal code and address match. - Y: Street address and postal/ZIP match. - Z: Postal/ZIP match, street addresses do not match or street address not included in request. - none : Unknown. |
Payment Post-Authorization Enrichment | authresult | String | Supplementary | Indicates if the transaction successfully passed all authentication and authorization checks. Accepted values are: - fail: failed authentication and authorization. - success: successful authentication and authorization. - none : Unknown. |
Payment Post-Authorization Enrichment | cavvresult | String | Important | The Cardholder Authentication Verification Value (CAVV) is a value that allows VISA to validate the integrity of the Verified by Visa (VbV) transaction data for VISA 3Ds transactions. Accepted values are: - 0: CAVV authentication results invalid, no verification performed. - 1: CAVV failed verification (authentication), Issuer approves authorization. - 2: CAVV passed verification (authentication), Issuer approves authorization. - 3: CAVV passed verification (attempt), Issuer approves authorization. - 4: CAVV failed verification (attempt), Issuer approves authorization. - 5: Not Used - Reserved. - 6: CAVV not verified (VisaNet flag for Issuer not selected), Issuer approves authorization. - 7: CAVV failed verification (attempt), Issuer approves authorization. - 8: CAVV passed verification (attempt), Issuer approves authorization. - 9: CAVV failed verification (attempt), Issuer approves authorization. - A: CAVV passed verification (attempt), Issuer approves authorization. - B: CAVV passed verification (authentication). - C: CAVV failed verification (attempt). - D: CAVV failed verification (authentication). - none : Unknown. |
Payment Post-Authorization Enrichment | cvvresult | String | Important | Card Verification Value (CVV) result is the outcome of a check performed on the security code provided by the shopper to see if it matches the code on file with the card issuer. Accepted values: - M: CVV2 Match. - N: CVV2 No Match. - P: Not processed. - S: CVV2 should be on the card. - U: Issuer does not participate in CVV2 service, or participates but has not provided the encryption keys, or both. - X: No response from association. - none : Unknown. |
Payment Post-Authorization Enrichment | ddresult | String | Supplementary | The dynamic descriptor result returned by the processor is the text that represents businesses on bank account statements. Can be up to 22 characters long. |
Payment Post-Authorization Enrichment | eci | String | Important | The Electronic Commerce Indicator (ECI) is the value indicating the outcome of 3D-Secure (3DS) authentication attempted on transactions where 3DS is enabled. Different card schemes use different values. Accepted values for Visa / American Express / JCB / Discover / Diners are: - 05: Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful. - 06: Either cardholder or card issuing bank is not 3D enrolled. - 07: Authentication is unsuccessful or not attempted. - none : Unknown.Accepted values for MasterCard are: - 02: Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful. - 01: Either cardholder or card issuing bank is not 3D enrolled. - 00: Authentication is unsuccessful or not attempted. - none : Unknown. |
Payment Post-Authorization Enrichment | gatewaydeclinereason | String | Important | The gateway decline reason is a code provided by the payment gateway indicating the reason for a declined transaction. Declinecodes differ from gateway to gateway, therefore the reason of the decline is preferred. Any declinereason is accepted. E.g. Application Incomplete, Duplicate, Fraud, Risk Thresholds, Card Disabled. |
Payment Post-Authorization Enrichment | merchantadvicecode | String | Supplementary | The merchant advice code is a code provided by the merchant's payment processor that indicates the reason for a declined transaction, and how it can be retried. |
Payment Post-Authorization Enrichment | ucafindicator | String | Supplementary | The Universal Cardholder Authentication (UCAF) indicator indicates to what extend the UCAF data collection is supported for MasterCard 3DS transactions. Accepted values are: - 0: UCAF data collection is not supported by the merchant. - 1: UCAF data collection is supported by the merchant, and UCAF data may be present and contain an attempted AAV. - 2: UCAF data collection is supported by the merchant and UCAF data must be present and contain a fully authenticated AAV. - none : Unknown. |
Fraud Notifications Enrichment | transactionid | String | Critical & Required | The unique identifier of the transaction event. Every transaction event, so auth , capture , auth_capture , etc., has its own unique ID. |
Fraud Notifications Enrichment | timestamp | Double | Critical & Required | The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted. |
Fraud Notifications Enrichment | reporttype | String | Critical & Required | The type of fraud report. Some possible values are fraud notification, 1st chargeback, information supplied, reversed chargeback, pre-arbitration, 2nd chargeback. Please note: 1st chargebacks and fraud notifications are the priority here, especially during integration! Details about each possible value below. - fraud notification: Fraud activity reported by the (cardholder's) bank. Examples are Visa's TC40 files and MasterCard's SAFE files. - 1st chargeback: First stage of the chargeback where the disputed amount is withdrawn from the merchant's account. - information supplied: Defense documents against the 1st chargeback are supplied. - reversed chargeback: The disputed amount is transferred back to the merchant's account. - pre-arbitration: Card scheme evaluates the defense. - 2nd chargeback: 2nd and definite chargeback where the disputed amount is withdrawn from the merchant's account. |
Fraud Notifications Enrichment | merchant | String | Critical & Required | The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted. |
Fraud Notifications Enrichment | chargebackreason | String | Critical & Required | Reason for the chargeback. |
Fraud Notifications Enrichment | fraudimportdate | Double | Important | Timestamp when a dispute was opened. |
Fraud Notifications Enrichment | chargebackid | String | Supplementary | External ID of this chargeback, unique for the customer. |
Fraud Notifications Enrichment | fraudreason | String | Supplementary | Reason why the transaction was fraudulent. |
Merchant Account Information | merchant | String | Supplementary | The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted. |
Merchant Account Information | mcccode | String | Supplementary | A Merchant Category Code (MCC) is a four-digit number listed for financial services. An MCC is used to classify a business by the types of goods or services it provides. Only ISO 18245 mcc codes are accepted. |
Merchant Account Information | acquirer | String | Supplementary | The acquirer is a financial institution with whom the merchant has a bank account. |
Merchant Account Information | acquirercountry | String | Supplementary | Countrycode of country where the acquirer is registered. Only ISO 3166-1 numeric country codes are accepted. |
Merchant Account Information | merchantcity | String | Supplementary | City where the merchant is registered. Without merchantip this field becomes important. Any city is accepted. |
Merchant Account Information | merchantcountry | String | Supplementary | Countrycode of country where the merchant is registered.Only ISO 3166-1 numeric country codes are accepted |
Merchant Account Information | merchantip | String | Supplementary | The IP address of the merchant refers to the IP address where the merchant is registered. It is important to distinguish between the acceptor IP and the merchant IP. The acceptor IP is the location of the merchant's server where the payment is received. Therefore, a merchant can have multiple acceptor IPs, but only one merchant IP. |
Merchant Account Information | merchantpostalcode | String | Supplementary | Postal code where the merchant is registered. Without merchantip this field becomes important. Any postal code is accepted. |
Merchant Account Information | merchantstatecode | String | Supplementary | State where the merchant is registered. Without merchantip this field becomes important. Any state code is accepted. |
Merchant Account Information | merchantstreetaddress | String | Supplementary | Street address where the merchant is registered. Without merchantip this field becomes important. Any street address is accepted. |
Merchant Account Information | mid | String | Supplementary | The MID, or Merchant ID, is a unique identifier assigned to a merchant by their payment processor. It's important to note that the MID does not uniquely identify the merchant, but rather it identifies the merchant's account. This is because a merchant can have multiple MIDs, as they may have separate merchant accounts for different aspects of their business. |
Merchant Account Information | submerchant | String | Supplementary | The name or identifier of the submerchant, which is a merchant that processes under a payment service provider or payment facilitator. These services use one merchant account to process the transactions of many sub-merchants, thereby eliminating the need for each sub-merchant to open and maintain a fully-fledged merchant account. Any name or unique identifier is accepted. |
Merchant Account Information | iso | String | Supplementary | The full name of the Independent Sales Organisation (ISO) that accepts credit card payments for the merchant account that is in its portfolio. |
Merchant Account Information | isocountry | String | Supplementary | The country of the ISO. |
Merchant Account Information | kyclevel | String | Supplementary | The Know-Your-Customer level of the merchant. Any indication level is accepted. |
Merchant Account Information | kyclevelnorm | Double | Supplementary | A normalized know-your-customer level of the merchant between 0 and 1, where 0 is a totally unknown and untrusted merchant and 1 is a fully known and absolutely trusted merchant. |
Merchant Account Information | limitprofile | String | Supplementary | The limit profile of a merchant is a set of limits imposed on the daily/weekly/monthly transaction amounts. A low limit profile number denotes low limits on all transactions. |
Merchant Account Information | merchantemail | String | Supplementary | The email address of the merchant. |
Merchant Account Information | merchantturnover | String | Supplementary | Expected monthly turnover (auths and authcaptures) to be processed through the merchant’s account in euros. |
Merchant Account Information | merchanturl | String | Supplementary | URL of merchant web site or page where transaction took place. Any URL is accepted. |
Merchant Account Information | ocptenabled | String | Supplementary | Indicates if ocpt is enabled for this merchant. When ocpt is enabled, payout back to the cardholder is supported. |
Merchant Account Information | payfac | String | Supplementary | The full name of the Payment Facilitator that has the merchant account in its portfolio. |
Merchant Account Information | payfaccountry | String | Supplementary | The country of the Payment Facilitator. |
Merchant Account Information | registrationdate | Double | Supplementary | The time UTC at which the merchant got registered. Only Unix Timestamps are accepted. |
Merchant Account Information | ubo | String | Supplementary | The full name of the Ultimate Beneficial Owner (UBO). The UBO is the individual that is registered as the owner of the merchant account. |
Merchant Account Information | ubocountry | String | Supplementary | Countrycode of country where the ubo is registered. Only ISO 3166-1 numeric country codes are accepted. |
Merchant Account Information | uboemail | String | Supplementary | The email address of the ubo. |
Merchant Account Information | ubophonenumber | String | Supplementary | The phone number of the ubo. |
Merchant Account Information | ubostreetaddress | String | Supplementary | Street address where the ubo is registered. Without merchantip this field becomes important. Any street address is accepted. |