{ "types": [ { "Name": "ShoppingCartItem", "Description": "An object representing an item in the shopping cart of the customer.", "Fields": [ { "Name": "item_id", "DisplayName": "Item ID", "Type": "string", "Description": "The ID of the item. May be identical for items within one category or group, e.g. all polo shirts of one brand have one item ID.", "Examples": [ "5586463" ], "Group": "" }, { "Name": "unique_item_id", "DisplayName": "Unique item ID", "Type": "string", "Description": "The unique ID of the item. Always unique for one item. For example, the red polo shirt of one brand has its own unique ID.", "Examples": [ "NAK1237005000003" ], "Group": "" }, { "Name": "item_desc", "DisplayName": "Item description", "Type": "string", "Description": "The description of the item, for example the category or group the item belongs to.", "Examples": [ "Laufschuhe AltaRun für Jungen" ], "Group": "" }, { "Name": "additional_description", "DisplayName": "Additional item description", "Type": "string", "Description": "Any additional details about the item, for example color, size, etc.", "Examples": [ "Red | One Size" ], "Group": "" }, { "Name": "item_amt", "DisplayName": "Amount paid", "Type": "float", "Description": "The amount paid for the item in the currency of the transaction.", "Group": "" }, { "Name": "discount", "DisplayName": "Discount", "Type": "float", "Description": "The discount applied to the item in the currency of the transaction.", "Group": "" }, { "Name": "tax_rate", "DisplayName": "Tax rate", "Type": "float", "Description": "The tax rate applied to the item in percent.", "Group": "" }, { "Name": "quantity", "DisplayName": "Order quantity", "Type": "int", "Description": "The order quantity for this item in the purchase.", "Group": "" }, { "Name": "shop_id", "DisplayName": "Shop ID", "Type": "string", "Description": "The ID of the shop that sold the item in the order. Relevant for marketplaces that may have orders with items from more than 1 shop in the same order.", "Examples": [ "Bill's Sandals Shop" ], "Group": "" }, { "Name": "item_category", "DisplayName": "Item category", "Type": "string", "Description": "The category of the item in the merchant’s system, for example mountain bikes or books.", "Examples": [ "Apparel" ], "Group": "" }, { "Name": "item_type", "DisplayName": "Item type", "Type": "string", "Description": "The type of purchased item, for example physical or digital.", "Examples": [ "digital" ], "Group": "" } ] }, { "Name": "bool", "Description": "A logical data type with values true or false." }, { "Name": "custom", "Description": "An object that may contain any arbitrary fields that are not directly managed by shufti but can be send with each transaction to build rules on top of them." }, { "Name": "date", "Description": "The date part of an RFC3339-encoded UTC timestamp." }, { "Name": "enum", "Description": "A set of values of the same data type." }, { "Name": "float", "Description": "A numeric value with floating decimal points." }, { "Name": "int", "Description": "A whole number without a fractional component. Can be positive, negative, or zero." }, { "Name": "string", "Description": "A sequence of characters representing textual data." }, { "Name": "timestamp", "Description": "An RFC3339-encoded UTC timestamp." } ], "attributes": [ { "Name": "acct_ad_city", "DisplayName": "Account address | City", "Type": "string", "Description": "The city on the address of the buyer saved in the buyer's account on the merchant's platform.", "Examples": [ "Paris", "Berlin" ], "Group": "general/account", "Required": false }, { "Name": "acct_ad_ctry", "DisplayName": "Account address | Country", "Type": "enum", "Description": "The country on the account address. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "general/account", "Required": false }, { "Name": "acct_ad_line1", "DisplayName": "Account address | Street and building number", "Type": "string", "Description": "The street and building number on the account address.", "Examples": [ "44 Ashgrove Road" ], "Group": "general/account", "Required": false }, { "Name": "acct_ad_line2", "DisplayName": "Account address | Apartment number", "Type": "string", "Description": "The apartment or flat number on the account address.", "Examples": [ "Apt. 15" ], "Group": "general/account", "Required": false }, { "Name": "acct_ad_state", "DisplayName": "Account address | State", "Type": "string", "Description": "The state or another unit of administrative division on the account address.", "Examples": [ "VA", "Bavaria", "New York" ], "Group": "general/account", "Required": false }, { "Name": "acct_ad_zip", "DisplayName": "Account address | Postal code", "Type": "string", "Description": "The postal code on the account address.", "Examples": [ "10179" ], "Group": "general/account", "Required": false }, { "Name": "acquirer_ctry", "DisplayName": "Transaction | Acquirer country", "Type": "enum", "Description": "The country of the acquiring bank. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "general/transaction", "Required": false }, { "Name": "affiliate_partner", "DisplayName": "Purchase | Affiliate partner", "Type": "string", "Description": "Indicates the affiliate partner that generated the customer.", "Examples": [ "BigCommerce" ], "Group": "general/purchase", "Required": false }, { "Name": "agency_country", "DisplayName": "Purchase | Agency country name", "Type": "enum", "Description": "The country where the agency that facilitated the purchase operates. An ISO 3166-1 alpha-2 code. Send this datapoint optionally if you're sending 'agency_name'.", "ValuesRef": "country_code_iso", "Group": "general/purchase", "Required": false }, { "Name": "agency_name", "DisplayName": "Purchase | Agency name", "Type": "string", "Description": "The name of the agency that facilitated the purchase.", "Examples": [ "Clubhotel Reisen GmbH" ], "Group": "general/purchase", "Required": false }, { "Name": "airticket_agency_code", "DisplayName": "Airlines | IATA agency code", "Type": "string", "Description": "IATA code for the travel agency that issued the ticket.", "Examples": [ "13-3 4637 004" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_airline_name", "DisplayName": "Airlines | Airline name", "Type": "string", "Description": "The name of the airline.", "Examples": [ "Lufthansa", "Delta" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_arrival_ts", "DisplayName": "Airlines | Arrival timestamp", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the arrival. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2021-11-10T23:00:00Z" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_booking_pos_city", "DisplayName": "Airlines | Booking (POS) city", "Type": "string", "Description": "The city where the customer made the payment for the ticket and where sales taxes may become applicable.", "Examples": [ "Santiago" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_class", "DisplayName": "Airlines | Ticket class", "Type": "enum", "Description": "IATA code for the class of service for the leg of the trip. The code is used by airlines to identify a fare type and corresponding services applicable to that fare.", "ValuesRef": "ticket_class", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_days_to_departure", "DisplayName": "Airlines | Days to departure", "Type": "int", "Description": "Indicates the number of days before the airplane departure.", "Examples": [ "3" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_delivery_method", "DisplayName": "Airlines | Ticket delivery method", "Type": "string", "Description": "The delivery method for the airline ticket.", "Examples": [ "electronic" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_departure_ts", "DisplayName": "Airlines | Departure timestamp", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the departure. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2009-11-10T23:00:00Z" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_electronic_ticket", "DisplayName": "Airlines | Electronic ticket", "Type": "bool", "Description": "Indicates whether the ticket booking was made electronically.", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_first_departure_airport", "DisplayName": "Airlines | First departure airport", "Type": "string", "Description": "IATA code for the first departure airport in the itinerary.", "Examples": [ "BER" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_issuer_address", "DisplayName": "Airlines | Issuer address", "Type": "string", "Description": "The address of the company issuing the ticket.", "Examples": [ "Place Georges-Pompidou, 75004 Paris" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_issuer_name", "DisplayName": "Airlines | Issuer name", "Type": "string", "Description": "The name of the ticket issuer. May differ from the airline name.", "Examples": [ "ExpediaTravel" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_last_arrival_airport", "DisplayName": "Airlines | Last arrival airport", "Type": "string", "Description": "IATA code for the last arrival airport in the itinerary.", "Examples": [ "NAP" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_arrival_airport", "DisplayName": "Airlines | Arrival airport | Leg 1", "Type": "string", "Description": "IATA code for the arrival airport in the first leg of the trip.", "Examples": [ "FCO" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_arrival_time_segment", "DisplayName": "Airlines | Arrival time segment | Leg 1", "Type": "enum", "Description": "The arrival time segment for the first leg of the trip.", "Values": [ { "Name": "am", "DisplayName": "a.m.", "Description": "Before midday" }, { "Name": "pm", "DisplayName": "p.m.", "Description": "After midday" } ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_arrival_ts", "DisplayName": "Airlines | Arrival time | Leg 1", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the arrival for the first leg of the trip. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2021-10-04T15:20:44" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_carrier_code", "DisplayName": "Airlines | IATA carrier code | Leg 1", "Type": "string", "Description": "IATA code for the airline for the first leg of the trip.", "Examples": [ "7H" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_class", "DisplayName": "Airlines | Ticket class | Leg 1", "Type": "enum", "Description": "IATA code for the class of service for the first leg of the trip. The code is used by airlines to identify a fare type and corresponding services applicable to that fare.", "ValuesRef": "ticket_class", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_departure_airport", "DisplayName": "Airlines | Departure airport | Leg 1", "Type": "string", "Description": "IATA code for the departure airport in the first leg of the trip.", "Examples": [ "FCO" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_departure_time_segment", "DisplayName": "Airlines | Departure time segment | Leg 1", "Type": "enum", "Description": "The departure time segment for the first leg of the trip.", "Values": [ { "Name": "am", "DisplayName": "a.m.", "Description": "Before midday" }, { "Name": "pm", "DisplayName": "p.m.", "Description": "After midday" } ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_departure_ts", "DisplayName": "Airlines | Departure time | Leg 1", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the departure for the first leg of the trip. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2021-10-04T15:20:44" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_flight_number", "DisplayName": "Airlines | Flight number | Leg 1", "Type": "string", "Description": "The flight number for the first leg of the trip.", "Examples": [ "DF3409" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_price", "DisplayName": "Airlines | Ticket price | Leg 1", "Type": "float", "Description": "The full price of the ticket for the first leg of the trip, before any discounts or vouchers are applied.", "Examples": [ "49,99" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg1_stopover", "DisplayName": "Airlines | Stopover allowed | Leg 1", "Type": "bool", "Description": "Indicates whether a stopover is allowed on the first leg of the trip.", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_arrival_airport", "DisplayName": "Airlines | Arrival airport | Leg 2", "Type": "string", "Description": "IATA code for the arrival airport in the second leg of the trip.", "Examples": [ "CDG" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_arrival_time_segment", "DisplayName": "Airlines | Arrival time segment | Leg 2", "Type": "enum", "Description": "The arrival time segment for the second leg of the trip.", "Values": [ { "Name": "am", "DisplayName": "a.m.", "Description": "Before midday" }, { "Name": "pm", "DisplayName": "p.m.", "Description": "After midday" } ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_arrival_ts", "DisplayName": "Airlines | Arrival time | Leg 2", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the arrival for the second leg of the trip. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2021-10-04T15:20:44" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_carrier_code", "DisplayName": "Airlines | IATA carrier code | Leg 2", "Type": "string", "Description": "IATA code for the airline for the second leg of the trip.", "Examples": [ "7H" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_class", "DisplayName": "Airlines | Ticket class | Leg 2", "Type": "enum", "Description": "IATA code for the class of service for the second leg of the trip. The code is used by airlines to identify a fare type and corresponding services applicable to that fare.", "ValuesRef": "ticket_class", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_departure_airport", "DisplayName": "Airlines | Departure airport | Leg 2", "Type": "string", "Description": "IATA code for the departure airport in the second leg of the trip.", "Examples": [ "FCO" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_departure_time_segment", "DisplayName": "Airlines | Departure time segment | Leg 2", "Type": "enum", "Description": "The departure time segment for the second leg of the trip.", "Values": [ { "Name": "am", "DisplayName": "a.m.", "Description": "Before midday" }, { "Name": "pm", "DisplayName": "p.m.", "Description": "After midday" } ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_departure_ts", "DisplayName": "Airlines | Departure time | Leg 2", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the local date and time of the departure for the second leg of the trip. The timezone accepts either the character 'Z' to indicate UTC or a time offset in the format '+02:00' or '-07:30'.", "Examples": [ "2021-10-04T15:20:44" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_flight_number", "DisplayName": "Airlines | Flight number | Leg 2", "Type": "string", "Description": "The flight number for the second leg of the trip.", "Examples": [ "DF3409" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_price", "DisplayName": "Airlines | Ticket price | Leg 2", "Type": "float", "Description": "The full price of the ticket for the second leg of the trip, before any discounts or vouchers are applied.", "Examples": [ "49,99" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_leg2_stopover", "DisplayName": "Airlines | Stopover allowed | Leg 2", "Type": "bool", "Description": "Indicates whether a stopover is allowed on the second leg of the trip.", "Group": "industry/airlines", "Required": false }, { "Name": "airticket_loyalty_program_num", "DisplayName": "Airlines | Loyalty account number", "Type": "string", "Description": "The number of the customer that belongs to a loyalty program. Send this datapoint if you're sending 'airticket_loyalty_program_used = true'.", "Examples": [ "2934-YS" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_nr", "DisplayName": "Airlines | Ticket number", "Type": "string", "Description": "A 13-digit number that uniquely identifies the issued airline ticket.", "Examples": [ "8382124676356" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_pnr", "DisplayName": "Airlines | Passenger name record", "Type": "string", "Description": "The passenger name record for the ticket.", "Examples": [ "230-U8F16G" ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_purchase_type", "DisplayName": "Airlines | Purchase type", "Type": "enum", "Description": "Indicates the type of purchase in the booking.", "Values": [ { "Name": "ticket_only", "DisplayName": "Airline ticket only", "Description": "The customer bought an airline ticket only." }, { "Name": "ticket_and_other", "DisplayName": "Airline ticket and other services", "Description": "The customer bought an airline ticket and other services." }, { "Name": "other_only", "DisplayName": "Other services only", "Description": "The customer bought other service only without any airline ticket." } ], "Group": "industry/airlines", "Required": false }, { "Name": "airticket_third_party_booking", "DisplayName": "Airlines | Third-party booking", "Type": "bool", "Description": "Indicates whether the booking was made by a third-party entity.", "Group": "industry/airlines", "Required": false }, { "Name": "ba_bic", "DisplayName": "Bank account | BIC", "Type": "string", "Description": "The BIC (bank identifier code) of the bank account. Up to 11 characters.", "Examples": [ "DEUTDEDBBER", "BOFIIE2D" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_first_name", "DisplayName": "Bank account | Account holder first name", "Type": "string", "Description": "The first name of the bank account holder.", "Examples": [ "Grace" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_iban", "DisplayName": "Bank account | IBAN", "Type": "string", "Description": "IBAN (International bank account number). Up to 34 alphanumeric characters.", "Examples": [ "IE64BOFI90583812345678" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_last_name", "DisplayName": "Bank account | Account holder last name", "Type": "string", "Description": "The last name of the bank account holder.", "Examples": [ "Hopper" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_middle_name", "DisplayName": "Bank account | Account holder middle name", "Type": "string", "Description": "The middle name of the bank account holder.", "Examples": [ "Brewster Murray" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_name", "DisplayName": "Bank account | Account holder full name", "Type": "string", "Description": "The full name of the bank account holder. Send this datapoint if you collect the full name. Otherwise send parts of the name separately in 'ba_first_name', 'ba_middle_name', and 'ba_last_name'.", "Examples": [ "Grace Brewster Murray Hopper" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "ba_rtn_num", "DisplayName": "Bank account | Routing number", "Type": "string", "Description": "The routing number of the bank account.", "Examples": [ "122105155" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "bill_ad_city", "DisplayName": "Billing address | City", "Type": "string", "Description": "The city on the billing address.", "Examples": [ "Berlin" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_city_norm_dp", "DisplayName": "Billing address | City normalized by the payment company", "Type": "string", "Description": "The normalized value of the city on the billing address provided by the payment company.", "Examples": [ "buenosaires", "newyork" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_ctry", "DisplayName": "Billing address | Country", "Type": "enum", "Description": "The country on the billing address. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_ctry_norm_dp", "DisplayName": "Billing address | Country normalized by payment company", "Type": "enum", "Description": "The normalized value of the country on the billing address provided by the payment company.", "ValuesRef": "country_code_iso", "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_first_name", "DisplayName": "Billing address | First name", "Type": "string", "Description": "The first name of the customer on the billing address.", "Examples": [ "Grace" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_house_num", "DisplayName": "Billing address | House number", "Type": "string", "Description": "The house number on the billing address.", "Examples": [ "4", "40/1" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_house_num_norm_dp", "DisplayName": "Billing address | House number normalized", "Type": "string", "Description": "The normalized value of the house number on the billing address.", "Examples": [ "4", "40" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_last_name", "DisplayName": "Billing address | Last name", "Type": "string", "Description": "The last name of the customer on the billing address.", "Examples": [ "Hopper" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_line1", "DisplayName": "Billing address | Street and building number", "Type": "string", "Description": "The street and building number on the billing address.", "Examples": [ "Hartwigstraße 27" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_line1_norm_dp", "DisplayName": "Billing address | Street and building number normalized by payment company", "Type": "string", "Description": "The normalized value of the street and building number on the billing address.", "Examples": [ "Hartwigstr." ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_line2", "DisplayName": "Billing address | Apartment number", "Type": "string", "Description": "The apartment or flat number on the billing address.", "Examples": [ "Apt. 15" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_line3", "DisplayName": "Billing address | Additional info", "Type": "string", "Description": "Additional address information on the billing address.", "Examples": [ "2nd floor" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_line3_norm_dp", "DisplayName": "Billing address | Additional info normalized by payment company", "Type": "string", "Description": "The normalized value of additional details on the billing address provided by the payment company.", "Examples": [ "2nd floor – left side", "2nd floor" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_middle_name", "DisplayName": "Billing address | Middle name", "Type": "string", "Description": "The middle name of the customer on the billing address.", "Examples": [ "Brewster Murray" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_name", "DisplayName": "Billing address | Full name", "Type": "string", "Description": "The full name of the customer on the billing address. Use this datapoint when a customer sends their full name in one field, as opposed to sending their first, middle, and last name in separate fields.", "Examples": [ "Grace Hopper" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_state", "DisplayName": "Billing address | State", "Type": "string", "Description": "The state or another unit of administrative division on the billing address.", "Examples": [ "New York", "Bavaria" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_zip", "DisplayName": "Billing address | Postal code", "Type": "string", "Description": "The postal code on the billing address.", "Examples": [ "10179" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_ad_zip_norm_dp", "DisplayName": "Billing address | Postal code normalized", "Type": "string", "Description": "The normalized value of the postal code on the billing address.", "Examples": [ "78467" ], "Group": "general/billing_address", "Required": false }, { "Name": "bill_name_title", "DisplayName": "Billing address | Courtesy title", "Type": "string", "Description": "The courtesy title of the customer on the billing address.", "Examples": [ "Dr." ], "Group": "general/billing_address", "Required": false }, { "Name": "bin_ctry", "DisplayName": "BIN | Country", "Type": "enum", "Description": "The country of the credit card issuer. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "payment_method/cards", "Required": false }, { "Name": "bnpl_active_order", "DisplayName": "BNPL | Active order", "Type": "bool", "Description": "Indicates if the customer has an active order with the merchant and is still paying installments on it.", "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_active_order_count", "DisplayName": "BNPL | Active order count", "Type": "int", "Description": "The number of active orders the customer has and is still paying installments on.", "Examples": [ "2" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_collection_frequency", "DisplayName": "BNPL | Collection frequency", "Type": "int", "Description": "Indicates the frequency of installment collections in weeks. Example: if the collection happens once a month, the frequency is defined as every 4 weeks.", "Examples": [ "4" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_credit_check_performed", "DisplayName": "BNPL | Credit check performed", "Type": "bool", "Description": "Indicates if a credit check was performed for the customer. Use 'bnpl_credit_score' if you want to send the credit score also.", "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_credit_score", "DisplayName": "BNPL | Credit score", "Type": "int", "Description": "Indicates the credit score of the customer as assessed by you or a third-party provider. If you receive the result of a check as a range, please send either the lower or the higher value of the range in this datapoint, depending on your analytical needs.", "Examples": [ "850" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_first_installment_due_date", "DisplayName": "BNPL | First installment | Due date", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the date on which the first installment is due.", "Examples": [ "2019-02-04T15:04:05Z" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_installments_count", "DisplayName": "BNPL | Installments count", "Type": "int", "Description": "The number of installments the customer chose to split their payment into. If the company provides only one specific number of installments for each purchase, specify it accordingly.", "Examples": [ "3" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_missed_payment", "DisplayName": "BNPL | Missed payment", "Type": "bool", "Description": "Indicates if the customer has ever missed an installment payment on previous orders.", "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_missed_payment_count", "DisplayName": "BNPL | Missed payment count", "Type": "int", "Description": "Indicates the number of times the customer missed installment payments on previous orders.", "Examples": [ "5" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_order_count", "DisplayName": "BNPL | Order count", "Type": "int", "Description": "This count indicates the number of times the customer placed an order with this merchant.", "Examples": [ "4" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_order_paid_off", "DisplayName": "BNPL | Previous order paid off", "Type": "bool", "Description": "Indicates if the customer paid off all the installments of the previous order. If the customer has had more than one order with the merchant, consider the latest order.", "Group": "payment_method/bnpl", "Required": false }, { "Name": "bnpl_previous_order_value", "DisplayName": "BNPL | Previous order value", "Type": "float", "Description": "Indicates the total value of the items in the previous order.", "Examples": [ "159,99" ], "Group": "payment_method/bnpl", "Required": false }, { "Name": "booking_invoice_number", "DisplayName": "Booking | Invoice number", "Type": "string", "Description": "The invoice number for the booking transaction. Refers to the booking of any types of goods or services like a ticket, trip, etc.", "Examples": [ "45738/2021" ], "Group": "general/purchase", "Required": false }, { "Name": "booking_is_flexi", "DisplayName": "Booking | Flexible cancellation", "Type": "bool", "Description": "Indicates if the booking has flexible cancellation. This allows the customer to make changes to the departure date and time for example, or cancel the event/service all together.", "Group": "general/purchase", "Required": false }, { "Name": "booking_is_restricted", "DisplayName": "Booking | Restricted", "Type": "bool", "Description": "Indicates whether the booking is restricted (non-refundable).", "Group": "general/purchase", "Required": false }, { "Name": "booking_persons_number", "DisplayName": "Booking | Persons in the booking", "Type": "int", "Description": "The number of persons included in the booking.", "Examples": [ "1" ], "Group": "general/purchase", "Required": false }, { "Name": "browser_user_agent", "DisplayName": "Browser | User agent", "Type": "string", "Description": "The web browser user agent.", "Examples": [ "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Safari/537.36" ], "Group": "general/device", "Required": false }, { "Name": "brwsr_addons", "DisplayName": "Browser | Add-ons", "Type": "string", "Description": "A list of add-ons installed on user's browser.", "Examples": [ "Adblock Plus, FeedsPlus, Affine" ], "Group": "general/device", "Required": false }, { "Name": "brwsr_lang", "DisplayName": "Browser | Language", "Type": "string", "Description": "The language of the customer's web browser.", "Examples": [ "en-US" ], "Group": "general/device", "Required": false }, { "Name": "brwsr_ts", "DisplayName": "Browser | Timestamp", "Type": "timestamp", "Description": "Web browser timestamp at the time of the purchase.", "Examples": [ "2017-12-03T11:52:06Z" ], "Group": "general/device", "Required": false }, { "Name": "brwsr_type", "DisplayName": "Browser | Type", "Type": "string", "Description": "The type of the customer's web browser.", "Examples": [ "Firefox" ], "Group": "general/device", "Required": false }, { "Name": "brwsr_version", "DisplayName": "Browser | Version", "Type": "string", "Description": "The version of the customer's web browser.", "Examples": [ "65.0.2 (64-bit)" ], "Group": "general/device", "Required": false }, { "Name": "cc_bin", "DisplayName": "BIN | Number", "Type": "string", "Description": "The BIN number of the credit card (the first 6 digits).", "Examples": [ "572543" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_cardholder", "DisplayName": "Credit card | Cardholder full name", "Type": "string", "Description": "The full name of the credit card holder. Send this datapoint if you collect the full name. Otherwise send parts of the name separately in 'cc_first_name', 'cc_middle_name', and 'cc_last_name'.", "Examples": [ "Grace Brewster Murray Hopper" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_exp_dt", "DisplayName": "Credit card | Expiry date", "Type": "string", "Description": "The expiry date of the credit card in format MMYYYY.", "Examples": [ "042023" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_exp_month", "DisplayName": "Credit card | Expiry month", "Type": "string", "Description": "The expiry month of the credit card.", "Examples": [ "10" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_exp_year", "DisplayName": "Credit card | Expiry year", "Type": "string", "Description": "The expiry year of the credit card.", "Examples": [ "2020" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_first_name", "DisplayName": "Credit card | Cardholder first name", "Type": "string", "Description": "The first name of the credit card holder.", "Examples": [ "Grace" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_last_4_dig", "DisplayName": "Credit card | Last 4 digits", "Type": "string", "Description": "The last 4 digits of the credit card.", "Examples": [ "1234" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_last_name", "DisplayName": "Credit card | Cardholder last name", "Type": "string", "Description": "The last name of the credit card holder.", "Examples": [ "Hopper" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_middle_name", "DisplayName": "Credit card | Cardholder middle name", "Type": "string", "Description": "The middle name of the credit card holder.", "Examples": [ "Brewster Murray" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_num_hash", "DisplayName": "Credit card | Hashed number", "Type": "string", "Description": "The hashed value of the credit card number. Use this datapoint to send credit card numbers if you cannot send the full card number in 'cc_num'.", "Examples": [ "6T5tdyWRiuhPuFhupAZYZzFESBYrOiOoYyqO8Zb4WEw=" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_num_type", "DisplayName": "Credit card | Number type", "Type": "string", "Description": "The type of the credit card number.", "Examples": [ "PAN" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_num", "DisplayName": "Credit card number", "Type": "string", "Description": "The credit card number (PAN) of the customer. It gets replaced with a token when it reaches the shufti PCI-compliant environment.", "Examples": [ "1111222233334444555566" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cc_sub_brand", "DisplayName": "Credit card | Sub-brand", "Type": "string", "Description": "The sub-brand of the credit card.", "Examples": [ "Visa Online" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cust_company", "DisplayName": "Customer | Company name", "Type": "string", "Description": "The company name of the customer.", "Examples": [ "Schön Klinik München Harlaching" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_dob", "DisplayName": "Customer | Date of birth", "Type": "date", "Description": "The date of birth of the customer.", "Examples": [ "1906-12-09Z" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_email", "DisplayName": "Customer | Email address", "Type": "string", "Description": "The primary email address of the customer.", "Examples": [ "grace.hopper@example.com" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_existing", "DisplayName": "Customer | Existing with payment company", "Type": "bool", "Description": "Indicates whether the customer has an account with the payment company.", "Group": "general/account", "Required": false }, { "Name": "cust_existing_merchant", "DisplayName": "Customer | Existing with merchant", "Type": "bool", "Description": "Indicates whether the customer has an account with the merchant.", "Group": "general/account", "Required": false }, { "Name": "cust_first_name", "DisplayName": "Customer | First name", "Type": "string", "Description": "The first name of the customer.", "Examples": [ "Grace" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_forgot_password", "DisplayName": "Customer | Forgot password", "Type": "bool", "Description": "Indicates whether the customer forgot the password for their account on the e-commerce platform.", "Group": "general/account", "Required": false }, { "Name": "cust_gender", "DisplayName": "Customer | Gender", "Type": "string", "Description": "The gender of the customer.", "Examples": [ "F" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_has_password", "DisplayName": "Customer | Has password", "Type": "bool", "Description": "Indicates whether the customer has a password for their account on the e-commerce platform.", "Group": "general/account", "Required": false }, { "Name": "cust_id", "DisplayName": "Customer | ID as per merchant", "Type": "string", "Description": "The ID of the customer in the merchant's database.", "Examples": [ "7730468", "4738" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_last_login_ts", "DisplayName": "Account | Last login", "Type": "timestamp", "Description": "The date of the last login of the customer. Relevant if the customer has a user account on the merchant's e-commerce platform.", "Examples": [ "2019-02-04T15:04:05Z" ], "Group": "general/account", "Required": false }, { "Name": "cust_last_name", "DisplayName": "Customer | Last name", "Type": "string", "Description": "The last name of the customer.", "Examples": [ "Hopper" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_middle_name", "DisplayName": "Customer | Middle name", "Type": "string", "Description": "The middle name of the customer.", "Examples": [ "Brewster Murray" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_name", "DisplayName": "Customer | Full name", "Type": "string", "Description": "The full name of the customer. Use this datapoint when a customer sends their full name in one field, as opposed to sending their first, middle, and last name in separate fields.", "Examples": [ "Grace Brewster Murray Hopper" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_nationality", "DisplayName": "Customer | Nationality", "Type": "string", "Description": "The nationality of the customer.", "Examples": [ "Italian" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_scndry_email", "DisplayName": "Customer | Secondary email address", "Type": "string", "Description": "The secondary email address of the customer.", "Examples": [ "grace.hopper@private.com" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_signup_dt", "DisplayName": "Account | Signup date", "Type": "string", "Description": "The date when the customer signed up for the merchant's e-commerce platform. An RFC3339-encoded UTC timestamp.", "Examples": [ "2017-12-09Z" ], "Group": "general/account", "Required": false }, { "Name": "cust_signup_ts", "DisplayName": "Account | Signup timestamp", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp when the customer signed up for the merchant's e-commerce platform, i.e. created their account with the merchant.", "Group": "general/account", "Required": false }, { "Name": "cust_title", "DisplayName": "Customer | Courtesy title", "Type": "string", "Description": "The courtesy title of the customer.", "Examples": [ "Dr." ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_tmz_offset", "DisplayName": "Customer Timezone Offset", "Type": "string", "Description": "TODO.", "Examples": [ "-0500" ], "Group": "todo", "Required": false }, { "Name": "custom", "DisplayName": "Custom attributes", "Type": "custom", "Description": "An object that contains arbitrary fields not directly managed by shufti. Can be sent with each transaction and used for rule creation.", "Group": "general/transaction", "Required": false }, { "Name": "customer_account_number", "DisplayName": "Customer | Account number", "Type": "string", "Description": "The account number of the customer in the merchant's database.", "Examples": [ "2364" ], "Group": "general/account", "Required": false }, { "Name": "customer_is_of_age", "DisplayName": "Customer | Is of age", "Type": "bool", "Description": "Specifies if the customer is of age, i.e. old enough, according to the law, to be eligible for certain purchases.", "Group": "general/customer_identity", "Required": false }, { "Name": "customer_username", "DisplayName": "Customer | Username", "Type": "string", "Description": "Specifies the username of the customer they created for the e-commerce account/product they are using.", "Examples": [ "gamer_42" ], "Group": "general/customer_identity", "Required": false }, { "Name": "customer_verified_account", "DisplayName": "Customer | Verified account", "Type": "bool", "Description": "Indicates if user's account has been verified. Different products offer different verification processes, i.e. via an email address or a code. This normally depends on the type of the registration system.", "Group": "general/customer_identity", "Required": false }, { "Name": "cvc", "DisplayName": "Credit card | CVC", "Type": "string", "Description": "The CVC (card verification code). The 3 digits on the back of the card.", "Examples": [ "123" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cvc_error_code", "DisplayName": "Credit card | CVC error code", "Type": "string", "Description": "The error code captured for the CVC information.", "Examples": [ "103" ], "Group": "payment_method/cards", "Required": false }, { "Name": "cvc_error_message", "DisplayName": "Credit card | CVC error message", "Type": "string", "Description": "The error message captured for the CVC information.", "Examples": [ "CVC is not the right length." ], "Group": "payment_method/cards", "Required": false }, { "Name": "cvc_source", "DisplayName": "Credit card | CVC source", "Type": "string", "Description": "The source of the CVC value.", "Examples": [ "GeneralValidation" ], "Group": "payment_method/cards", "Required": false }, { "Name": "delivery_method", "DisplayName": "Purchase | Delivery method", "Type": "enum", "Description": "Indicates the delivery method of the purchased goods.", "Values": [ { "Name": "electronic", "DisplayName": "Electronic delivery", "Description": "The purchased items are delivered electronically to the customer." }, { "Name": "shipping_address", "DisplayName": "Shipping address", "Description": "The purchased items are delivered to the customer's shipping address." }, { "Name": "pickup", "DisplayName": "Pickup location", "Description": "The customer collects the purchased items from a designated pickup location." }, { "Name": "branch_shop", "DisplayName": "Branch store", "Description": "The customer collects the purchased items from a branch store." }, { "Name": "hq", "DisplayName": "Flagship store", "Description": "The customer collects the items from a flagship store." }, { "Name": "pickup_packstation", "DisplayName": "DHL packstation pickup", "Description": "The customer collects the items from a DHL packstation." } ], "Group": "general/purchase", "Required": false }, { "Name": "device_crt_ts", "DisplayName": "Device | Timestamp", "Type": "timestamp", "Description": "The timestamp on the device when the transaction happened.", "Group": "general/device", "Required": false }, { "Name": "device_fingerprint", "DisplayName": "Device | Fingerprint", "Type": "string", "Description": "An identifier of the user's device generated by your device fingerprinting solution. Send it as a plain string: letters and digits only, up to 255 characters.", "Examples": [ "FP78K9L2M3N4" ], "Group": "general/device", "Required": false }, { "Name": "device_id", "DisplayName": "Device | ID", "Type": "string", "Description": "Device identification code.", "Examples": [ "2fc4b5912826ad1" ], "Group": "general/device_id", "Required": false }, { "Name": "device_id_exact", "DisplayName": "Device | Exact ID", "Type": "string", "Description": "Exact ID is a hashed device fingerprint generated by the payment company. It's based on a variety of markers to give a 100-percent accuracy in identifying a device, including browser language, cookies settings, and more.", "Examples": [ "ATHjII4ALRQySeFH1hmaC5svTtgg" ], "Group": "general/device_id", "Required": false }, { "Name": "device_id_smart", "DisplayName": "Device | Smart ID", "Type": "string", "Description": "Smart ID is a hashed device fingerprint generated by the payment company. It's optimized for persistence across standard computer lifecycle events. It works without the use of cookies and is calculated from hundreds of device attributes that are measured in real time.", "Examples": [ "AGlYUjsSx4fCMnEfrNSFQVqoXjko" ], "Group": "general/device_id", "Required": false }, { "Name": "device_manufacturer", "DisplayName": "Device | Manufacturer", "Type": "string", "Description": "The manufacturer of the customer's device.", "Examples": [ "Samsung" ], "Group": "general/device", "Required": false }, { "Name": "device_name", "DisplayName": "Device | Name", "Type": "string", "Description": "The name of the customer's device.", "Examples": [ "Grace’s MacBook Pro" ], "Group": "general/device", "Required": false }, { "Name": "device_reputation", "DisplayName": "Device | Reputation", "Type": "string", "Description": "Specific reputation and/or behavior associated with a device. This information is provided by a third-party provider of your choice or generated by you internally. You normally send this datapoint with 'device_id' and 'device_score'.", "Examples": [ "risky_device_behavior, risky_ip_reputation, risky_ip_behavior" ], "Group": "general/device_id", "Required": false }, { "Name": "device_score", "DisplayName": "Device | Score", "Type": "float", "Description": "The score of the device generated by a third-party provider of your choice or by you internally. You normally send this datapoint with 'device_id' and 'device_reputation'.", "Examples": [ "42.01" ], "Group": "general/device_id", "Required": false }, { "Name": "device_type", "DisplayName": "Device | Type", "Type": "string", "Description": "The device type of the customer.", "Examples": [ "iPhone" ], "Group": "general/device", "Required": false }, { "Name": "device_version", "DisplayName": "Device | Version", "Type": "string", "Description": "The version of the customer's device.", "Examples": [ "4.1" ], "Group": "general/device", "Required": false }, { "Name": "digital_delivery_email", "DisplayName": "Digital | Delivery email", "Type": "string", "Description": "The email address where the digital product is supposed to be delivered.", "Examples": [ "grace.hopper@example.com" ], "Group": "industry/digital", "Required": false }, { "Name": "digital_event_date", "DisplayName": "Digital | Event date", "Type": "date", "Description": "Indicates the date of the event the customer is buying tickets for. The date part of an RFC3339 -encoded UTC timestamp.", "Examples": [ "2021-10-04T" ], "Group": "industry/digital", "Required": false }, { "Name": "digital_lifetime_license", "DisplayName": "Digital | Lifetime license", "Type": "bool", "Description": "Indicates if the customer has a lifetime subscription with a merchant.", "Group": "industry/digital", "Required": false }, { "Name": "digital_product_category", "DisplayName": "Digital | Product category", "Type": "enum", "Description": "Indicates the category of digital products purchased by the customer. This datapoint has a less granular categorization than 'digital_product_type'. Use both to be able to write more granular rules.", "Values": [ { "Name": "digital_goods", "DisplayName": "Digital goods", "Description": "May include audio or video files, photography, ebooks, graphics and digital art, documents, etc." }, { "Name": "digital_services", "DisplayName": "Digital services", "Description": "May include streaming, cloud-based software or game subscriptions, paid podcasts, online news portals or magazines, etc." }, { "Name": "on-demand_digital", "DisplayName": "On-demand goods and services", "Description": "May include ride- or home-sharing, restaurant delivery, personal or household services, business services, etc." }, { "Name": "software", "DisplayName": "Software", "Description": "May include downloadable programs for computers or other electronic devices, etc." }, { "Name": "internet", "DisplayName": "Internet", "Description": "May include hosting services, internet service providers, website domains, etc." }, { "Name": "gaming", "DisplayName": "Gaming", "Description": "May include online or console games, mobile in-game content, computer in-game content, etc." }, { "Name": "travel", "DisplayName": "Travel", "Description": "May include vacation and travel bookings, etc." }, { "Name": "entertainment", "DisplayName": "Entertainment", "Description": "May include event tickets, etc." } ], "Group": "industry/digital", "Required": false }, { "Name": "digital_product_type", "DisplayName": "Digital | Product type", "Type": "enum", "Description": "Indicates the type of digital products purchased by the customer. This datapoint has a more granular categorization than 'digital_product_category'. Use both to be able to write more granular rules.", "Values": [ { "Name": "ebooks", "DisplayName": "Ebooks" }, { "Name": "audiobooks", "DisplayName": "Audiobooks" }, { "Name": "digital_imagery", "DisplayName": "Digital imagery", "Description": "Examples may include images, art, media, font, logos, themes, etc." }, { "Name": "video_content", "DisplayName": "Video content (one-time service)" }, { "Name": "audio_content", "DisplayName": "Audio content (one-time service)" }, { "Name": "music_streaming", "DisplayName": "Music streaming" }, { "Name": "video_streaming", "DisplayName": "Video streaming" }, { "Name": "paid_podcasts", "DisplayName": "Paid podcasts" }, { "Name": "computer_software", "DisplayName": "Cloud-based computer software" }, { "Name": "mobile_apps", "DisplayName": "Mobile apps" }, { "Name": "hosting_services", "DisplayName": "Hosting services" }, { "Name": "saas_products", "DisplayName": "SaaS products" }, { "Name": "internet_providers", "DisplayName": "Internet service providers" }, { "Name": "media_subscriptions", "DisplayName": "Media subscriptions", "Description": "Examples include news outlet subscription, magazine subscription etc." }, { "Name": "console_games", "DisplayName": "Console games" }, { "Name": "computer_games", "DisplayName": "Computer games" }, { "Name": "mobile_games", "DisplayName": "Mobile games" }, { "Name": "accommodation_rentals", "DisplayName": "Accommodation rentals" }, { "Name": "event_tickets", "DisplayName": "Event tickets" }, { "Name": "food_delivery_once", "DisplayName": "Food delivery (one-time service)" }, { "Name": "food_delivery_subscription", "DisplayName": "Food delivery (subscription)" }, { "Name": "insurance", "DisplayName": "Insurance" }, { "Name": "e_learning", "DisplayName": "E-learning", "Description": "Examples include online courses, webinars, etc." }, { "Name": "online_ads", "DisplayName": "Online advertising" }, { "Name": "giftcards_prepaids", "DisplayName": "Gift cards/prepaids" } ], "Group": "industry/digital", "Required": false }, { "Name": "exchange_ticket_price", "DisplayName": "Ticket | Exchange price", "Type": "float", "Description": "The price of the exchange ticket before any discounts or vouchers are applied.", "Examples": [ "155,70" ], "Group": "general/purchase", "Required": false }, { "Name": "fax", "DisplayName": "Customer | Fax number", "Type": "string", "Description": "The fax number of the customer.", "Examples": [ "030-1781224" ], "Group": "general/customer_identity", "Required": false }, { "Name": "first_payment_day", "DisplayName": "Open invoice | First payment day", "Type": "int", "Description": "The day of the month for the first installment.", "Examples": [ "1" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "first_purchase", "DisplayName": "Purchase | First with the merchant", "Type": "bool", "Description": "Indicates if the user is making their first purchase with the merchant. For some products, the first purchase is considered less secure because the merchant doesn't have sufficient data to evaluate the user.", "Group": "general/purchase", "Required": false }, { "Name": "gaming_donatable_item", "DisplayName": "Gaming | Donatable item", "Type": "bool", "Description": "Specifies if the item purchased is donatable.", "Group": "industry/gaming", "Required": false }, { "Name": "gaming_locked_country", "DisplayName": "Gaming | Locked country availability", "Type": "enum", "Description": "Indicates the country where an item is available. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "industry/gaming", "Required": false }, { "Name": "gaming_platform", "DisplayName": "Gaming | Platform", "Type": "enum", "Description": "Specifies the platform where the game is available.", "Values": [ { "Name": "mobile", "DisplayName": "Mobile", "Description": "Includes phones, tablets." }, { "Name": "console", "DisplayName": "Console", "Description": "Includes PS, xbox, etc." }, { "Name": "desktop", "DisplayName": "Desktop", "Description": "Includes desktop computers." } ], "Group": "industry/gaming", "Required": false }, { "Name": "gaming_product_type", "DisplayName": "Gaming | Product type", "Type": "enum", "Description": "Specifies the type of the gaming product being purchased.", "Values": [ { "Name": "game", "DisplayName": "Game", "Description": "Game" }, { "Name": "dlc", "DisplayName": "Downloadable content", "Description": "Additional content created for an already released video game, distributed by the game's publisher." }, { "Name": "premium_currency", "DisplayName": "Premium currency. Can only be acquired by means of money." }, { "Name": "soft_currency", "DisplayName": "Soft currency. Can be acquired by means of money or non-monetary means, i.e. by completing a certain activity." }, { "Name": "cosmetic_items", "DisplayName": "Cosmetic items, i.e. armor, weapons, clothing, etc." }, { "Name": "character", "DisplayName": "Character", "Description": "A person or any other entity acting in a game." }, { "Name": "loot_box", "DisplayName": "Loot box", "Description": "A consumable virtual item that can be redeemed to receive a randomized selection of further virtual items." }, { "Name": "season_pass", "DisplayName": "Season pass", "Description": "A purchase of a discounted package for current and future downloadable content (DLC) packs for a video game atop its base cost." }, { "Name": "battle_pass", "DisplayName": "Battle pass", "Description": "A type of monetization approach that provides additional content for a game usually through a tiered system, rewarding the player with in-game items for playing the game and completing specific challenges." }, { "Name": "starter_pack", "DisplayName": "Starter pack", "Description": "Content designed as an entry point into a game, usually covering a beginner level." }, { "Name": "other", "DisplayName": "Other", "Description": "Any other product type not covered in the available values." } ], "Group": "industry/gaming", "Required": false }, { "Name": "gaming_tutorial_finished", "DisplayName": "Gaming | Tutorial finished", "Type": "bool", "Description": "Indicates if the user finished the tutorial before initiating their first purchase. For some products, a purchase before completing the tutorial may indicate fraudulent activity. In some products, purchases are not available at all before the user completes a tutorial.", "Group": "industry/gaming", "Required": false }, { "Name": "gaming_user_ranking", "DisplayName": "Gaming | User ranking", "Type": "string", "Description": "Indicates the status/ranking the user has reached in a product. In some cases, a lower/non-existent ranking may indicate fraudulent activity.", "Examples": [ "advanced" ], "Group": "industry/gaming", "Required": false }, { "Name": "giftcard_message", "DisplayName": "Gift card | Message", "Type": "string", "Description": "The message added for the gift card being shipped.", "Examples": [ "Happy birthday!" ], "Group": "general/purchase", "Required": false }, { "Name": "hotels_days_until_stay", "DisplayName": "Hotels | Days until stay begins", "Type": "int", "Description": "The number of days until the arrival at the hotel.", "Examples": [ "25" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_final_price", "DisplayName": "Hotels | Final price", "Type": "float", "Description": "The final amount that was paid for the stay at the hotel. The final amount is calculated after discounts, or gift cards are applied to the order total.", "Examples": [ "435,50" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_hotel_name", "DisplayName": "Hotels | Hotel name", "Type": "int", "Description": "The name of the hotel.", "Examples": [ "Grand Hotel Saint Lucia" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_lodging_days", "DisplayName": "Hotels | Lodging days", "Type": "int", "Description": "The number of lodging days at the hotel.", "Examples": [ "14" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_number_of_rooms", "DisplayName": "Hotels | Rooms in the booking", "Type": "int", "Description": "The number of rooms in the hotel booking.", "Examples": [ "1" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_payment_type", "DisplayName": "Hotels | Payment type", "Type": "enum", "Description": "The payment type used to pay for the stay at the hotel.", "Values": [ { "Name": "credit_card", "DisplayName": "Credit card" }, { "Name": "bank_transfer", "DisplayName": "Bank transfer" }, { "Name": "delayed_payment", "DisplayName": "Delayed payment" }, { "Name": "payment_at_hotel", "DisplayName": "Payment at the hotel" }, { "Name": "paypal", "DisplayName": "PayPal" }, { "Name": "agency_cc", "DisplayName": "Agency credit card" }, { "Name": "other", "DisplayName": "Other" } ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_room_type", "DisplayName": "Hotels | Room type", "Type": "string", "Description": "The type of the hotel room.", "Examples": [ "Sea view suite" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_stay_end_date", "DisplayName": "Hotels | Stay end date", "Type": "date", "Description": "The date of the departure from the hotel. The date part of an RFC3339 -encoded UTC timestamp.", "Examples": [ "2022-01-02Z" ], "Group": "industry/hotels", "Required": false }, { "Name": "hotels_stay_incl_weekend", "DisplayName": "Hotels | Stay includes weekend", "Type": "bool", "Description": "Indicates if the stay at the hotel includes at least one weekend.", "Group": "industry/hotels", "Required": false }, { "Name": "hotels_stay_start_date", "DisplayName": "Hotels | Stay start date", "Type": "date", "Description": "The date of the arrival at the hotel. The date part of an RFC3339 -encoded UTC timestamp.", "Examples": [ "2022-01-02Z" ], "Group": "industry/hotels", "Required": false }, { "Name": "includes_giftcard", "DisplayName": "Purchase | Includes gift card", "Type": "enum", "Description": "Indicates whether the purchase order includes gift cards as items.", "Values": [ { "Name": "only", "DisplayName": "Includes only gift cards", "Description": "The purchase order includes only gift cards." }, { "Name": "yes", "DisplayName": "Includes gift cards", "Description": "The purchase order includes gift cards and other items." }, { "Name": "no", "DisplayName": "Does not include gift cards", "Description": "The purchase order does not include any gift cards." } ], "Group": "general/purchase", "Required": false }, { "Name": "includes_preorder", "DisplayName": "Purchase | Includes pre-ordered item", "Type": "bool", "Description": "Purchase includes one or more pre-ordered item.", "Group": "general/purchase", "Required": false }, { "Name": "ip", "DisplayName": "IP", "Type": "string", "Description": "The IP address of the customer.", "Examples": [ "192.168.0.1" ], "Group": "general/ip_address", "Required": false }, { "Name": "ip_hashed", "DisplayName": "IP | Hashed value", "Type": "string", "Description": "The hashed value of the IP address.", "Examples": [ "6023d6a87eec89bf628b2520434a1065ac4da0e0" ], "Group": "general/ip_address", "Required": false }, { "Name": "is_3ds_approved", "DisplayName": "Transaction | Is 3D approved", "Type": "enum", "Description": "Indicates whether the transaction was authenticated with 3D Secure. Relevant in cases where shufti is integrated after authentication and/or authorization.", "Values": [ { "Name": "fully_authenticated", "DisplayName": "Fully authenticated", "Description": "The user was fully authenticated with 2FA." }, { "Name": "not_authenticated", "DisplayName": "Not authenticated", "Description": "The user was not authenticated by the issuing bank." }, { "Name": "partially_authenticated", "DisplayName": "Partially authenticated", "Description": "The user was authenticated without completing 2FA." }, { "Name": "unable", "DisplayName": "Authentication error", "Description": "The user could not be authenticated due to a server error." }, { "Name": "failed_authentication", "DisplayName": "Failed authentication", "Description": "The user failed or cancelled the authentication." } ], "Group": "general/transaction", "Required": false }, { "Name": "is_recurring", "DisplayName": "Transaction | Is recurring", "Type": "bool", "Description": "Indicates whether a transaction is a subsequent transaction following a previous authorization. Please note that shufti cannot validate whether the transaction is indeed linked to a previous transaction flagged with the acquirer as starting a recurring operation.", "Group": "general/transaction", "Required": false }, { "Name": "item_is_subscription", "DisplayName": "Purchase | Subscription", "Type": "bool", "Description": "Indicates if the item purchased is a subscription. Generally, subscription products are less risky.", "Group": "general/purchase", "Required": false }, { "Name": "item_on_sale", "DisplayName": "Purchase | Item on sale", "Type": "bool", "Description": "Indicates if the item was purchased during a sale.", "Group": "general/purchase", "Required": false }, { "Name": "item_preorder", "DisplayName": "Purchase | Preorder", "Type": "bool", "Description": "Indicates if the purchased item is a preorder. Generally, preordered purchases are way less risky.", "Group": "general/purchase", "Required": false }, { "Name": "items", "DisplayName": "Purchase | Items", "Type": "ShoppingCartItem[]", "Description": "The attribute represents items in the shopping cart of the customer.", "Examples": [ "[ {\"item_id\":\"DF42\",\"item_desc\":\"Belt\"} ]" ], "Group": "general/purchase", "Required": false }, { "Name": "loyalty_account_number", "DisplayName": "Purchase | Loyalty account number", "Type": "string", "Description": "The loyalty account number of the customer. Send this datapoint if you're sending 'loyalty_program_used = true'.", "Examples": [ "2934-YS" ], "Group": "general/purchase", "Required": false }, { "Name": "loyalty_program_name", "DisplayName": "Purchase | Loyalty program name", "Type": "string", "Description": "Indicates what loyalty program the customer is part of. Send this datapoint if you're sending 'loyalty_program_used = true'.", "Examples": [ "SkyMiles" ], "Group": "general/purchase", "Required": false }, { "Name": "loyalty_program_used", "DisplayName": "Purchase | Loyalty program", "Type": "bool", "Description": "Indicates whether the customer belongs to a loyalty program.", "Group": "general/purchase", "Required": false }, { "Name": "order_id", "DisplayName": "Merchant | Order ID", "Type": "string", "Description": "The identification code of the order as captured by the merchant. Do not confuse with the order ID assigned by the PSP ('trans_id') or the transaction ID created by shufti ('frg_trans_id').", "Examples": [ "1128-4000050556-1" ], "Group": "general/purchase", "Required": false }, { "Name": "order_method", "DisplayName": "Merchant | Order method", "Type": "enum", "Description": "The method used to make the order.", "Values": [ { "Name": "delayed_payment", "DisplayName": "Delayed payment" }, { "Name": "invoice", "DisplayName": "Invoice" }, { "Name": "ecommerce", "DisplayName": "E-commerce" }, { "Name": "mail_order", "DisplayName": "Mail order" }, { "Name": "installment", "DisplayName": "Installment" } ], "Group": "general/purchase", "Required": false }, { "Name": "os_lang", "DisplayName": "OS | Language", "Type": "string", "Description": "Language of the operating system on the customer's device.", "Examples": [ "en-GB" ], "Group": "general/device", "Required": false }, { "Name": "os_ts", "DisplayName": "OS | Timestamp", "Type": "timestamp", "Description": "The operating system timestamp at the time of the purchase.", "Examples": [ "2017-12-03T11:52:06Z" ], "Group": "general/device", "Required": false }, { "Name": "os_type", "DisplayName": "OS | Type", "Type": "string", "Description": "Type of the customer's operating system.", "Examples": [ "iOS 10.1.1" ], "Group": "general/device", "Required": false }, { "Name": "os_version", "DisplayName": "OS | Version", "Type": "string", "Description": "The version of the operating system on the customer's device.", "Examples": [ "macOS Mojave 10.14.3" ], "Group": "general/device", "Required": false }, { "Name": "packstation_id_dp", "DisplayName": "Shipping address | DHL Packstation ID", "Type": "string", "Description": "A 3-digit ID of a DHL Packstation. Use this datapoint in rules if you're sending this information in the API request. If you'd like this information to be calculated by shufti, use 'packstation_id' instead. Make sure you send the datapoint 'ship_ad_line1' in this case.", "Examples": [ "123", "445" ], "Group": "general/shipping_address", "Required": false }, { "Name": "password_update_ts", "DisplayName": "Account | Password update timestamp", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating when the customer last updated their password on the e-commerce platform.", "Group": "general/account", "Required": false }, { "Name": "phone", "DisplayName": "Customer | Phone", "Type": "string", "Description": "The phone number of the customer.", "Examples": [ "+49(0)8144111100" ], "Group": "general/customer_identity", "Required": false }, { "Name": "phone_mobile", "DisplayName": "Customer | Mobile phone number", "Type": "string", "Description": "The customer's mobile phone number.", "Examples": [ "017624225600" ], "Group": "general/customer_identity", "Required": false }, { "Name": "phone_type", "DisplayName": "Phone | Type", "Type": "string", "Description": "The type of the phone used by the customer.", "Examples": [ "Work" ], "Group": "general/customer_identity", "Required": false }, { "Name": "phone_work", "DisplayName": "Phone | Work", "Type": "string", "Description": "The phone number of the customer marked as the work phone.", "Examples": [ "+49(0)8144111100" ], "Group": "general/customer_identity", "Required": false }, { "Name": "platform_id", "DisplayName": "Platform ID", "Type": "string", "Description": "The name of the payment platform.", "Examples": [ "GlobalCollect" ], "Group": "general/merchant", "Required": false }, { "Name": "pmt_due_date", "DisplayName": "Open invoice | Payment due date", "Type": "date", "Description": "The date on which the invoice payment is due.", "Examples": [ "2018-01-25Z" ], "Group": "payment_method/bank_transfer", "Required": false }, { "Name": "pmt_method", "DisplayName": "Transaction | Payment method", "Type": "enum", "Description": "The payment method used for the transaction.", "Values": [ { "Name": "cash", "DisplayName": "Cash" }, { "Name": "direct_debit", "DisplayName": "Direct debit" }, { "Name": "bnpl", "DisplayName": "BNPL" }, { "Name": "banking_transfer", "DisplayName": "Bank transfer" }, { "Name": "wallet", "DisplayName": "Digital wallet" }, { "Name": "card", "DisplayName": "Cards" }, { "Name": "prepaid_voucher_giftcard", "DisplayName": "Pre-paids / vouchers / giftcards" }, { "Name": "mobile", "DisplayName": "Mobile" } ], "Group": "payment_method/general", "Required": false }, { "Name": "pmt_method_brand", "DisplayName": "Transaction | Payment method brand", "Type": "enum", "Description": "Indicates the specific payment method brand used by the customer.", "Values": [ { "Name": "affirm", "DisplayName": "Affirm" }, { "Name": "afterpay", "DisplayName": "Afterpay" }, { "Name": "alipay", "DisplayName": "Alipay" }, { "Name": "amazon_pay", "DisplayName": "Amazon Pay" }, { "Name": "apple_pay", "DisplayName": "Apple Pay" }, { "Name": "bancontact", "DisplayName": "Bancontact" }, { "Name": "billpay", "DisplayName": "BillPay" }, { "Name": "bonus_card", "DisplayName": "Bonuscard" }, { "Name": "eprzelewy24", "DisplayName": "Przelewy24" }, { "Name": "eps", "DisplayName": "eps" }, { "Name": "giropay", "DisplayName": "giropay" }, { "Name": "google_pay", "DisplayName": "Google Pay" }, { "Name": "ideal", "DisplayName": "iDEAL" }, { "Name": "myone", "DisplayName": "myOne" }, { "Name": "oney", "DisplayName": "Oney" }, { "Name": "jaccs", "DisplayName": "JACCS" }, { "Name": "konbini", "DisplayName": "Konbini" }, { "Name": "paybright", "DisplayName": "PayBright" }, { "Name": "paydirekt", "DisplayName": "paydirekt" }, { "Name": "paypal", "DisplayName": "PayPal" }, { "Name": "postfinance", "DisplayName": "PostFinance" }, { "Name": "rakuten_pay", "DisplayName": "Rakuten Pay" }, { "Name": "sepa", "DisplayName": "SEPA" }, { "Name": "sofort", "DisplayName": "SOFORT" }, { "Name": "twint", "DisplayName": "TWINT" }, { "Name": "masterpass", "DisplayName": "Masterpass" }, { "Name": "visa_checkout", "DisplayName": "Visa Checkout" }, { "Name": "trustly", "DisplayName": "Trustly" }, { "Name": "billink", "DisplayName": "Billink" }, { "Name": "bancontact_mobile", "DisplayName": "Bancontact mobile" }, { "Name": "belfius", "DisplayName": "Belfius" }, { "Name": "blik", "DisplayName": "BLIK" }, { "Name": "coupons", "DisplayName": "Coupons" }, { "Name": "credit_cards", "DisplayName": "Credit cards" }, { "Name": "cryptocurrency", "DisplayName": "Cryptocurrency" }, { "Name": "dotpay", "DisplayName": "Dotpay" }, { "Name": "klarna_pay_now", "DisplayName": "Klarna Pay Now (Sofort)" }, { "Name": "klarna_pay_later", "DisplayName": "Klarna Pay Later" }, { "Name": "mb_way", "DisplayName": "MB WAY" }, { "Name": "mobile_pay", "DisplayName": "MobilePay" }, { "Name": "multibanco", "DisplayName": "Multibanco" }, { "Name": "my_bank", "DisplayName": "MyBank" }, { "Name": "neteller", "DisplayName": "NETELLER" }, { "Name": "paysafecard", "DisplayName": "paysafecard" }, { "Name": "paysera", "DisplayName": "Paysera" }, { "Name": "payshop", "DisplayName": "Payshop" }, { "Name": "paytrail", "DisplayName": "Paytrail" }, { "Name": "rapid_transfer", "DisplayName": "Rapid Transfer" }, { "Name": "skrill", "DisplayName": "Skrill" }, { "Name": "swish", "DisplayName": "Swish" }, { "Name": "vipps", "DisplayName": "Vipps" }, { "Name": "zimpler", "DisplayName": "Zimpler" }, { "Name": "kbc_cbc", "DisplayName": "KBC/CBC" }, { "Name": "cashpresso", "DisplayName": "cashpresso" }, { "Name": "mondu", "DisplayName": "Mondu" }, { "Name": "mondu_installments", "DisplayName": "Mondu installments" } ], "Group": "payment_method/general", "Required": false }, { "Name": "postnummer_dp", "DisplayName": "Shipping address | Personal customer number", "Type": "string", "Description": "The personal customer number (Postnummer) used at the DHL Packstation. Use this datapoint in rules if you're sending this information in the API request. If you'd like this information to be calculated by shufti, use 'postnummer' instead. Make sure you send the datapoint 'ship_ad_line1' in this case.", "Examples": [ "12345678", "44566741" ], "Group": "general/shipping_address", "Required": false }, { "Name": "purchase_extra_services", "DisplayName": "Purchase | Extra services ordered", "Type": "enum", "Description": "Indicates any extra services that were ordered with the purchase.", "Values": [ { "Name": "preselected_seats", "DisplayName": "Preselected seats", "Description": "The customer preselected seats for their journey." }, { "Name": "priority_boarding", "DisplayName": "Priority boarding", "Description": "The customer ordered priority boarding." }, { "Name": "flex_fee", "DisplayName": "Flex fee", "Description": "The customer ordered the ability to change the ticket dates." }, { "Name": "hotel_transfer", "DisplayName": "Hotel transfer", "Description": "The customer ordered a hotel transfer." }, { "Name": "lounge_transfer", "DisplayName": "Lounge transfer", "Description": "The customer ordered a lounge transfer." }, { "Name": "meet_and_greet", "DisplayName": "Meet-and-greet transfer", "Description": "The customer ordered a special service where the driver is waiting for the customer at the arrivals hall holding a sign with their name." }, { "Name": "a_la_carte_menu", "DisplayName": "À la carte menu", "Description": "The customer ordered special foods or menu for their journey." }, { "Name": "check_in_baggage", "DisplayName": "Check-in baggage", "Description": "The customer ordered check-in baggage." }, { "Name": "additional_hand_baggage", "DisplayName": "Additional hand baggage", "Description": "The customer ordered additional hand baggage." }, { "Name": "flight_insurance", "DisplayName": "Flight insurance", "Description": "The customer ordered trip insurance." }, { "Name": "medical_insurance", "DisplayName": "Medical insurance", "Description": "The customer ordered medical insurance." }, { "Name": "car_rental", "DisplayName": "Car rental", "Description": "The customer ordered a car rental." }, { "Name": "hotel_reservation", "DisplayName": "Hotel reservation", "Description": "The customer ordered a hotel reservation." }, { "Name": "sightseeing_tour", "DisplayName": "Sightseeing tour", "Description": "The customer ordered a sightseeing tour." }, { "Name": "other", "DisplayName": "Other", "Description": "An extra service that is not covered by the available values." }, { "Name": "private_parking", "DisplayName": "Private parking", "Description": "The customer ordered a private parking." }, { "Name": "wellness", "DisplayName": "Wellness", "Description": "The customer ordered wellness services, i.e. spa, massages, etc." }, { "Name": "meeting_banquet", "DisplayName": "Meeting facilities", "Description": "The customer ordered meeting/banquet facilities." }, { "Name": "location_pickup", "DisplayName": "Pickup", "Description": "The customer wants to be picked up at a location, i.e. at the airport." }, { "Name": "location_dropoff", "DisplayName": "Dropoff", "Description": "The customer wants to be dropped off at a location, i.e. at the airport." } ], "Group": "general/purchase", "Required": false }, { "Name": "recurrence_type", "DisplayName": "Transaction | Recurrence type", "Type": "string", "Description": "Specifies what recurrence type the transaction has. Only relevant to recurrent transactions.", "Examples": [ "FirstRecurring" ], "Group": "general/transaction", "Required": false }, { "Name": "region_locked", "DisplayName": "Purchase | Region locked", "Type": "enum", "Description": "Region locking prevents a product from being purchased and/or used outside of a region. The datapoint specifies if an item is locked to a specific region, i.e. can only be bought/used in that region. Often applies to video games or digital products.", "ValuesRef": "country_region", "Group": "general/purchase", "Required": false }, { "Name": "sales_channel", "DisplayName": "Transaction | Sales channel", "Type": "enum", "Description": "The transaction's sales channel.", "Values": [ { "Name": "b2b", "DisplayName": "B2B", "Description": "Business-to-business sales revolve around transactions that sell products and services to other businesses, instead of individual consumers." }, { "Name": "b2c", "DisplayName": "B2C", "Description": "Business-to-consumer sales revolve around transactions between a company and its individual consumers. These deals tend to be of lower price-value and complexity than B2B sales." }, { "Name": "agency_sales", "DisplayName": "Agency sales", "Description": "This type of sales involves generating and converting new leads to sign onto service packages from an agency." }, { "Name": "online_sales", "DisplayName": "Online sales", "Description": "The type of sales that refer to companies selling products exclusively online." }, { "Name": "offline_sales", "DisplayName": "Offline sales", "Description": "The type of sales that refer to companies selling products exclusively offline, i.e. in stores and markets." }, { "Name": "other", "DisplayName": "Other", "Description": "Any other type of sales not covered by the existing values." } ], "Group": "general/purchase", "Required": false }, { "Name": "scndry_phone", "DisplayName": "Customer | Secondary phone", "Type": "string", "Description": "The secondary phone number of the customer.", "Examples": [ "017624225600" ], "Group": "general/customer_identity", "Required": false }, { "Name": "screen_dpi", "DisplayName": "Screen | DPI", "Type": "string", "Description": "The DPI (dots per inch) value of customer's screen.", "Examples": [ "120 x 120" ], "Group": "general/device", "Required": false }, { "Name": "screen_x", "DisplayName": "Screen | Horizontal resolution", "Type": "string", "Description": "The horisontal (x-axis) value of the customer's screen resolution.", "Examples": [ "800" ], "Group": "general/device", "Required": false }, { "Name": "screen_y", "DisplayName": "Screen | Vertical resolution", "Type": "string", "Description": "The vertical (y-axis) value of the customer's screen resolution.", "Examples": [ "600" ], "Group": "general/device", "Required": false }, { "Name": "seller_id", "DisplayName": "Merchant | ID", "Type": "string", "Description": "The identification code of the merchant.", "Examples": [ "ABG826" ], "Group": "general/merchant", "Required": false }, { "Name": "ship_ad_city", "DisplayName": "Shipping address | City", "Type": "string", "Description": "The city on the shipping address.", "Examples": [ "London" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_city_norm_dp", "DisplayName": "Shipping address | City normalized by the payment company", "Type": "string", "Description": "The normalized value of the city on the shipping address provided by the payment company.", "Examples": [ "buenosaires", "newyork" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_ctry", "DisplayName": "Shipping address | Country", "Type": "enum", "Description": "The country on the shipping address. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_ctry_norm_dp", "DisplayName": "Shipping address | Country normalized by payment company", "Type": "enum", "Description": "The normalized value of the country on the shipping address provided by the payment company.", "ValuesRef": "country_code_iso", "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_email", "DisplayName": "Shipping address | Email", "Type": "string", "Description": "The email address of the customer on the shipping address.", "Examples": [ "grace.hopper@example.com" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_first_name", "DisplayName": "Shipping address | First name", "Type": "string", "Description": "The first name of the customer on the shipping address.", "Examples": [ "Grace" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_house_num", "DisplayName": "Shipping address | House number", "Type": "string", "Description": "The house number on the shipping address.", "Examples": [ "7", "27/4" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_house_num_norm_dp", "DisplayName": "Shipping address | House number normalized by payment company", "Type": "string", "Description": "The normalized value of the house number on the shipping address provided by the payment company.", "Examples": [ "4", "40" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_last_name", "DisplayName": "Shipping address | Last name", "Type": "string", "Description": "The last name of the customer on the shipping address.", "Examples": [ "Hopper" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_line1", "DisplayName": "Shipping address | Street and building number", "Type": "string", "Description": "The street and building number on the shipping address.", "Examples": [ "44 Ashgrove Road" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_line1_norm_dp", "DisplayName": "Shipping address | Street and building number normalized by payment company", "Type": "string", "Description": "The normalized value of the street and building number on the shipping address provided by the payment company.", "Examples": [ "44 Ashgrove Road" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_line2", "DisplayName": "Shipping address | Apartment number", "Type": "string", "Description": "The apartment or flat number on the shipping address.", "Examples": [ "Apt. 4" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_line3", "DisplayName": "Shipping address | Additional info", "Type": "string", "Description": "Further additional address information on the shipping address.", "Examples": [ "2nd floor – left side", "2nd floor" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_line3_norm_dp", "DisplayName": "Shipping address | Additional info normalized", "Type": "string", "Description": "The normalized value of additional details on the shipping address.", "Examples": [ "2nd floor" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_middle_name", "DisplayName": "Shipping address | Middle name", "Type": "string", "Description": "The middle name of the customer on the shipping address.", "Examples": [ "Brewster Murray" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_name", "DisplayName": "Shipping address | Full name", "Type": "string", "Description": "The full name of the customer on the shipping address. Use this datapoint when a customer sends their full name in one field, as opposed to sending their first, middle, and last name in separate fields.", "Examples": [ "Grace Brewster Murray Hopper" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_phone", "DisplayName": "Shipping address | Phone number", "Type": "string", "Description": "The phone number that the customer specified for the shipping address.", "Examples": [ "030-4247582047" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_state", "DisplayName": "Shipping address | State", "Type": "string", "Description": "The state or another unit of administrative division on the shipping address.", "Examples": [ "New York", "Bavaria" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_zip", "DisplayName": "Shipping address | Postal code", "Type": "string", "Description": "The postal code on the shipping address.", "Examples": [ "10179" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_ad_zip_norm_dp", "DisplayName": "Shipping address | Postal code normalized by payment company", "Type": "string", "Description": "The normalized value of the postal code on the shipping address provided by the payment company.", "Examples": [ "10179" ], "Group": "general/shipping_address", "Required": false }, { "Name": "ship_comments", "DisplayName": "Purchase | Shipping comments", "Type": "string", "Description": "Additional comments regarding the shipping of the goods.", "Examples": [ "Deliver to the neighbor." ], "Group": "general/purchase", "Required": false }, { "Name": "ship_giftcard_message", "DisplayName": "Gift card | Shipping message", "Type": "string", "Description": "The message of the shipping gift card.", "Examples": [ "Happy birthday!" ], "Group": "general/purchase", "Required": false }, { "Name": "ship_giftcard_type", "DisplayName": "Gift card | Type", "Type": "string", "Description": "The type of gift card being shipped.", "Examples": [ "Grandparents Day" ], "Group": "general/purchase", "Required": false }, { "Name": "ship_more", "DisplayName": "Purchase | Additional shipping comments", "Type": "string", "Description": "Additional shipping information.", "Examples": [ "4th floor – left side" ], "Group": "general/purchase", "Required": false }, { "Name": "ship_name_title", "DisplayName": "Shipping address | Courtesy title", "Type": "string", "Description": "The courtesy title of the customer on the shipping address.", "Examples": [ "Dr." ], "Group": "general/shipping_address", "Required": false }, { "Name": "slr_asp", "DisplayName": "Merchant | Average sales price", "Type": "float", "Description": "The ASP (average sales price) of the merchant.", "Examples": [ "5.99" ], "Group": "general/merchant", "Required": false }, { "Name": "slr_crncy", "DisplayName": "Merchant | Currency", "Type": "enum", "Description": "The operating currency of the merchant.", "ValuesRef": "currency_codes", "Group": "general/merchant", "Required": false }, { "Name": "slr_ctry", "DisplayName": "Merchant | Country", "Type": "enum", "Description": "The country where the merchant operates. An ISO 3166-1 alpha-2 code. You can either have this configured in the configuration service or send this information in the API request.", "ValuesRef": "country_code_iso", "Group": "general/merchant", "Required": false }, { "Name": "slr_ind", "DisplayName": "Merchant | Industry", "Type": "string", "Description": "The industry where the merchant operates. You can either have this configured in the configuration service or send this information in the API request.", "Examples": [ "Perfumery/duty free" ], "Group": "general/merchant", "Required": false }, { "Name": "slr_ind_cat", "DisplayName": "Merchant | Industry category", "Type": "string", "Description": "The industry category of the merchant. You can either have this configured in the configuration service or send this information in the API request.", "Examples": [ "3 Retail" ], "Group": "general/merchant", "Required": false }, { "Name": "slr_ind_mcc", "DisplayName": "Merchant | MCC", "Type": "string", "Description": "The MCC (merchant category code) of the merchant. You can either have this configured in the configuration service or send this information in the API request.", "Examples": [ "5641" ], "Group": "general/merchant", "Required": false }, { "Name": "slr_name", "DisplayName": "Merchant | Name", "Type": "string", "Description": "The name of the merchant. You can either have this configured in the configuration service or send this information in the API request.", "Examples": [ "Square Enix" ], "Group": "general/merchant", "Required": false }, { "Name": "sub_seller", "DisplayName": "Sub-merchant | ID", "Type": "string", "Description": "The identification code of the sub-merchant.", "Examples": [ "8897" ], "Group": "general/merchant", "Required": false }, { "Name": "subscription_active", "DisplayName": "Purchase | Subscription active", "Type": "bool", "Description": "Indicates if the customer has an active subscription with the merchant.", "Group": "general/purchase", "Required": false }, { "Name": "subscription_end_date", "DisplayName": "Purchase | Subscription end date", "Type": "date", "Description": "Indicates the end date of an active subscription. If there is no active subscription available, use this datapoint to indicate the end date of the most recent subscription. The date part of an RFC3339-encoded UTC timestamp.", "Examples": [ "2021-10-04T" ], "Group": "general/purchase", "Required": false }, { "Name": "support_cookie", "DisplayName": "Browser | Cookie support", "Type": "bool", "Description": "Indicates if the user's browser supports and is not blocking cookies.", "Group": "general/device", "Required": false }, { "Name": "support_flash", "DisplayName": "Browser | Flash support", "Type": "bool", "Description": "Indicates if the user's browser supports Flash.", "Group": "general/device", "Required": false }, { "Name": "support_geo", "DisplayName": "Browser | Geolocation support", "Type": "bool", "Description": "Indicates if the user's browser supports geolocation.", "Group": "general/device", "Required": false }, { "Name": "support_java", "DisplayName": "Browser | Java support", "Type": "bool", "Description": "Indicates if the user's browser supports Java.", "Group": "general/device", "Required": false }, { "Name": "support_js", "DisplayName": "Browser | JavaScript support", "Type": "bool", "Description": "Indicates if the user's browser supports JavaScript.", "Group": "general/device", "Required": false }, { "Name": "third_party_booking", "DisplayName": "Purchase | Third-party booking", "Type": "bool", "Description": "Indicates whether the booking was made by a third-party entity.", "Group": "general/purchase", "Required": false }, { "Name": "ticket_currency", "DisplayName": "Purchase | Ticket currency", "Type": "enum", "Description": "The SO-3 currency code in which 'ticket_price' is given.", "ValuesRef": "currency_codes", "Group": "general/purchase", "Required": false }, { "Name": "ticket_device_used", "DisplayName": "Purchase | Device and app type", "Type": "enum", "Description": "Indicates the device and app type used to make the booking for a ticket.", "Values": [ { "Name": "mobile_browser", "DisplayName": "Mobile browser", "Description": "Mobile phone (in the browser)" }, { "Name": "mobile_app", "DisplayName": "Mobile app", "Description": "Mobile phone (in the app)" }, { "Name": "desktop", "DisplayName": "Desktop", "Description": "Desktop computer (in the browser)" }, { "Name": "tablet_browser", "DisplayName": "Tablet browser", "Description": "Tablet (in the browser)" }, { "Name": "tablet_app", "DisplayName": "Tablet app", "Description": "Tablet (in the app)" } ], "Group": "general/purchase", "Required": false }, { "Name": "ticket_exchange_fee", "DisplayName": "Ticket | Exchange fee", "Type": "float", "Description": "The fee applied for exchanging an issued ticket.", "Examples": [ "50,00" ], "Group": "general/purchase", "Required": false }, { "Name": "ticket_issue_date", "DisplayName": "Ticket | Issue date", "Type": "timestamp", "Description": "An RFC3339-encoded UTC timestamp indicating the date when the ticket was issued.", "Examples": [ "2021-10-04T15:20:44" ], "Group": "general/purchase", "Required": false }, { "Name": "ticket_itinerary_legs_count", "DisplayName": "Ticket | Itinerary legs", "Type": "int", "Description": "Trip path information, i.e. the number of legs in the itinerary.", "Examples": [ "2" ], "Group": "general/purchase", "Required": false }, { "Name": "ticket_price", "DisplayName": "Purchase | Ticket price", "Type": "float", "Description": "The full price of the ticket before any discounts or vouchers are applied.", "Examples": [ "349" ], "Group": "general/purchase", "Required": false }, { "Name": "ticket_transaction_type", "DisplayName": "Ticket | Transaction type", "Type": "enum", "Description": "The type of transaction carried out for the ticket.", "Values": [ { "Name": "exchange", "DisplayName": "Ticket exchange", "Description": "Ticket exchange" }, { "Name": "misc", "DisplayName": "Miscellaneous", "Description": "Not a ticket purchase and not a transaction related to a ticket exchange." }, { "Name": "refund", "DisplayName": "Ticket refund", "Description": "Ticket refund" }, { "Name": "purchase", "DisplayName": "Ticket purchase", "Description": "Ticket purchase" } ], "Group": "general/purchase", "Required": false }, { "Name": "time_from_first_visit", "DisplayName": "Purchase | Time from first visit", "Type": "int", "Description": "Indicates the number of days that have passed from the moment a customer first visited the e-commerce site and the moment when they initiated the transaction. This period of time covers multiple browser sessions.", "Group": "general/purchase", "Required": false }, { "Name": "time_to_purchase", "DisplayName": "Purchase | Time to purchase", "Type": "int", "Description": "Indicates the number of seconds that have passed from the moment a customer accessed the e-commerce website to the moment when they initiated the transaction. Use this datapoint to indicate the time within one browser session.", "Group": "general/purchase", "Required": false }, { "Name": "trans_amt", "DisplayName": "Transaction | Amount", "Type": "float", "Description": "The transaction amount in the original currency.", "Examples": [ "23.15" ], "Group": "general/transaction", "Required": false }, { "Name": "trans_currency", "DisplayName": "Transaction | Currency", "Type": "enum", "Description": "SO-3 currency code in which 'trans_amt' is given.", "ValuesRef": "currency_codes", "Group": "general/transaction", "Required": false }, { "Name": "trans_id", "DisplayName": "Transaction | ID", "Type": "string", "Description": "The ID of the transaction as identified by the PSP. Do not to confuse with the ID assigned by the merchant ('order_id') or the transaction ID created by shufti ('frg_trans_id').", "Examples": [ "X1234567" ], "Group": "general/transaction", "Required": true }, { "Name": "trans_is_b2b", "DisplayName": "Transaction | Is B2B", "Type": "bool", "Description": "Indicates if the transaction is a B2B transaction.", "Group": "general/transaction", "Required": false }, { "Name": "trans_status", "DisplayName": "Transaction | Status", "Type": "string", "Description": "Specifies the transaction approval status communicated by the client.", "Examples": [ "Approved", "Declined" ], "Group": "general/transaction", "Required": false }, { "Name": "trans_ts", "DisplayName": "Transaction | Timestamp", "Type": "timestamp", "Description": "Transaction timestamp reported by the client.", "Examples": [ "2009-11-10T23:00:00Z" ], "Group": "general/transaction", "Required": false }, { "Name": "voucher_used", "DisplayName": "Purchase | Promo voucher used", "Type": "bool", "Description": "Indicates if the item was purchased with a promo voucher.", "Group": "general/purchase", "Required": false }, { "Name": "transaction_type", "DisplayName": "Transaction | Type", "Type": "string", "Description": "High-level transaction type used for rule logic. Typical values: deposit, withdrawal, trade, transfer, conversion, fee, refund. Letters and spaces only, up to 100 characters.", "Examples": [ "deposit", "transfer" ], "Group": "general/transaction", "Required": false }, { "Name": "cust_account_balance", "DisplayName": "Customer | Account balance", "Type": "float", "Description": "The balance of the customer's account in the merchant's database. A number from 0 to 999999999999.99.", "Examples": [ "8500.00" ], "Group": "general/customer_identity", "Required": false }, { "Name": "source_of_wealth", "DisplayName": "Customer | Source of wealth", "Type": "string", "Description": "Declared source of the customer's wealth or funds, for example salary, inheritance or business income. Letters, spaces and hyphens only.", "Examples": [ "Business Income", "Salary" ], "Group": "general/customer_identity", "Required": false }, { "Name": "bin_brand", "DisplayName": "BIN | Brand", "Type": "string", "Description": "The card brand of the customer's payment method. Letters and spaces only, up to 50 characters.", "Examples": [ "Mastercard", "Visa" ], "Group": "payment_method/cards", "Required": false }, { "Name": "beneficiary_id", "DisplayName": "Beneficiary | ID as per merchant", "Type": "string", "Description": "The ID of the beneficiary in the merchant's database. Letters, digits, hyphens and underscores, up to 255 characters.", "Examples": [ "BEN7H9K2L4M6" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_name", "DisplayName": "Beneficiary | Full name", "Type": "string", "Description": "The full name of the beneficiary.", "Examples": [ "Michael Chen" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_email", "DisplayName": "Beneficiary | Email", "Type": "string", "Description": "The email address of the beneficiary. Must be a valid email address.", "Examples": [ "m.chen@example.com" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_dob", "DisplayName": "Beneficiary | Date of birth", "Type": "date", "Description": "The date of birth of the beneficiary. Cannot be in the future.", "Examples": [ "1992-07-18Z" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_phone", "DisplayName": "Beneficiary | Phone", "Type": "string", "Description": "The phone number of the beneficiary. Digits only, optionally starting with +.", "Examples": [ "+8613912345678" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_nationality", "DisplayName": "Beneficiary | Nationality", "Type": "string", "Description": "The nationality of the beneficiary.", "Examples": [ "Chinese" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_ba_bic", "DisplayName": "Beneficiary | Bank account | BIC", "Type": "string", "Description": "The BIC (bank identifier code) of the beneficiary's bank account. 8 to 11 uppercase letters and digits.", "Examples": [ "ICBKCNBJ110" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_ba_iban", "DisplayName": "Beneficiary | Bank account | IBAN", "Type": "string", "Description": "The IBAN (international bank account number) of the beneficiary's bank account. Up to 34 uppercase letters and digits.", "Examples": [ "GB82WEST12345698765432" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_ba_name", "DisplayName": "Beneficiary | Bank account | Account holder full name", "Type": "string", "Description": "The full name of the beneficiary's bank account holder.", "Examples": [ "Michael Chen" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_ba_rtn_num", "DisplayName": "Beneficiary | Bank account | Routing number", "Type": "string", "Description": "The routing number of the beneficiary's bank account. Exactly 9 digits.", "Examples": [ "121000248" ], "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_bin_ctry", "DisplayName": "Beneficiary | BIN | Country", "Type": "enum", "Description": "The country of the card issuer for the beneficiary's payment method. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "beneficiary", "Required": false }, { "Name": "beneficiary_bin_brand", "DisplayName": "Beneficiary | BIN | Brand", "Type": "string", "Description": "The card brand of the beneficiary's payment method. Letters and spaces only, up to 50 characters.", "Examples": [ "UnionPay" ], "Group": "beneficiary", "Required": false }, { "Name": "aml_screening", "DisplayName": "AML Screening", "Type": "object", "Description": "AML screening object for the customer.", "Group": "aml_screening", "Required": false }, { "Name": "aml_screening.name", "DisplayName": "AML Screening Name", "Type": "object", "Description": "Name object used for AML screening checks.", "Group": "aml_screening", "Required": false }, { "Name": "aml_screening.name.full_name", "DisplayName": "AML Screening Full Name", "Type": "string", "Description": "Customer full name used for AML screening.", "Examples": [ "Sarah Martinez" ], "Group": "aml_screening", "Required": false }, { "Name": "aml_screening.filters", "DisplayName": "AML Screening Filters", "Type": "string[]", "Description": "AML filters to apply during screening.", "Examples": [ "Sanctions", "PEP" ], "Group": "aml_screening", "Required": false }, { "Name": "beneficiary_aml_screening", "DisplayName": "Beneficiary AML Screening", "Type": "object", "Description": "AML screening object for beneficiary screening.", "Group": "beneficiary_aml_screening", "Required": false }, { "Name": "beneficiary_aml_screening.name", "DisplayName": "Beneficiary AML Screening Name", "Type": "object", "Description": "Name object used for beneficiary AML checks.", "Group": "beneficiary_aml_screening", "Required": false }, { "Name": "beneficiary_aml_screening.name.full_name", "DisplayName": "Beneficiary AML Screening Full Name", "Type": "string", "Description": "Beneficiary full name used for AML screening.", "Examples": [ "Michael Chen" ], "Group": "beneficiary_aml_screening", "Required": false }, { "Name": "beneficiary_aml_screening.filters", "DisplayName": "Beneficiary AML Screening Filters", "Type": "string[]", "Description": "AML filters to apply for beneficiary screening.", "Examples": [ "Sanctions", "Adverse Media" ], "Group": "beneficiary_aml_screening", "Required": false }, { "Name": "agent_ctry", "DisplayName": "Agent | Country", "Type": "enum", "Description": "The country of the remittance agent handling the transaction, where the client operates through third-party agents. Distinct from slr_ctry (the merchant's own country) and ba_branch (the customer's bank branch) - neither models a remittance agent.", "ValuesRef": "country_code_iso", "Group": "general/beneficiary_identity", "Required": false }, { "Name": "amount_cad", "DisplayName": "Transaction | Amount in CAD as supplied", "Type": "float", "Description": "The Canadian-dollar value of the transaction as supplied by the client, converted at the client's own rate and time.", "Examples": [ "10000.00" ], "Group": "general/transaction", "Required": false }, { "Name": "asset_class", "DisplayName": "Transaction | Asset class", "Type": "enum", "Description": "Whether the transaction moves fiat money or virtual currency. Supplied by the client.", "Values": [ { "Name": "FIAT", "DisplayName": "Fiat" }, { "Name": "VC", "DisplayName": "Virtual currency" } ], "Group": "general/transaction", "Required": false }, { "Name": "beneficial_owner_entity_type", "DisplayName": "Beneficial owner | Entity Type", "Type": "enum", "Description": "Whether the beneficial owner is a natural person or a legal entity. Decides how beneficial_owner_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "beneficial_owner_name", "DisplayName": "Beneficial owner | Name", "Type": "string", "Description": "The full name of the account holder's beneficial owner. Used to screen the beneficial owner.", "Examples": [ "Maria Garcia" ], "Group": "general/transaction", "Required": false }, { "Name": "beneficiary_identified", "DisplayName": "Beneficiary | Identified", "Type": "bool", "Description": "Whether the beneficiary is an identified party rather than only a destination address.", "Group": "general/beneficiary_identity", "Required": false }, { "Name": "beneficiary_idv_status", "DisplayName": "Beneficiary | Identity verification status", "Type": "string", "Description": "The outcome of identity verification on the beneficiary, as recorded by the client. Distinct from beneficiary_aml_screening_status, which is a sanctions and watchlist result rather than an identity check.", "Examples": [ "VERIFIED", "NOT_VERIFIED", "PENDING" ], "Group": "general/beneficiary_identity", "Required": false }, { "Name": "beneficiary_wallet_address", "DisplayName": "Beneficiary | Wallet address", "Type": "string", "Description": "The blockchain address the virtual-currency transfer was sent to.", "Examples": [ "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh" ], "Group": "general/beneficiary_identity", "Required": false }, { "Name": "bin_issuer", "DisplayName": "BIN | Issuer", "Type": "string", "Description": "The issuer of the credit card.", "Examples": [ "New Millenium Bank", "Deutsche Bank" ], "Group": "payment_method/cards", "Required": false }, { "Name": "bo_status", "DisplayName": "Customer | Beneficial ownership status", "Type": "string", "Description": "Whether beneficial ownership information has been collected and confirmed for a corporate customer, as recorded by the client.", "Examples": [ "CONFIRMED", "INCOMPLETE", "NOT_COLLECTED" ], "Group": "general/customer_identity", "Required": false }, { "Name": "branch_id", "DisplayName": "Transaction | Branch ID", "Type": "string", "Description": "The identifier of the physical branch or agent location where the transaction was initiated, as supplied by the client. Not the PSP transaction ID (see trans_id).", "Examples": [ "BR-0142" ], "Group": "general/transaction", "Required": false }, { "Name": "brand_id", "DisplayName": "Brand | ID", "Type": "string", "Description": "The identifier of the specific brand the customer transacted under, for clients operating multiple brands under one account structure. Free-form, client-defined - not a controlled vocabulary.", "Examples": [ "brand-eu-01" ], "Group": "general/customer_identity", "Required": false }, { "Name": "bulk_job_id", "DisplayName": "Transaction | Bulk job ID", "Type": "string", "Description": "Optional identifier that links a transaction to a bulk upload job.", "Examples": [ "0f9ef8c5-1a0a-4d56-8b53-9dfca7b4cf8b" ], "Group": "general/transaction", "Required": false }, { "Name": "cc_num_frg_token", "DisplayName": "Credit card | Encrypted number", "Type": "string", "Description": "A concatenation of the BIN, a salted hash of the credit card number and its last 4 digits. The first 6 digits are the BIN and the last 4 digits are actual last 4 digits of the credit card number.", "Examples": [ "123123sdfl234kfi355n21123sdfl234kfi355nsf2421" ], "Group": "payment_method/cards", "Required": false }, { "Name": "conductor_entity_type", "DisplayName": "Conductor | Entity Type", "Type": "enum", "Description": "Whether the party who conducted the transaction is a natural person or a legal entity. Decides how conductor_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "conductor_id", "DisplayName": "Conductor | ID as per merchant", "Type": "string", "Description": "The ID of the party who conducted the transaction, who may differ from the account holder it was conducted for.", "Examples": [ "COND12345", "98765" ], "Group": "general/transaction", "Required": false }, { "Name": "conductor_is_customer", "DisplayName": "Conductor | Is the account holder", "Type": "bool", "Description": "Whether the conductor of the transaction is the account holder themselves. False marks a transaction conducted by one party on another's account.", "Group": "general/transaction", "Required": false }, { "Name": "conductor_name", "DisplayName": "Conductor | Name", "Type": "string", "Description": "The full name of the party who conducted the transaction. Used to screen the conductor separately from the account holder.", "Examples": [ "Jane Doe" ], "Group": "general/transaction", "Required": false }, { "Name": "controlling_person_entity_type", "DisplayName": "Controlling person | Entity Type", "Type": "enum", "Description": "Whether the controlling person is a natural person or a legal entity. Decides how controlling_person_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "controlling_person_name", "DisplayName": "Controlling person | Name", "Type": "string", "Description": "The full name of the person controlling the account holder. Used to screen the controlling person.", "Examples": [ "Ahmed Khan" ], "Group": "general/transaction", "Required": false }, { "Name": "correspondent_account_id", "DisplayName": "Correspondent | Account ID", "Type": "string", "Description": "The account identifier of the correspondent bank used to route the payment, where the transaction passes through a correspondent banking relationship.", "Examples": [ "CORR-9981" ], "Group": "general/beneficiary_identity", "Required": false }, { "Name": "correspondent_bank_bic", "DisplayName": "Correspondent | Bank BIC", "Type": "string", "Description": "The BIC (bank identifier code) of the correspondent (intermediary) institution used to route the payment. Distinct from beneficiary_ba_bic, which is the beneficiary's own bank.", "Examples": [ "DEUTDEDBBER" ], "Group": "general/beneficiary_identity", "Required": false }, { "Name": "correspondent_bank_ctry", "DisplayName": "Correspondent | Bank Country", "Type": "enum", "Description": "The country of the correspondent (intermediary) institution used to route the payment. An ISO 3166-1 alpha-2 code.", "ValuesRef": "country_code_iso", "Group": "general/beneficiary_identity", "Required": false }, { "Name": "correspondent_bank_name", "DisplayName": "Correspondent | Bank Name", "Type": "string", "Description": "The name of the correspondent (intermediary) institution used to route the payment, where the transaction passes through a correspondent banking relationship. Distinct from beneficiary_ba_name, which is the beneficiary's own bank account holder.", "Examples": [ "Deutsche Bank AG" ], "Group": "general/beneficiary_identity", "Required": false }, { "Name": "counterparty_entity_type", "DisplayName": "Counterparty | Entity Type", "Type": "enum", "Description": "Whether the counterparty of the transaction is a natural person or a legal entity. Decides how counterparty_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "counterparty_name", "DisplayName": "Counterparty | Name", "Type": "string", "Description": "The full name of the transaction's counterparty. Used to screen the counterparty.", "Examples": [ "Acme Trading Ltd" ], "Group": "general/transaction", "Required": false }, { "Name": "cust_declared_monthly_income", "DisplayName": "Customer | Declared Monthly Income", "Type": "float", "Description": "The customer's self-declared monthly income, in the client's local currency. See cust_declared_monthly_income_eur for the normalised version.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_email_reputation_score", "DisplayName": "Customer | Email Reputation Score", "Type": "int", "Description": "A reputation score for the customer's email address, provided by a third-party provider of the client's choice or generated internally by the client. Same convention as device_score/device_reputation - the client sends the vendor's output, Fraugster does not compute it.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_employee_account_tag", "DisplayName": "Customer | Employee Account Tag", "Type": "bool", "Description": "Whether this customer account belongs to an employee of the client, as flagged by the client. Employee accounts are frequently excluded from certain monitoring rules or routed to a separate review queue.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_employer_name", "DisplayName": "Customer | Employer Name", "Type": "string", "Description": "The name of the customer's declared employer. Distinct from cust_name, which is the customer's own name.", "Examples": [ "Acme Logistics Ltd" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_expected_annual_activity", "DisplayName": "Customer | Expected Annual Activity", "Type": "float", "Description": "The customer's expected annual transaction volume as declared at onboarding, in the client's local currency.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_hours_since_identity_update", "DisplayName": "Customer | Hours Since Identity Update", "Type": "int", "Description": "The number of hours since the customer's identity or KYC profile was last updated by the client, as supplied by the client. There is no engine-side event stream for identity updates today, so this is raw client-computed data rather than an engine computation.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_id_doc_type", "DisplayName": "Customer | ID Document Type", "Type": "enum", "Description": "The type of identity document the customer used to verify their identity.", "Values": [ { "Name": "PASSPORT", "DisplayName": "Passport", "Description": "A passport." }, { "Name": "NATIONAL_ID", "DisplayName": "National ID", "Description": "A national identity card." }, { "Name": "DRIVERS_LICENSE", "DisplayName": "Driver's License", "Description": "A driver's license." }, { "Name": "OTHER", "DisplayName": "Other", "Description": "A document type not listed above." } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_identity_doc_num", "DisplayName": "Customer | Identity Document Number", "Type": "string", "Description": "The document number of the customer's identity document (see cust_id_doc_type for the document type).", "Examples": [ "P1234567" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_identity_inconsistency_flag", "DisplayName": "Customer | Identity Inconsistency Flag", "Type": "bool", "Description": "Whether the client's identity verification vendor flagged an inconsistency across the customer's supplied identity documents. Client/vendor-supplied, not Fraugster-computed.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_istr_flag", "DisplayName": "Customer | ISTR Flag", "Type": "enum", "Description": "Whether an Internal Suspicious Transaction Report has been raised against the customer.", "ValuesRef": "ttm_tristate", "Group": "add_on_service/sanctions_lists", "Required": false }, { "Name": "cust_kyc_expiry_date", "DisplayName": "Customer | KYC Expiry Date", "Type": "date", "Description": "The date on which the customer's current KYC verification expires and must be refreshed.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_kyc_tier", "DisplayName": "Customer | KYC Tier", "Type": "enum", "Description": "The level of KYC verification the customer has completed with the client.", "Values": [ { "Name": "BASIC", "DisplayName": "Basic" }, { "Name": "STANDARD", "DisplayName": "Standard" }, { "Name": "ENHANCED", "DisplayName": "Enhanced" } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_m_f", "DisplayName": "Customer | Gender", "Type": "enum", "Description": "The gender of the customer.", "Values": [ { "Name": "M", "DisplayName": "M" }, { "Name": "F", "DisplayName": "F" }, { "Name": "O", "DisplayName": "D" } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_phone_reputation_score", "DisplayName": "Customer | Phone Reputation Score", "Type": "int", "Description": "A reputation score for the customer's phone number, provided by a third-party provider of the client's choice or generated internally by the client.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_residency_status", "DisplayName": "Customer | Residency Status", "Type": "enum", "Description": "The customer's declared residency status relative to the client's jurisdiction.", "Values": [ { "Name": "RESIDENT", "DisplayName": "Resident", "Description": "Resident in the client's jurisdiction." }, { "Name": "NON_RESIDENT", "DisplayName": "Non-resident", "Description": "Not resident in the client's jurisdiction." }, { "Name": "UNKNOWN", "DisplayName": "Unknown", "Description": "Residency status was not supplied or could not be determined." } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_risk_rating", "DisplayName": "Customer | Risk Rating", "Type": "enum", "Description": "The client's own KYC/onboarding risk rating for the customer, as classified by the client's compliance process. Distinct from credit_risk_rating, which is Fraugster's ACD credit model output - a different scale measuring a different thing.", "Values": [ { "Name": "LOW", "DisplayName": "Low" }, { "Name": "MEDIUM", "DisplayName": "Medium" }, { "Name": "HIGH", "DisplayName": "High" } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_segment", "DisplayName": "Customer | Segment", "Type": "enum", "Description": "The client's own customer segmentation (e.g. retail, premium, business), distinct from m_segment which classifies the transaction rather than the customer.", "Values": [ { "Name": "RETAIL", "DisplayName": "Retail", "Description": "Standard retail customer." }, { "Name": "PREMIUM", "DisplayName": "Premium", "Description": "A premium or high-value tier customer." }, { "Name": "BUSINESS", "DisplayName": "Business", "Description": "A business customer." } ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_str_filed", "DisplayName": "Customer | STR Filed", "Type": "enum", "Description": "Whether a Suspicious Transaction Report has been filed with the regulator for this customer.", "ValuesRef": "ttm_tristate", "Group": "add_on_service/sanctions_lists", "Required": false }, { "Name": "cust_street_level_ad", "DisplayName": "Customer | Street-Level Address", "Type": "string", "Description": "The customer's full street-level address as a single field, where the client sends it more granularly than the existing acct_ad_line1/line2 fields.", "Examples": [ "221B Baker Street" ], "Group": "general/customer_identity", "Required": false }, { "Name": "cust_thin_file_flag", "DisplayName": "Customer | Thin File Flag", "Type": "bool", "Description": "Whether the client's credit bureau or identity vendor flagged the customer as having a 'thin file' (insufficient credit/identity history to assess). Client/vendor-supplied.", "Group": "general/customer_identity", "Required": false }, { "Name": "cust_type", "DisplayName": "Customer | Type", "Type": "enum", "Description": "The type of customer as classified by the client - individual, corporate, or a similar business-relationship distinction.", "Values": [ { "Name": "INDIVIDUAL", "DisplayName": "Individual", "Description": "A natural person." }, { "Name": "CORPORATE", "DisplayName": "Corporate", "Description": "A registered business entity." }, { "Name": "OTHER", "DisplayName": "Other", "Description": "A type not covered by the above, as classified by the client." } ], "Group": "general/customer_identity", "Required": false }, { "Name": "custom_threshold", "DisplayName": "Merchant | Custom threshold", "Type": "float", "Description": "A custom threshold value provided by the merchant, usable in rules or downstream logic.", "Examples": [ "1.5" ], "Group": "general/merchant", "Required": false }, { "Name": "dest_country", "DisplayName": "Transaction | Destination country", "Type": "enum", "Description": "The country the funds go to. An ISO 3166-1 alpha-2 code. Sent by the client where known; when it is not sent it is derived from the beneficiary's account - its IBAN, then its BIC (SWIFT code), then its card BIN - and, for money leaving the customer to their own account, from the customer's IBAN, BIC or card BIN. dest_country_source says which of these it came from.", "ValuesRef": "country_code_iso", "Group": "general/transaction", "Required": false }, { "Name": "device_id_shared_across_accounts", "DisplayName": "Device | ID shared across accounts", "Type": "bool", "Description": "Indicates whether the same device ID has been used by more than one customer account.", "Group": "general/device_id", "Required": false }, { "Name": "expected_monthly_volume", "DisplayName": "Transaction | Expected monthly volume", "Type": "float", "Description": "The expected monthly volume of the transaction in the original currency. The value is between 0 and 1000000.", "Examples": [ "10000.00" ], "Group": "general/transaction", "Required": false }, { "Name": "fireblocks_ref", "DisplayName": "Transaction | Fireblocks reference", "Type": "string", "Description": "The client's Fireblocks transaction reference, tracing a monitored transaction back to the custody platform that executed it.", "Examples": [ "fb_tx_8f3c21a0" ], "Group": "general/transaction", "Required": false }, { "Name": "from_asset", "DisplayName": "Transaction | Asset sent", "Type": "string", "Description": "The asset the transaction sends or converts FROM - a fiat currency code or a virtual-currency ticker.", "Examples": [ "CAD", "BTC", "USDT" ], "Group": "general/transaction", "Required": false }, { "Name": "fx_rate", "DisplayName": "Transaction | FX rate to CAD as supplied", "Type": "float", "Description": "The exchange rate the client applied to convert the transaction amount into amount_cad.", "Examples": [ "1.3642" ], "Group": "general/transaction", "Required": false }, { "Name": "fx_rate_source", "DisplayName": "Transaction | FX rate source as supplied", "Type": "string", "Description": "Where the client's exchange rate came from (provider or desk).", "Examples": [ "Bank of Canada" ], "Group": "general/transaction", "Required": false }, { "Name": "fx_timestamp", "DisplayName": "Transaction | FX rate timestamp as supplied", "Type": "timestamp", "Description": "The moment the client's exchange rate was taken. Expected to be close to trans_ts.", "Examples": [ "2026-10-14T09:30:00Z" ], "Group": "general/transaction", "Required": false }, { "Name": "grace_period_end_ts", "DisplayName": "Grace period end timestamp", "Type": "timestamp", "Description": "End of the grace period for deposits. Transactions with ts after this timestamp can be restricted by rules.", "Group": "general/transaction", "Required": false }, { "Name": "hs_code", "DisplayName": "Goods | HS Code", "Type": "string", "Description": "The Harmonized System commodity classification code for the traded goods. Distinct from goodies_score, which is Fraugster's unrelated ML classifier output.", "Examples": [ "8517.12" ], "Group": "general/purchase", "Required": false }, { "Name": "intermediary_fi_entity_type", "DisplayName": "Intermediary FI | Entity Type", "Type": "enum", "Description": "Whether the intermediary financial institution is a natural person or a legal entity. Decides how intermediary_fi_name is screened (as a person, or as a company/organization). Defaults to ENTITY when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "intermediary_fi_name", "DisplayName": "Intermediary FI | Name", "Type": "string", "Description": "The name of an intermediary financial institution (bank, payment institution, VASP, exchange, custodian or wallet provider) in the transaction. Used to screen it.", "Examples": [ "Royal Bank of Canada" ], "Group": "general/transaction", "Required": false }, { "Name": "is_self_transfer", "DisplayName": "Transaction | Is a self-transfer", "Type": "bool", "Description": "Whether the sender and the recipient of the transfer are the same person or entity. Supplied by the client.", "Group": "general/transaction", "Required": false }, { "Name": "merchant_entity_type", "DisplayName": "Merchant | Entity Type", "Type": "enum", "Description": "Whether the merchant is a natural person or a legal entity. Decides how merchant_name is screened (as a person, or as a company/organization). Defaults to ENTITY when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "merchant_name", "DisplayName": "Merchant | Name", "Type": "string", "Description": "The name of the merchant involved in the transaction. Used to screen the merchant.", "Examples": [ "Coffee Corner Inc" ], "Group": "general/transaction", "Required": false }, { "Name": "occupation", "DisplayName": "Customer | Occupation", "Type": "string", "Description": "The customer's stated occupation or line of business, used to judge whether observed activity is consistent with declared means.", "Examples": [ "Software engineer", "Retired", "Construction contractor" ], "Group": "general/customer_identity", "Required": false }, { "Name": "orig_country", "DisplayName": "Transaction | Origin country", "Type": "enum", "Description": "The country the funds come from. An ISO 3166-1 alpha-2 code. Sent by the client where known; when it is not sent it is derived from the paying instrument - the bank account IBAN, then its BIC (SWIFT code), then the card BIN - and only as a last resort from the IP address. orig_country_source says which of these it came from.", "ValuesRef": "country_code_iso", "Group": "general/transaction", "Required": false }, { "Name": "originator_entity_type", "DisplayName": "Originator | Entity Type", "Type": "enum", "Description": "Whether the originator of the transfer is a natural person or a legal entity. Decides how originator_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "originator_id", "DisplayName": "Originator | ID as per merchant", "Type": "string", "Description": "The ID of the party that originated the funds, used to detect many-senders-to-one-recipient patterns where the originator differs from the account holder.", "Examples": [ "ORIG12345", "98765" ], "Group": "general/transaction", "Required": false }, { "Name": "originator_name", "DisplayName": "Originator | Name", "Type": "string", "Description": "The full name of the party the funds originate from. Used to screen the originator.", "Examples": [ "John Smith" ], "Group": "general/transaction", "Required": false }, { "Name": "payment_service_provider", "DisplayName": "Transaction | Payment service provider (PSP)", "Type": "enum", "Description": "The name of the payment service provider or gateway routing the transaction (e.g., Adyen, Stripe, Checkout.com).", "Values": [ { "Name": "adyen", "DisplayName": "Adyen" }, { "Name": "stripe", "DisplayName": "Stripe" }, { "Name": "checkout.com", "DisplayName": "Checkout.com" }, { "Name": "worldpay", "DisplayName": "Worldpay" }, { "Name": "nuvei", "DisplayName": "Nuvei" } ], "Group": "general/transaction", "Required": false }, { "Name": "regions_or_blocked_regions", "DisplayName": "Merchant | Regions (blocked or allowed)", "Type": "string", "Description": "Comma-separated list of regions/country codes provided by the merchant. Can be used as blocked regions or for other custom purposes.", "Examples": [ "EU,NA" ], "Group": "general/merchant", "Required": false }, { "Name": "requester_idv_status", "DisplayName": "Requester | Identity verification status", "Type": "string", "Description": "The outcome of identity verification on the party requesting the transaction, as recorded by the client.", "Examples": [ "VERIFIED", "NOT_VERIFIED", "PENDING" ], "Group": "general/customer_identity", "Required": false }, { "Name": "rule_sets", "DisplayName": "Transaction | Rule Sets", "Type": "string[]", "Description": "Optional rule set classifier for rule segregation (string array, e.g. Gambling and Trading). Legacy comma-separated strings are still accepted. When omitted, only universal rules (without rule set tags) are evaluated.", "Examples": [ "[\"Gambling\", \"Trading\"]" ], "Group": "general/transaction", "Required": false }, { "Name": "rule_type", "DisplayName": "Transaction | Rule Type", "Type": "string", "Description": "A free-form classifier the client sends in the transaction payload to route the transaction to a specific rule set (e.g. 'topup', 'payout', 'transfer', 'kyc_review'). The value is opaque to the engine and is intended for use in rule conditions.", "Examples": [ "payout" ], "Group": "general/transaction", "Required": false }, { "Name": "sending_wallet_address", "DisplayName": "Transaction | Sending wallet address", "Type": "string", "Description": "The blockchain address the virtual-currency transfer was sent from.", "Examples": [ "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq" ], "Group": "general/transaction", "Required": false }, { "Name": "sof_declared", "DisplayName": "Customer | Source of funds declared", "Type": "string", "Description": "The source of funds the customer has declared for this relationship. The direct counterpart of source_of_wealth: wealth is what the customer has accumulated, funds are what is moving here.", "Examples": [ "Salary", "Business income", "Sale of property" ], "Group": "general/customer_identity", "Required": false }, { "Name": "sof_evidence_ref", "DisplayName": "Customer | Source of funds evidence reference", "Type": "string", "Description": "The client's reference to the evidence held for the declared source of funds, so a reviewer can retrieve the document behind the determination.", "Examples": [ "SOF-DOC-2026-00123" ], "Group": "general/customer_identity", "Required": false }, { "Name": "sof_review_date", "DisplayName": "Customer | Source of funds review date", "Type": "date", "Description": "The date the source of funds was last reviewed. An outdated review can be treated as a missing one, so rules typically read the age of this date rather than its presence.", "Examples": [ "2026-03-14Z" ], "Group": "general/customer_identity", "Required": false }, { "Name": "sof_status", "DisplayName": "Customer | Source of funds status", "Type": "string", "Description": "The verification state of the declared source of funds - whether it is missing, unverified or evidenced. Carries the determination, where sof_declared carries the claim.", "Examples": [ "VERIFIED", "UNVERIFIED", "MISSING" ], "Group": "general/customer_identity", "Required": false }, { "Name": "sow_status", "DisplayName": "Customer | Source of wealth status", "Type": "string", "Description": "The verification state of the declared source of wealth. The counterpart of sof_status, and the determination against the existing source_of_wealth claim.", "Examples": [ "VERIFIED", "UNVERIFIED", "MISSING" ], "Group": "general/customer_identity", "Required": false }, { "Name": "third_party_entity_type", "DisplayName": "Third party | Entity Type", "Type": "enum", "Description": "Whether the third party the transaction was conducted on behalf of is a natural person or a legal entity. Decides how third_party_name is screened (as a person, or as a company/organization). Defaults to PERSON when not sent.", "Values": [ { "Name": "PERSON", "DisplayName": "Person", "Description": "A natural person." }, { "Name": "ENTITY", "DisplayName": "Entity", "Description": "A company, organization or other legal entity." } ], "Group": "general/transaction", "Required": false }, { "Name": "third_party_id", "DisplayName": "Third party | ID as per merchant", "Type": "string", "Description": "The ID of the third party the transaction was conducted on behalf of. Unrelated to third_party_booking, which is an airline-industry boolean about who booked a ticket.", "Examples": [ "TP12345", "98765" ], "Group": "general/transaction", "Required": false }, { "Name": "third_party_name", "DisplayName": "Third party | Name", "Type": "string", "Description": "The full or legal name of the third party the transaction was conducted on behalf of. Used to screen the third party.", "Examples": [ "Northwind Holdings Inc" ], "Group": "general/transaction", "Required": false }, { "Name": "third_party_relationship", "DisplayName": "Third party | Relationship to the customer", "Type": "string", "Description": "The relationship between the third party and the account holder, as recorded by the client.", "Examples": [ "Employer", "Family member", "Business partner" ], "Group": "general/transaction", "Required": false }, { "Name": "third_party_role", "DisplayName": "Third party | Role", "Type": "string", "Description": "The role the third party plays in the transaction, as recorded by the client.", "Examples": [ "Payer", "Payee", "Agent" ], "Group": "general/transaction", "Required": false }, { "Name": "third_party_status", "DisplayName": "Third party | Determination", "Type": "enum", "Description": "Whether the transaction was conducted on behalf of a third party: YES, NO, or UNKNOWN when the determination could not be made.", "Values": [ { "Name": "YES", "DisplayName": "Yes" }, { "Name": "NO", "DisplayName": "No" }, { "Name": "UNKNOWN", "DisplayName": "Unknown" } ], "Group": "general/transaction", "Required": false }, { "Name": "to_asset", "DisplayName": "Transaction | Asset received", "Type": "string", "Description": "The asset the transaction sends or converts TO - a fiat currency code or a virtual-currency ticker.", "Examples": [ "CAD", "XMR", "ETH" ], "Group": "general/transaction", "Required": false }, { "Name": "trade_item_assessed_market_value", "DisplayName": "Trade | Item Assessed Market Value", "Type": "float", "Description": "The independently assessed market value of the traded item or goods, for comparison against the declared invoice value.", "Group": "general/purchase", "Required": false }, { "Name": "trans_exchange_direction", "DisplayName": "Transaction | Exchange Direction", "Type": "enum", "Description": "Whether the transaction is a currency purchase or sale at the exchange counter.", "Values": [ { "Name": "BUY", "DisplayName": "Buy", "Description": "The customer is buying the target currency." }, { "Name": "SELL", "DisplayName": "Sell", "Description": "The customer is selling the target currency." } ], "Group": "general/transaction", "Required": false }, { "Name": "trans_purpose_description", "DisplayName": "Transaction | Purpose Description", "Type": "string", "Description": "The free-text purpose or reason for the transaction, as declared by the customer at initiation.", "Examples": [ "Family support" ], "Group": "general/transaction", "Required": false }, { "Name": "trans_reversed_and_resent_to_different_ba", "DisplayName": "Transaction | Reversed and Resent to Different Beneficiary", "Type": "bool", "Description": "Whether a prior transaction from this customer was reversed or failed, and the funds were then resent to a different beneficiary. A pattern associated with beneficiary substitution fraud.", "Group": "general/transaction", "Required": false }, { "Name": "virtual_machine", "DisplayName": "Device | Virtual machine", "Type": "enum", "Description": "Specifies if the device used for the purchase is not a physical device but rather a virtual machine.", "Values": [ { "Name": "device_simulator", "DisplayName": "Simulator (iOS)", "Description": "A device simulator mimics an iOS app or browser on top of an operating system. It cannot virtualize the actual hardware conditions of an iOS device." }, { "Name": "device_emulator", "DisplayName": "Emulator (Android)", "Description": "A device emulator replicates Android devices from both the hardware and the software point of view." } ], "Group": "general/device", "Required": false }, { "Name": "wagering_amt", "DisplayName": "Wagering | Amount", "Type": "float", "Description": "The amount wagered in a single gaming session event, as supplied by the client. Momentum-specific.", "Group": "general/customer_identity", "Required": false } ], "enums": [ { "Name": "country_code_iso", "Values": [ { "Name": "AD", "DisplayName": "AD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AE", "DisplayName": "AE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AF", "DisplayName": "AF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AG", "DisplayName": "AG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AI", "DisplayName": "AI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AL", "DisplayName": "AL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AM", "DisplayName": "AM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AO", "DisplayName": "AO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AQ", "DisplayName": "AQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AR", "DisplayName": "AR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AS", "DisplayName": "AS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AT", "DisplayName": "AT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AU", "DisplayName": "AU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AW", "DisplayName": "AW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AX", "DisplayName": "AX", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AZ", "DisplayName": "AZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BA", "DisplayName": "BA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BB", "DisplayName": "BB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BD", "DisplayName": "BD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BE", "DisplayName": "BE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BF", "DisplayName": "BF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BG", "DisplayName": "BG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BH", "DisplayName": "BH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BI", "DisplayName": "BI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BJ", "DisplayName": "BJ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BL", "DisplayName": "BL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BM", "DisplayName": "BM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BN", "DisplayName": "BN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BO", "DisplayName": "BO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BQ", "DisplayName": "BQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BR", "DisplayName": "BR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BS", "DisplayName": "BS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BT", "DisplayName": "BT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BV", "DisplayName": "BV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BW", "DisplayName": "BW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BY", "DisplayName": "BY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BZ", "DisplayName": "BZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CA", "DisplayName": "CA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CC", "DisplayName": "CC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CD", "DisplayName": "CD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CF", "DisplayName": "CF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CG", "DisplayName": "CG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CH", "DisplayName": "CH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CI", "DisplayName": "CI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CK", "DisplayName": "CK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CL", "DisplayName": "CL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CM", "DisplayName": "CM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CN", "DisplayName": "CN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CO", "DisplayName": "CO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CR", "DisplayName": "CR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CU", "DisplayName": "CU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CV", "DisplayName": "CV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CW", "DisplayName": "CW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CX", "DisplayName": "CX", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CY", "DisplayName": "CY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CZ", "DisplayName": "CZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DE", "DisplayName": "DE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DJ", "DisplayName": "DJ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DK", "DisplayName": "DK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DM", "DisplayName": "DM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DO", "DisplayName": "DO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DZ", "DisplayName": "DZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EC", "DisplayName": "EC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EE", "DisplayName": "EE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EG", "DisplayName": "EG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EH", "DisplayName": "EH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ER", "DisplayName": "ER", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ES", "DisplayName": "ES", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ET", "DisplayName": "ET", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FI", "DisplayName": "FI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FJ", "DisplayName": "FJ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FK", "DisplayName": "FK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FM", "DisplayName": "FM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FO", "DisplayName": "FO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FR", "DisplayName": "FR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GA", "DisplayName": "GA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GB", "DisplayName": "GB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GD", "DisplayName": "GD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GE", "DisplayName": "GE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GF", "DisplayName": "GF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GG", "DisplayName": "GG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GH", "DisplayName": "GH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GI", "DisplayName": "GI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GL", "DisplayName": "GL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GM", "DisplayName": "GM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GN", "DisplayName": "GN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GP", "DisplayName": "GP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GQ", "DisplayName": "GQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GR", "DisplayName": "GR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GS", "DisplayName": "GS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GT", "DisplayName": "GT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GU", "DisplayName": "GU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GW", "DisplayName": "GW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GY", "DisplayName": "GY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HK", "DisplayName": "HK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HM", "DisplayName": "HM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HN", "DisplayName": "HN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HR", "DisplayName": "HR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HT", "DisplayName": "HT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HU", "DisplayName": "HU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ID", "DisplayName": "ID", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IE", "DisplayName": "IE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IL", "DisplayName": "IL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IM", "DisplayName": "IM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IN", "DisplayName": "IN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IO", "DisplayName": "IO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IQ", "DisplayName": "IQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IR", "DisplayName": "IR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IS", "DisplayName": "IS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IT", "DisplayName": "IT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JE", "DisplayName": "JE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JM", "DisplayName": "JM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JO", "DisplayName": "JO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JP", "DisplayName": "JP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KE", "DisplayName": "KE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KG", "DisplayName": "KG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KH", "DisplayName": "KH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KI", "DisplayName": "KI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KM", "DisplayName": "KM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KN", "DisplayName": "KN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KP", "DisplayName": "KP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KR", "DisplayName": "KR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KW", "DisplayName": "KW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KY", "DisplayName": "KY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KZ", "DisplayName": "KZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LA", "DisplayName": "LA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LB", "DisplayName": "LB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LC", "DisplayName": "LC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LI", "DisplayName": "LI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LK", "DisplayName": "LK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LR", "DisplayName": "LR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LS", "DisplayName": "LS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LT", "DisplayName": "LT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LU", "DisplayName": "LU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LV", "DisplayName": "LV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LY", "DisplayName": "LY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MA", "DisplayName": "MA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MC", "DisplayName": "MC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MD", "DisplayName": "MD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ME", "DisplayName": "ME", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MF", "DisplayName": "MF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MG", "DisplayName": "MG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MH", "DisplayName": "MH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MK", "DisplayName": "MK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ML", "DisplayName": "ML", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MM", "DisplayName": "MM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MN", "DisplayName": "MN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MO", "DisplayName": "MO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MP", "DisplayName": "MP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MQ", "DisplayName": "MQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MR", "DisplayName": "MR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MS", "DisplayName": "MS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MT", "DisplayName": "MT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MU", "DisplayName": "MU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MV", "DisplayName": "MV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MW", "DisplayName": "MW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MX", "DisplayName": "MX", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MY", "DisplayName": "MY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MZ", "DisplayName": "MZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NA", "DisplayName": "NA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NC", "DisplayName": "NC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NE", "DisplayName": "NE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NF", "DisplayName": "NF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NG", "DisplayName": "NG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NI", "DisplayName": "NI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NL", "DisplayName": "NL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NO", "DisplayName": "NO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NP", "DisplayName": "NP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NR", "DisplayName": "NR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NU", "DisplayName": "NU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NZ", "DisplayName": "NZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "OM", "DisplayName": "OM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PA", "DisplayName": "PA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PE", "DisplayName": "PE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PF", "DisplayName": "PF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PG", "DisplayName": "PG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PH", "DisplayName": "PH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PK", "DisplayName": "PK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PL", "DisplayName": "PL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PM", "DisplayName": "PM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PN", "DisplayName": "PN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PR", "DisplayName": "PR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PS", "DisplayName": "PS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PT", "DisplayName": "PT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PW", "DisplayName": "PW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PY", "DisplayName": "PY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "QA", "DisplayName": "QA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RE", "DisplayName": "RE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RO", "DisplayName": "RO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RS", "DisplayName": "RS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RU", "DisplayName": "RU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RW", "DisplayName": "RW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SA", "DisplayName": "SA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SB", "DisplayName": "SB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SC", "DisplayName": "SC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SD", "DisplayName": "SD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SE", "DisplayName": "SE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SG", "DisplayName": "SG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SH", "DisplayName": "SH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SI", "DisplayName": "SI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SJ", "DisplayName": "SJ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SK", "DisplayName": "SK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SL", "DisplayName": "SL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SM", "DisplayName": "SM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SN", "DisplayName": "SN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SO", "DisplayName": "SO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SR", "DisplayName": "SR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SS", "DisplayName": "SS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ST", "DisplayName": "ST", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SV", "DisplayName": "SV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SX", "DisplayName": "SX", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SY", "DisplayName": "SY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SZ", "DisplayName": "SZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TC", "DisplayName": "TC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TD", "DisplayName": "TD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TF", "DisplayName": "TF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TG", "DisplayName": "TG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TH", "DisplayName": "TH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TJ", "DisplayName": "TJ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TK", "DisplayName": "TK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TL", "DisplayName": "TL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TM", "DisplayName": "TM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TN", "DisplayName": "TN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TO", "DisplayName": "TO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TR", "DisplayName": "TR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TT", "DisplayName": "TT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TV", "DisplayName": "TV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TW", "DisplayName": "TW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TZ", "DisplayName": "TZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UA", "DisplayName": "UA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UG", "DisplayName": "UG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UM", "DisplayName": "UM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "US", "DisplayName": "US", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UY", "DisplayName": "UY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UZ", "DisplayName": "UZ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VA", "DisplayName": "VA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VC", "DisplayName": "VC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VE", "DisplayName": "VE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VG", "DisplayName": "VG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VI", "DisplayName": "VI", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VN", "DisplayName": "VN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VU", "DisplayName": "VU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "WF", "DisplayName": "WF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "WS", "DisplayName": "WS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "XK", "DisplayName": "XK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "YE", "DisplayName": "YE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "YT", "DisplayName": "YT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZA", "DisplayName": "ZA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZM", "DisplayName": "ZM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZW", "DisplayName": "ZW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AC", "DisplayName": "AC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AN", "DisplayName": "AN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KS", "DisplayName": "KS", "Description": "", "Deprecated": false, "DeprecationReason": "" } ] }, { "Name": "ticket_class", "Values": [ { "Name": "P", "DisplayName": "P", "Description": "First class premium.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "F", "DisplayName": "F", "Description": "First class full fare.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "A", "DisplayName": "A", "Description": "First class discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "C", "DisplayName": "C", "Description": "Business class full fare.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "J", "DisplayName": "J", "Description": "Business class premium.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "D", "DisplayName": "D", "Description": "Business class discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "I", "DisplayName": "I", "Description": "Business class discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "Z", "DisplayName": "Z", "Description": "Business class discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "Y", "DisplayName": "Y", "Description": "Economy/coach.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "W", "DisplayName": "W", "Description": "Economy/coach premium.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "S", "DisplayName": "S", "Description": "Economy/coach.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "B", "DisplayName": "B", "Description": "Economy/coach discounted. Eligible for an upgrade to class M.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "H", "DisplayName": "H", "Description": "Economy/coach discounted. Eligible for an upgrade to business class.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "K", "DisplayName": "K", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "L", "DisplayName": "L", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "M", "DisplayName": "M", "Description": "Economy/coach discounted. Eligible for an upgrade to business class.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "N", "DisplayName": "N", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "Q", "DisplayName": "Q", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "V", "DisplayName": "V", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "other", "DisplayName": "Other", "Description": "Another class not covered by the existing values.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "G", "DisplayName": "G", "Description": "Economy/coach discounted, conditional reservation. Used as RBD (Reservations Booking Designator), not as primary code. RBD is the class used to book the flight in the reservations system and specified by the carrier providing transportation.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "T", "DisplayName": "T", "Description": "Economy/coach discounted.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "R", "DisplayName": "R", "Description": "First class suites/individual airline use. Used as RBD (Reservations Booking Designator), not as primary code. RBD is the class used to book the flight in the reservations system and specified by the carrier providing transportation.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "U", "DisplayName": "U", "Description": "Shuttle service. No reservation needed, seat guaranteed. Used as RBD (Reservations Booking Designator), not as primary code. RBD is the class used to book the flight in the reservations system and specified by the carrier providing transportation.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "O", "DisplayName": "O", "Description": "Economy/coach discounted. Used as RBD (Reservations Booking Designator), not as primary code. RBD is the class used to book the flight in the reservations system and specified by the carrier providing transportation.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "E", "DisplayName": "E", "Description": "Shuttle service. Reservation not allowed, seat to be confirmed at check-in. Used as RBD (Reservations Booking Designator), not as primary code. RBD is the class used to book the flight in the reservations system and specified by the carrier providing transportation.", "Deprecated": false, "DeprecationReason": "" } ] }, { "Name": "country_region", "Values": [ { "Name": "anatolia", "DisplayName": "Anatolia", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "balkans", "DisplayName": "The Balkans", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "caribbeans", "DisplayName": "The Caribbean", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "central_america", "DisplayName": "Central America", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "central_asia", "DisplayName": "Central Asia", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "east_africa", "DisplayName": "East Africa", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "east_asia", "DisplayName": "East Asia", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "east_eu", "DisplayName": "Eastern Europe", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "middle_east", "DisplayName": "The Middle East", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "north_africa", "DisplayName": "North Africa", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "north_america", "DisplayName": "North America", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "north_eu", "DisplayName": "Northern Europe", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "oceania", "DisplayName": "Oceania", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "south_america", "DisplayName": "South America", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "south_asia", "DisplayName": "South Asia", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "south_central_africa", "DisplayName": "Southern and Central Africa", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "south_east_asia", "DisplayName": "Southeast Asia", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "west_africa", "DisplayName": "West Africa", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "west_eu", "DisplayName": "Western Europe", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "antarctics", "DisplayName": "Antarctics", "Description": "", "Deprecated": false, "DeprecationReason": "" } ] }, { "Name": "currency_codes", "Values": [ { "Name": "AED", "DisplayName": "AED", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AFN", "DisplayName": "AFN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ALL", "DisplayName": "ALL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AMD", "DisplayName": "AMD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ANG", "DisplayName": "ANG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AOA", "DisplayName": "AOA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ARS", "DisplayName": "ARS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AUD", "DisplayName": "AUD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AWG", "DisplayName": "AWG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "AZN", "DisplayName": "AZN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BAM", "DisplayName": "BAM", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BBD", "DisplayName": "BBD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BDT", "DisplayName": "BDT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BGN", "DisplayName": "BGN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BHD", "DisplayName": "BHD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BIF", "DisplayName": "BIF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BMD", "DisplayName": "BMD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BND", "DisplayName": "BND", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BOB", "DisplayName": "BOB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BRL", "DisplayName": "BRL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BSD", "DisplayName": "BSD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BTN", "DisplayName": "BTN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BWP", "DisplayName": "BWP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BYR", "DisplayName": "BYR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "BZD", "DisplayName": "BZD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CAD", "DisplayName": "CAD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CDF", "DisplayName": "CDF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CHF", "DisplayName": "CHF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CLP", "DisplayName": "CLP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CNY", "DisplayName": "CNY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "COP", "DisplayName": "COP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CRC", "DisplayName": "CRC", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CUP", "DisplayName": "CUP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CVE", "DisplayName": "CVE", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "CZK", "DisplayName": "CZK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DJF", "DisplayName": "DJF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DKK", "DisplayName": "DKK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DOP", "DisplayName": "DOP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "DZD", "DisplayName": "DZD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EGP", "DisplayName": "EGP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ERN", "DisplayName": "ERN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ETB", "DisplayName": "ETB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "EUR", "DisplayName": "EUR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FJD", "DisplayName": "FJD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FKP", "DisplayName": "FKP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GBP", "DisplayName": "GBP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GEL", "DisplayName": "GEL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GHS", "DisplayName": "GHS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GIP", "DisplayName": "GIP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GMD", "DisplayName": "GMD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GNF", "DisplayName": "GNF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GTQ", "DisplayName": "GTQ", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "GYD", "DisplayName": "GYD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HKD", "DisplayName": "HKD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HNL", "DisplayName": "HNL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HRK", "DisplayName": "HRK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HTG", "DisplayName": "HTG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "HUF", "DisplayName": "HUF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IDR", "DisplayName": "IDR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ILS", "DisplayName": "ILS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "INR", "DisplayName": "INR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IQD", "DisplayName": "IQD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "IRR", "DisplayName": "IRR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ISK", "DisplayName": "ISK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JMD", "DisplayName": "JMD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JOD", "DisplayName": "JOD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "JPY", "DisplayName": "JPY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KES", "DisplayName": "KES", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KGS", "DisplayName": "KGS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KHR", "DisplayName": "KHR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KMF", "DisplayName": "KMF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KPW", "DisplayName": "KPW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KRW", "DisplayName": "KRW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KWD", "DisplayName": "KWD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KYD", "DisplayName": "KYD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "KZT", "DisplayName": "KZT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LAK", "DisplayName": "LAK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LBP", "DisplayName": "LBP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LKR", "DisplayName": "LKR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LRD", "DisplayName": "LRD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LSL", "DisplayName": "LSL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "LYD", "DisplayName": "LYD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MAD", "DisplayName": "MAD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MDL", "DisplayName": "MDL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MGA", "DisplayName": "MGA", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MKD", "DisplayName": "MKD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MMK", "DisplayName": "MMK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MNT", "DisplayName": "MNT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MOP", "DisplayName": "MOP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MRO", "DisplayName": "MRO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MUR", "DisplayName": "MUR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MVR", "DisplayName": "MVR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MWK", "DisplayName": "MWK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MXN", "DisplayName": "MXN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MYR", "DisplayName": "MYR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "MZN", "DisplayName": "MZN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NAD", "DisplayName": "NAD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NGN", "DisplayName": "NGN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NIO", "DisplayName": "NIO", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NOK", "DisplayName": "NOK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NPR", "DisplayName": "NPR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "NZD", "DisplayName": "NZD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "OMR", "DisplayName": "OMR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PAB", "DisplayName": "PAB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PEN", "DisplayName": "PEN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PGK", "DisplayName": "PGK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PHP", "DisplayName": "PHP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PKR", "DisplayName": "PKR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PLN", "DisplayName": "PLN", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "PYG", "DisplayName": "PYG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "QAR", "DisplayName": "QAR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RON", "DisplayName": "RON", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RSD", "DisplayName": "RSD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RUB", "DisplayName": "RUB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "RWF", "DisplayName": "RWF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SAR", "DisplayName": "SAR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SBD", "DisplayName": "SBD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SCR", "DisplayName": "SCR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SDG", "DisplayName": "SDG", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SEK", "DisplayName": "SEK", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SGD", "DisplayName": "SGD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SHP", "DisplayName": "SHP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SLL", "DisplayName": "SLL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SOS", "DisplayName": "SOS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SRD", "DisplayName": "SRD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SSP", "DisplayName": "SSP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "STD", "DisplayName": "STD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SYP", "DisplayName": "SYP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "SZL", "DisplayName": "SZL", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "THB", "DisplayName": "THB", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TJS", "DisplayName": "TJS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TMT", "DisplayName": "TMT", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TND", "DisplayName": "TND", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TOP", "DisplayName": "TOP", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TRY", "DisplayName": "TRY", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TTD", "DisplayName": "TTD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TWD", "DisplayName": "TWD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "TZS", "DisplayName": "TZS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UAH", "DisplayName": "UAH", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UGX", "DisplayName": "UGX", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "USD", "DisplayName": "USD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UYU", "DisplayName": "UYU", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UZS", "DisplayName": "UZS", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VEF", "DisplayName": "VEF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VND", "DisplayName": "VND", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "VUV", "DisplayName": "VUV", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "WST", "DisplayName": "WST", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "XAF", "DisplayName": "XAF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "XCD", "DisplayName": "XCD", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "XOF", "DisplayName": "XOF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "XPF", "DisplayName": "XPF", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "YER", "DisplayName": "YER", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZAR", "DisplayName": "ZAR", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZMW", "DisplayName": "ZMW", "Description": "", "Deprecated": false, "DeprecationReason": "" }, { "Name": "ZWL", "DisplayName": "ZWL", "Description": "", "Deprecated": false, "DeprecationReason": "" } ] }, { "Name": "ttm_tristate", "Values": [ { "Name": "TRUE", "DisplayName": "True", "Description": "The check returned a positive/affirmative result.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "FALSE", "DisplayName": "False", "Description": "The check returned a negative result.", "Deprecated": false, "DeprecationReason": "" }, { "Name": "UNKNOWN", "DisplayName": "Unknown", "Description": "The check has not been run, or its result is not available. Distinct from FALSE - absence of a check must never look like a clean result.", "Deprecated": false, "DeprecationReason": "" } ] } ], "groups": [ { "Name": "add_on_service", "DisplayName": "Add-on service", "ExternalDescription": "Attributes related to an add-on service or product available at shufti." }, { "Name": "add_on_service/device_fingerprinting", "DisplayName": "Add-on service | Device fingerprinting", "ExternalDescription": "" }, { "Name": "add_on_service/sanctions_lists", "DisplayName": "Add-on service | Sanctions lists", "ExternalDescription": "" }, { "Name": "buncher", "DisplayName": "Customer entity", "ExternalDescription": "Attributes related to a customer entity calculated by an internal custom service." }, { "Name": "shufti_ai", "DisplayName": "shufti AI", "ExternalDescription": "Attributes in this group are related to the work of shufti models and internal intelligence." }, { "Name": "shufti_ai/credit", "DisplayName": "shufti AI | Credit", "ExternalDescription": "" }, { "Name": "shufti_ai/fraud", "DisplayName": "shufti AI | Fraud", "ExternalDescription": "" }, { "Name": "shufti_ai/general", "DisplayName": "shufti AI | General", "ExternalDescription": "" }, { "Name": "shufti_ai/goodies", "DisplayName": "shufti AI | Goodies", "ExternalDescription": "" }, { "Name": "shufti_ai/nbh", "DisplayName": "shufti AI | Neighborhood scoring", "ExternalDescription": "" }, { "Name": "general", "DisplayName": "General", "ExternalDescription": "Attributes and datapoints representing general data about a transaction, including but not limited to transactional data, customer, merchant, address, device, purchase, and so on." }, { "Name": "general/account", "DisplayName": "General | Account", "ExternalDescription": "" }, { "Name": "general/billing_address", "DisplayName": "General | Billing address", "ExternalDescription": "" }, { "Name": "general/customer_identity", "DisplayName": "General | Customer identity", "ExternalDescription": "" }, { "Name": "general/device", "DisplayName": "General | Device", "ExternalDescription": "" }, { "Name": "general/device_id", "DisplayName": "General | Device ID", "ExternalDescription": "" }, { "Name": "general/geo", "DisplayName": "General | Geo", "ExternalDescription": "" }, { "Name": "general/ip_address", "DisplayName": "General | IP address", "ExternalDescription": "" }, { "Name": "general/merchant", "DisplayName": "General | Merchant", "ExternalDescription": "" }, { "Name": "general/purchase", "DisplayName": "General | Purchase", "ExternalDescription": "" }, { "Name": "general/shipping_address", "DisplayName": "General | Shipping address", "ExternalDescription": "" }, { "Name": "general/transaction", "DisplayName": "General | Transaction", "ExternalDescription": "" }, { "Name": "industry", "DisplayName": "Industry", "ExternalDescription": "Industry-specific datapoints and attributes cover the data relevant for a specific industry or business model." }, { "Name": "industry/airlines", "DisplayName": "Industry | Airlines", "ExternalDescription": "" }, { "Name": "industry/airlines/jetsmart", "DisplayName": "Industry | Airlines | JetSmart", "ExternalDescription": "This group is dedicated to attributes created specifically for JetSmart. They are only to be used internally for the purposes of supporting JetSmart." }, { "Name": "industry/digital", "DisplayName": "Industry | Digital goods and services", "ExternalDescription": "" }, { "Name": "industry/gaming", "DisplayName": "Industry | Gaming", "ExternalDescription": "" }, { "Name": "industry/hotels", "DisplayName": "Industry | Hotels", "ExternalDescription": "" }, { "Name": "industry/hotels/iberostar", "DisplayName": "Industry | Hotels | Iberostar", "ExternalDescription": "This group is dedicated to attributes created specifically for Iberostar. They are only to be used internally for the purposes of supporting Iberostar." }, { "Name": "industry/retail", "DisplayName": "Industry | Retail", "ExternalDescription": "" }, { "Name": "match", "DisplayName": "Match", "ExternalDescription": "Match attributes specify if one piece of data matches another piece of data. A match between the two could suggest that the transaction is not fraudulent." }, { "Name": "match/address", "DisplayName": "Match | Address", "ExternalDescription": "" }, { "Name": "match/customer_identity", "DisplayName": "Match | Customer identity", "ExternalDescription": "" }, { "Name": "match/other", "DisplayName": "Match | Other", "ExternalDescription": "" }, { "Name": "payment_method", "DisplayName": "Payment method", "ExternalDescription": "Attributes and datapoints related to one of the defined payment methods." }, { "Name": "payment_method/bank_transfer", "DisplayName": "Payment method | Bank transfer", "ExternalDescription": "" }, { "Name": "payment_method/bnpl", "DisplayName": "Payment method | BNPL", "ExternalDescription": "" }, { "Name": "payment_method/cards", "DisplayName": "Payment method | Cards", "ExternalDescription": "" }, { "Name": "payment_method/cash", "DisplayName": "Payment method | Cash", "ExternalDescription": "" }, { "Name": "payment_method/digital_wallet", "DisplayName": "Payment method | Digital wallet", "ExternalDescription": "" }, { "Name": "payment_method/direct_debit", "DisplayName": "Payment method | Direct debit", "ExternalDescription": "" }, { "Name": "payment_method/general", "DisplayName": "Payment method | General", "ExternalDescription": "" }, { "Name": "payment_method/mobile", "DisplayName": "Payment method | Mobile", "ExternalDescription": "" }, { "Name": "payment_method/prepaids", "DisplayName": "Payment method | Prepaids and vouchers", "ExternalDescription": "" }, { "Name": "velocity", "DisplayName": "Velocity", "ExternalDescription": "Velocity attributes specify the frequency of transactions incoming from one individual. Velocity attributes of 1 datapoint focus on one value only, for example email velocity or IP address velocity. Velocity attributes of 2 datapoints focus on a combination of values rather than a single one. Transaction status velocity focuses on the number of times an attribute value has appeared in a transaction with a given status." }, { "Name": "velocity/of_1_datapoint", "DisplayName": "Velocity of 1 datapoint", "ExternalDescription": "" }, { "Name": "velocity/of_1_datapoint/billing_address", "DisplayName": "Velocity of 1 datapoint | Billing address", "ExternalDescription": "" }, { "Name": "velocity/of_1_datapoint/customer_identity", "DisplayName": "Velocity of 1 datapoint | Customer identity", "ExternalDescription": "" }, { "Name": "velocity/of_1_datapoint/device", "DisplayName": "Velocity of 1 datapoint | Device", "ExternalDescription": "" }, { "Name": "velocity/of_1_datapoint/payment_method", "DisplayName": "Velocity of 1 datapoint | Payment method", "ExternalDescription": "" }, { "Name": "velocity/of_1_datapoint/shipping_address", "DisplayName": "Velocity of 1 datapoint | Shipping address", "ExternalDescription": "" }, { "Name": "velocity/of_2_datapoints", "DisplayName": "Velocity of 2 datapoints", "ExternalDescription": "" }, { "Name": "velocity/txn_status", "DisplayName": "Transaction status velocity of 1 datapoint", "ExternalDescription": "" }, { "Name": "beneficiary", "DisplayName": "Beneficiary", "ExternalDescription": "Details of the person or account receiving the funds." }, { "Name": "aml_screening", "DisplayName": "AML Screening", "ExternalDescription": "AML screening request for the customer." }, { "Name": "beneficiary_aml_screening", "DisplayName": "Beneficiary AML Screening", "ExternalDescription": "AML screening request for the beneficiary." }, { "Name": "add_on_service/aml_screening", "DisplayName": "Add-on service | AML Screening", "ExternalDescription": "" }, { "Name": "cluster", "DisplayName": "Cluster", "ExternalDescription": "Attributes describing a customer's computed network cluster (linked accounts/customers by shared identifiers). Definitions only until computation lands - see item 9 step 5." }, { "Name": "cluster/composition", "DisplayName": "Cluster | Composition", "ExternalDescription": "" }, { "Name": "cluster/flow", "DisplayName": "Cluster | Flow", "ExternalDescription": "" }, { "Name": "cluster/identity", "DisplayName": "Cluster | Identity", "ExternalDescription": "" }, { "Name": "cluster/risk", "DisplayName": "Cluster | Risk", "ExternalDescription": "" }, { "Name": "customer-entity", "DisplayName": "Customer entity", "ExternalDescription": "Attributes related to a customer entity calculated by an internal custom service." }, { "Name": "fraugster_ai", "DisplayName": "Fraugster AI", "ExternalDescription": "Attributes in this group are related to the work of Fraugster models and internal intelligence." }, { "Name": "fraugster_ai/credit", "DisplayName": "Fraugster AI | Credit", "ExternalDescription": "" }, { "Name": "fraugster_ai/fraud", "DisplayName": "Fraugster AI | Fraud", "ExternalDescription": "" }, { "Name": "fraugster_ai/general", "DisplayName": "Fraugster AI | General", "ExternalDescription": "" }, { "Name": "fraugster_ai/goodies", "DisplayName": "Fraugster AI | Goodies", "ExternalDescription": "" }, { "Name": "fraugster_ai/nbh", "DisplayName": "Fraugster AI | Neighborhood scoring", "ExternalDescription": "" }, { "Name": "general/beneficiary_identity", "DisplayName": "General | Beneficiary identity", "ExternalDescription": "" }, { "Name": "industry/trading", "DisplayName": "Industry | Trading", "ExternalDescription": "Industry-specific attributes for trading, brokerage and capital markets." }, { "Name": "velocity/of_1_datapoint/beneficiary_identity", "DisplayName": "Velocity of 1 datapoint | Beneficiary identity", "ExternalDescription": "" }, { "Name": "velocity/txn_amount", "DisplayName": "Velocity in EUR amount of 1 datapoint", "ExternalDescription": "" } ] }