Complete List of Datapoints
Shufti's Transaction Trust Monitoring (TTM) evaluates every transaction by running it against a set of rules you configure. Shufti collects data points from its user as input in API requests and performs screening.
Datapoints are the raw values your application sends in the API request. They represent the core facts of a transaction, such as the customer's email address, IP address, device ID, transaction amount, or payment method. Datapoints are the foundation of every rule in TTM.
The tables below list all available Datapoints. Each entry shows its type and whether it is Required or Optional. Only trans_id is required; every other datapoint is optional, but rules can only evaluate the datapoints you send. For example, amount-based rules need trans_amt and trans_currency. For enum datapoints, only the listed allowed values are recognised.
Datapoints
⬇️ Download the complete list of datapoints:
General | Account
| Name | Display Name | Description |
|---|---|---|
| acct_ad_city | Account address | City | Type: string · Optional The city on the address of the buyer saved in the buyer's account on the merchant's platform. Example: Paris, Berlin |
| acct_ad_ctry | Account address | Country | Type: enum · Optional The country on the account address. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| acct_ad_line1 | Account address | Street and building number | Type: string · Optional The street and building number on the account address. Example: 44 Ashgrove Road |
| acct_ad_line2 | Account address | Apartment number | Type: string · Optional The apartment or flat number on the account address. Example: Apt. 15 |
| acct_ad_state | Account address | State | Type: string · Optional The state or another unit of administrative division on the account address. Example: VA, Bavaria, New York |
| acct_ad_zip | Account address | Postal code | Type: string · Optional The postal code on the account address. Example: 10179 |
| cust_existing | Customer | Existing with payment company | Type: bool · Optional Indicates whether the customer has an account with the payment company. |
| cust_existing_merchant | Customer | Existing with merchant | Type: bool · Optional Indicates whether the customer has an account with the merchant. |
| cust_forgot_password | Customer | Forgot password | Type: bool · Optional Indicates whether the customer forgot the password for their account on the e-commerce platform. |
| cust_has_password | Customer | Has password | Type: bool · Optional Indicates whether the customer has a password for their account on the e-commerce platform. |
| cust_last_login_ts | Account | Last login | Type: timestamp · Optional The date of the last login of the customer. Relevant if the customer has a user account on the merchant's e-commerce platform. Example: 2019-02-04T15:04:05Z |
| cust_signup_dt | Account | Signup date | Type: string · Optional The date when the customer signed up for the merchant's e-commerce platform. An RFC3339-encoded UTC timestamp. Example: 2017-12-09Z |
| cust_signup_ts | Account | Signup timestamp | Type: timestamp · Optional 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. |
| customer_account_number | Customer | Account number | Type: string · Optional The account number of the customer in the merchant's database. Example: 2364 |
| password_update_ts | Account | Password update timestamp | Type: timestamp · Optional An RFC3339-encoded UTC timestamp indicating when the customer last updated their password on the e-commerce platform. |
General | Billing Address
| Name | Display Name | Description |
|---|---|---|
| bill_ad_city | Billing address | City | Type: string · Optional The city on the billing address. Example: Berlin |
| bill_ad_city_norm_dp | Billing address | City normalized by the payment company | Type: string · Optional The normalized value of the city on the billing address provided by the payment company. Example: buenosaires, newyork |
| bill_ad_ctry | Billing address | Country | Type: enum · Optional The country on the billing address. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| bill_ad_ctry_norm_dp | Billing address | Country normalized by payment company | Type: enum · Optional The normalized value of the country on the billing address provided by the payment company. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| bill_ad_first_name | Billing address | First name | Type: string · Optional The first name of the customer on the billing address. Example: Grace |
| bill_ad_house_num | Billing address | House number | Type: string · Optional The house number on the billing address. Example: 4, 40/1 |
| bill_ad_house_num_norm_dp | Billing address | House number normalized | Type: string · Optional The normalized value of the house number on the billing address. Example: 4, 40 |
| bill_ad_last_name | Billing address | Last name | Type: string · Optional The last name of the customer on the billing address. Example: Hopper |
| bill_ad_line1 | Billing address | Street and building number | Type: string · Optional The street and building number on the billing address. Example: Hartwigstraße 27 |
| bill_ad_line1_norm_dp | Billing address | Street and building number normalized by payment company | Type: string · Optional The normalized value of the street and building number on the billing address. Example: Hartwigstr. |
| bill_ad_line2 | Billing address | Apartment number | Type: string · Optional The apartment or flat number on the billing address. Example: Apt. 15 |
| bill_ad_line3 | Billing address | Additional info | Type: string · Optional Additional address information on the billing address. Example: 2nd floor |
| bill_ad_line3_norm_dp | Billing address | Additional info normalized by payment company | Type: string · Optional The normalized value of additional details on the billing address provided by the payment company. Example: 2nd floor – left side, 2nd floor |
| bill_ad_middle_name | Billing address | Middle name | Type: string · Optional The middle name of the customer on the billing address. Example: Brewster Murray |
| bill_ad_name | Billing address | Full name | Type: string · Optional 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. Example: Grace Hopper |
| bill_ad_state | Billing address | State | Type: string · Optional The state or another unit of administrative division on the billing address. Example: New York, Bavaria |
| bill_ad_zip | Billing address | Postal code | Type: string · Optional The postal code on the billing address. Example: 10179 |
| bill_ad_zip_norm_dp | Billing address | Postal code normalized | Type: string · Optional The normalized value of the postal code on the billing address. Example: 78467 |
| bill_name_title | Billing address | Courtesy title | Type: string · Optional The courtesy title of the customer on the billing address. Example: Dr. |
General | Customer Identity
| Name | Display Name | Description |
|---|---|---|
| cust_company | Customer | Company name | Type: string · Optional The company name of the customer. Example: Schön Klinik München Harlaching |
| cust_dob | Customer | Date of birth | Type: date · Optional The date of birth of the customer. Example: 1906-12-09Z |
| cust_email | Customer | Email address | Type: string · Optional The primary email address of the customer. Example: grace.hopper@example.com |
| cust_first_name | Customer | First name | Type: string · Optional The first name of the customer. Example: Grace |
| cust_gender | Customer | Gender | Type: string · Optional The gender of the customer. Example: F |
| cust_id | Customer | ID as per merchant | Type: string · Optional The ID of the customer in the merchant's database. Example: 7730468, 4738 |
| cust_last_name | Customer | Last name | Type: string · Optional The last name of the customer. Example: Hopper |
| cust_middle_name | Customer | Middle name | Type: string · Optional The middle name of the customer. Example: Brewster Murray |
| cust_name | Customer | Full name | Type: string · Optional 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. Example: Grace Brewster Murray Hopper |
| cust_nationality | Customer | Nationality | Type: string · Optional The nationality of the customer. Example: Italian |
| cust_scndry_email | Customer | Secondary email address | Type: string · Optional The secondary email address of the customer. Example: grace.hopper@private.com |
| cust_title | Customer | Courtesy title | Type: string · Optional The courtesy title of the customer. Example: Dr. |
| customer_is_of_age | Customer | Is of age | Type: bool · Optional Specifies if the customer is of age, i.e. old enough, according to the law, to be eligible for certain purchases. |
| customer_username | Customer | Username | Type: string · Optional Specifies the username of the customer they created for the e-commerce account/product they are using. Example: gamer_42 |
| customer_verified_account | Customer | Verified account | Type: bool · Optional 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. |
| fax | Customer | Fax number | Type: string · Optional The fax number of the customer. Example: 030-1781224 |
| phone | Customer | Phone | Type: string · Optional The phone number of the customer. Example: +49(0)8144111100 |
| phone_mobile | Customer | Mobile phone number | Type: string · Optional The customer's mobile phone number. Example: 017624225600 |
| phone_type | Phone | Type | Type: string · Optional The type of the phone used by the customer. Example: Work |
| phone_work | Phone | Work | Type: string · Optional The phone number of the customer marked as the work phone. Example: +49(0)8144111100 |
| scndry_phone | Customer | Secondary phone | Type: string · Optional The secondary phone number of the customer. Example: 017624225600 |
| cust_account_balance | Customer | Account balance | Type: float · Optional The balance of the customer's account in the merchant's database. A number from 0 to 999999999999.99. Example: 8500.00 |
| source_of_wealth | Customer | Source of wealth | Type: string · Optional Declared source of the customer's wealth or funds, for example salary, inheritance or business income. Letters, spaces and hyphens only. Example: Business Income, Salary |
| bo_status | Customer | Beneficial ownership status | Type: string · Optional Whether beneficial ownership information has been collected and confirmed for a corporate customer, as recorded by the client. Example: CONFIRMED, INCOMPLETE, NOT_COLLECTED |
| brand_id | Brand | ID | Type: string · Optional 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. Example: brand-eu-01 |
| cust_declared_monthly_income | Customer | Declared Monthly Income | Type: float · Optional The customer's self-declared monthly income, in the client's local currency. See cust_declared_monthly_income_eur for the normalised version. |
| cust_email_reputation_score | Customer | Email Reputation Score | Type: int · Optional 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. |
| cust_employee_account_tag | Customer | Employee Account Tag | Type: bool · Optional 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. |
| cust_employer_name | Customer | Employer Name | Type: string · Optional The name of the customer's declared employer. Distinct from cust_name, which is the customer's own name. Example: Acme Logistics Ltd |
| cust_expected_annual_activity | Customer | Expected Annual Activity | Type: float · Optional The customer's expected annual transaction volume as declared at onboarding, in the client's local currency. |
| cust_hours_since_identity_update | Customer | Hours Since Identity Update | Type: int · Optional 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. |
| cust_id_doc_type | Customer | ID Document Type | Type: enum · Optional The type of identity document the customer used to verify their identity. Allowed values: PASSPORT, NATIONAL_ID, DRIVERS_LICENSE, OTHER |
| cust_identity_doc_num | Customer | Identity Document Number | Type: string · Optional The document number of the customer's identity document (see cust_id_doc_type for the document type). Example: P1234567 |
| cust_identity_inconsistency_flag | Customer | Identity Inconsistency Flag | Type: bool · Optional Whether the client's identity verification vendor flagged an inconsistency across the customer's supplied identity documents. Client/vendor-supplied, not Fraugster-computed. |
| cust_kyc_expiry_date | Customer | KYC Expiry Date | Type: date · Optional The date on which the customer's current KYC verification expires and must be refreshed. |
| cust_kyc_tier | Customer | KYC Tier | Type: enum · Optional The level of KYC verification the customer has completed with the client. Allowed values: BASIC, STANDARD, ENHANCED |
| cust_m_f | Customer | Gender | Type: enum · Optional The gender of the customer. Allowed values: M, F, O |
| cust_phone_reputation_score | Customer | Phone Reputation Score | Type: int · Optional 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. |
| cust_residency_status | Customer | Residency Status | Type: enum · Optional The customer's declared residency status relative to the client's jurisdiction. Allowed values: RESIDENT, NON_RESIDENT, UNKNOWN |
| cust_risk_rating | Customer | Risk Rating | Type: enum · Optional 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. Allowed values: LOW, MEDIUM, HIGH |
| cust_segment | Customer | Segment | Type: enum · Optional The client's own customer segmentation (e.g. retail, premium, business), distinct from m_segment which classifies the transaction rather than the customer. Allowed values: RETAIL, PREMIUM, BUSINESS |
| cust_street_level_ad | Customer | Street-Level Address | Type: string · Optional 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. Example: 221B Baker Street |
| cust_thin_file_flag | Customer | Thin File Flag | Type: bool · Optional 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. |
| cust_type | Customer | Type | Type: enum · Optional The type of customer as classified by the client - individual, corporate, or a similar business-relationship distinction. Allowed values: INDIVIDUAL, CORPORATE, OTHER |
| occupation | Customer | Occupation | Type: string · Optional The customer's stated occupation or line of business, used to judge whether observed activity is consistent with declared means. Example: Software engineer, Retired, Construction contractor |
| requester_idv_status | Requester | Identity verification status | Type: string · Optional The outcome of identity verification on the party requesting the transaction, as recorded by the client. Example: VERIFIED, NOT_VERIFIED, PENDING |
| sof_declared | Customer | Source of funds declared | Type: string · Optional 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. Example: Salary, Business income, Sale of property |
| sof_evidence_ref | Customer | Source of funds evidence reference | Type: string · Optional The client's reference to the evidence held for the declared source of funds, so a reviewer can retrieve the document behind the determination. Example: SOF-DOC-2026-00123 |
| sof_review_date | Customer | Source of funds review date | Type: date · Optional 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. Example: 2026-03-14Z |
| sof_status | Customer | Source of funds status | Type: string · Optional 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. Example: VERIFIED, UNVERIFIED, MISSING |
| sow_status | Customer | Source of wealth status | Type: string · Optional The verification state of the declared source of wealth. The counterpart of sof_status, and the determination against the existing source_of_wealth claim. Example: VERIFIED, UNVERIFIED, MISSING |
| wagering_amt | Wagering | Amount | Type: float · Optional The amount wagered in a single gaming session event, as supplied by the client. Momentum-specific. |
General | Device
| Name | Display Name | Description |
|---|---|---|
| browser_user_agent | Browser | User agent | Type: string · Optional The web browser user agent. Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Safari/537.36 |
| brwsr_addons | Browser | Add-ons | Type: string · Optional A list of add-ons installed on user's browser. Example: Adblock Plus, FeedsPlus, Affine |
| brwsr_lang | Browser | Language | Type: string · Optional The language of the customer's web browser. Example: en-US |
| brwsr_ts | Browser | Timestamp | Type: timestamp · Optional Web browser timestamp at the time of the purchase. Example: 2017-12-03T11:52:06Z |
| brwsr_type | Browser | Type | Type: string · Optional The type of the customer's web browser. Example: Firefox |
| brwsr_version | Browser | Version | Type: string · Optional The version of the customer's web browser. Example: 65.0.2 (64-bit) |
| device_crt_ts | Device | Timestamp | Type: timestamp · Optional The timestamp on the device when the transaction happened. |
| device_manufacturer | Device | Manufacturer | Type: string · Optional The manufacturer of the customer's device. Example: Samsung |
| device_name | Device | Name | Type: string · Optional The name of the customer's device. Example: Grace’s MacBook Pro |
| device_type | Device | Type | Type: string · Optional The device type of the customer. Example: iPhone |
| device_version | Device | Version | Type: string · Optional The version of the customer's device. Example: 4.1 |
| os_lang | OS | Language | Type: string · Optional Language of the operating system on the customer's device. Example: en-GB |
| os_ts | OS | Timestamp | Type: timestamp · Optional The operating system timestamp at the time of the purchase. Example: 2017-12-03T11:52:06Z |
| os_type | OS | Type | Type: string · Optional Type of the customer's operating system. Example: iOS 10.1.1 |
| os_version | OS | Version | Type: string · Optional The version of the operating system on the customer's device. Example: macOS Mojave 10.14.3 |
| screen_dpi | Screen | DPI | Type: string · Optional The DPI (dots per inch) value of customer's screen. Example: 120 x 120 |
| screen_x | Screen | Horizontal resolution | Type: string · Optional The horisontal (x-axis) value of the customer's screen resolution. Example: 800 |
| screen_y | Screen | Vertical resolution | Type: string · Optional The vertical (y-axis) value of the customer's screen resolution. Example: 600 |
| support_cookie | Browser | Cookie support | Type: bool · Optional Indicates if the user's browser supports and is not blocking cookies. |
| support_flash | Browser | Flash support | Type: bool · Optional Indicates if the user's browser supports Flash. |
| support_geo | Browser | Geolocation support | Type: bool · Optional Indicates if the user's browser supports geolocation. |
| support_java | Browser | Java support | Type: bool · Optional Indicates if the user's browser supports Java. |
| support_js | Browser | JavaScript support | Type: bool · Optional Indicates if the user's browser supports JavaScript. |
| device_fingerprint | Device | Fingerprint | Type: string · Optional 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. Example: FP78K9L2M3N4 |
| virtual_machine | Device | Virtual machine | Type: enum · Optional Specifies if the device used for the purchase is not a physical device but rather a virtual machine. Allowed values: device_simulator, device_emulator |
General | Device Id
| Name | Display Name | Description |
|---|---|---|
| device_id | Device | ID | Type: string · Optional Device identification code. Example: 2fc4b5912826ad1 |
| device_id_exact | Device | Exact ID | Type: string · Optional 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. Example: ATHjII4ALRQySeFH1hmaC5svTtgg |
| device_id_shared_across_accounts | Device | ID shared across accounts | Type: bool · Optional Indicates whether the same device ID has been used by more than one customer account. |
| device_id_smart | Device | Smart ID | Type: string · Optional 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. Example: AGlYUjsSx4fCMnEfrNSFQVqoXjko |
| device_reputation | Device | Reputation | Type: string · Optional 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'. Example: risky_device_behavior, risky_ip_reputation, risky_ip_behavior |
| device_score | Device | Score | Type: float · Optional 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'. Example: 42.01 |
General | Ip Address
| Name | Display Name | Description |
|---|---|---|
| ip | IP | Type: string · Optional The IP address of the customer. Example: 192.168.0.1 |
| ip_hashed | IP | Hashed value | Type: string · Optional The hashed value of the IP address. Example: 6023d6a87eec89bf628b2520434a1065ac4da0e0 |
General | Merchant
| Name | Display Name | Description |
|---|---|---|
| custom_threshold | Merchant | Custom threshold | Type: float · Optional A custom threshold value provided by the merchant, usable in rules or downstream logic. Example: 1.5 |
| platform_id | Platform ID | Type: string · Optional The name of the payment platform. Example: GlobalCollect |
| regions_or_blocked_regions | Merchant | Regions (blocked or allowed) | Type: string · Optional Comma-separated list of regions/country codes provided by the merchant. Can be used as blocked regions or for other custom purposes. Example: EU,NA |
| seller_id | Merchant | ID | Type: string · Optional The identification code of the merchant. Example: ABG826 |
| slr_asp | Merchant | Average sales price | Type: float · Optional The ASP (average sales price) of the merchant. Example: 5.99 |
| slr_crncy | Merchant | Currency | Type: enum · Optional The operating currency of the merchant. Allowed values: An ISO 4217 currency code, for example EUR, USD, GBP. The full list of accepted codes is in datapoints.json under enums → currency_codes. |
| slr_ctry | Merchant | Country | Type: enum · Optional 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. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| slr_ind | Merchant | Industry | Type: string · Optional The industry where the merchant operates. You can either have this configured in the configuration service or send this information in the API request. Example: Perfumery/duty free |
| slr_ind_cat | Merchant | Industry category | Type: string · Optional The industry category of the merchant. You can either have this configured in the configuration service or send this information in the API request. Example: 3 Retail |
| slr_ind_mcc | Merchant | MCC | Type: string · Optional 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. Example: 5641 |
| slr_name | Merchant | Name | Type: string · Optional The name of the merchant. You can either have this configured in the configuration service or send this information in the API request. Example: Square Enix |
| sub_seller | Sub-merchant | ID | Type: string · Optional The identification code of the sub-merchant. Example: 8897 |
General | Purchase
| Name | Display Name | Description |
|---|---|---|
| affiliate_partner | Purchase | Affiliate partner | Type: string · Optional Indicates the affiliate partner that generated the customer. Example: BigCommerce |
| agency_country | Purchase | Agency country name | Type: enum · Optional 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'. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| agency_name | Purchase | Agency name | Type: string · Optional The name of the agency that facilitated the purchase. Example: Clubhotel Reisen GmbH |
| booking_invoice_number | Booking | Invoice number | Type: string · Optional The invoice number for the booking transaction. Refers to the booking of any types of goods or services like a ticket, trip, etc. Example: 45738/2021 |
| booking_is_flexi | Booking | Flexible cancellation | Type: bool · Optional 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. |
| booking_is_restricted | Booking | Restricted | Type: bool · Optional Indicates whether the booking is restricted (non-refundable). |
| booking_persons_number | Booking | Persons in the booking | Type: int · Optional The number of persons included in the booking. Example: 1 |
| delivery_method | Purchase | Delivery method | Type: enum · Optional Indicates the delivery method of the purchased goods. Allowed values: electronic, shipping_address, pickup, branch_shop, hq, pickup_packstation |
| exchange_ticket_price | Ticket | Exchange price | Type: float · Optional The price of the exchange ticket before any discounts or vouchers are applied. Example: 155,70 |
| first_purchase | Purchase | First with the merchant | Type: bool · Optional 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. |
| giftcard_message | Gift card | Message | Type: string · Optional The message added for the gift card being shipped. Example: Happy birthday! |
| hs_code | Goods | HS Code | Type: string · Optional The Harmonized System commodity classification code for the traded goods. Distinct from goodies_score, which is Fraugster's unrelated ML classifier output. Example: 8517.12 |
| includes_giftcard | Purchase | Includes gift card | Type: enum · Optional Indicates whether the purchase order includes gift cards as items. Allowed values: only, yes, no |
| includes_preorder | Purchase | Includes pre-ordered item | Type: bool · Optional Purchase includes one or more pre-ordered item. |
| item_is_subscription | Purchase | Subscription | Type: bool · Optional Indicates if the item purchased is a subscription. Generally, subscription products are less risky. |
| item_on_sale | Purchase | Item on sale | Type: bool · Optional Indicates if the item was purchased during a sale. |
| item_preorder | Purchase | Preorder | Type: bool · Optional Indicates if the purchased item is a preorder. Generally, preordered purchases are way less risky. |
| items | Purchase | Items | Type: ShoppingCartItem[] · Optional The attribute represents items in the shopping cart of the customer. Each item is a ShoppingCartItem object. Example: [ {"item_id":"DF42","item_desc":"Belt"} ] |
| loyalty_account_number | Purchase | Loyalty account number | Type: string · Optional The loyalty account number of the customer. Send this datapoint if you're sending 'loyalty_program_used = true'. Example: 2934-YS |
| loyalty_program_name | Purchase | Loyalty program name | Type: string · Optional Indicates what loyalty program the customer is part of. Send this datapoint if you're sending 'loyalty_program_used = true'. Example: SkyMiles |
| loyalty_program_used | Purchase | Loyalty program | Type: bool · Optional Indicates whether the customer belongs to a loyalty program. |
| order_id | Merchant | Order ID | Type: string · Optional 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'). Example: 1128-4000050556-1 |
| order_method | Merchant | Order method | Type: enum · Optional The method used to make the order. Allowed values: delayed_payment, invoice, ecommerce, mail_order, installment |
| purchase_extra_services | Purchase | Extra services ordered | Type: enum · Optional Indicates any extra services that were ordered with the purchase. Allowed values: preselected_seats, priority_boarding, flex_fee, hotel_transfer, lounge_transfer, meet_and_greet, a_la_carte_menu, check_in_baggage, additional_hand_baggage, flight_insurance, medical_insurance, car_rental, hotel_reservation, sightseeing_tour, other, private_parking, wellness, meeting_banquet, location_pickup, location_dropoff |
| region_locked | Purchase | Region locked | Type: enum · Optional 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. Allowed values: anatolia, balkans, caribbeans, central_america, central_asia, east_africa, east_asia, east_eu, middle_east, north_africa, north_america, north_eu, oceania, south_america, south_asia, south_central_africa, south_east_asia, west_africa, west_eu, antarctics |
| sales_channel | Transaction | Sales channel | Type: enum · Optional The transaction's sales channel. Allowed values: b2b, b2c, agency_sales, online_sales, offline_sales, other |
| ship_comments | Purchase | Shipping comments | Type: string · Optional Additional comments regarding the shipping of the goods. Example: Deliver to the neighbor. |
| ship_giftcard_message | Gift card | Shipping message | Type: string · Optional The message of the shipping gift card. Example: Happy birthday! |
| ship_giftcard_type | Gift card | Type | Type: string · Optional The type of gift card being shipped. Example: Grandparents Day |
| ship_more | Purchase | Additional shipping comments | Type: string · Optional Additional shipping information. Example: 4th floor – left side |
| subscription_active | Purchase | Subscription active | Type: bool · Optional Indicates if the customer has an active subscription with the merchant. |
| subscription_end_date | Purchase | Subscription end date | Type: date · Optional 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. Example: 2021-10-04T |
| third_party_booking | Purchase | Third-party booking | Type: bool · Optional Indicates whether the booking was made by a third-party entity. |
| ticket_currency | Purchase | Ticket currency | Type: enum · Optional The SO-3 currency code in which 'ticket_price' is given. Allowed values: An ISO 4217 currency code, for example EUR, USD, GBP. The full list of accepted codes is in datapoints.json under enums → currency_codes. |
| ticket_device_used | Purchase | Device and app type | Type: enum · Optional Indicates the device and app type used to make the booking for a ticket. Allowed values: mobile_browser, mobile_app, desktop, tablet_browser, tablet_app |
| ticket_exchange_fee | Ticket | Exchange fee | Type: float · Optional The fee applied for exchanging an issued ticket. Example: 50,00 |
| ticket_issue_date | Ticket | Issue date | Type: timestamp · Optional An RFC3339-encoded UTC timestamp indicating the date when the ticket was issued. Example: 2021-10-04T15:20:44 |
| ticket_itinerary_legs_count | Ticket | Itinerary legs | Type: int · Optional Trip path information, i.e. the number of legs in the itinerary. Example: 2 |
| ticket_price | Purchase | Ticket price | Type: float · Optional The full price of the ticket before any discounts or vouchers are applied. Example: 349 |
| ticket_transaction_type | Ticket | Transaction type | Type: enum · Optional The type of transaction carried out for the ticket. Allowed values: exchange, misc, refund, purchase |
| time_from_first_visit | Purchase | Time from first visit | Type: int · Optional 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. |
| time_to_purchase | Purchase | Time to purchase | Type: int · Optional 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. |
| trade_item_assessed_market_value | Trade | Item Assessed Market Value | Type: float · Optional The independently assessed market value of the traded item or goods, for comparison against the declared invoice value. |
| voucher_used | Purchase | Promo voucher used | Type: bool · Optional Indicates if the item was purchased with a promo voucher. |
General | Shipping Address
| Name | Display Name | Description |
|---|---|---|
| packstation_id_dp | Shipping address | DHL Packstation ID | Type: string · Optional 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. Example: 123, 445 |
| postnummer_dp | Shipping address | Personal customer number | Type: string · Optional 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. Example: 12345678, 44566741 |
| ship_ad_city | Shipping address | City | Type: string · Optional The city on the shipping address. Example: London |
| ship_ad_city_norm_dp | Shipping address | City normalized by the payment company | Type: string · Optional The normalized value of the city on the shipping address provided by the payment company. Example: buenosaires, newyork |
| ship_ad_ctry | Shipping address | Country | Type: enum · Optional The country on the shipping address. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| ship_ad_ctry_norm_dp | Shipping address | Country normalized by payment company | Type: enum · Optional The normalized value of the country on the shipping address provided by the payment company. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| ship_ad_email | Shipping address | Email | Type: string · Optional The email address of the customer on the shipping address. Example: grace.hopper@example.com |
| ship_ad_first_name | Shipping address | First name | Type: string · Optional The first name of the customer on the shipping address. Example: Grace |
| ship_ad_house_num | Shipping address | House number | Type: string · Optional The house number on the shipping address. Example: 7, 27/4 |
| ship_ad_house_num_norm_dp | Shipping address | House number normalized by payment company | Type: string · Optional The normalized value of the house number on the shipping address provided by the payment company. Example: 4, 40 |
| ship_ad_last_name | Shipping address | Last name | Type: string · Optional The last name of the customer on the shipping address. Example: Hopper |
| ship_ad_line1 | Shipping address | Street and building number | Type: string · Optional The street and building number on the shipping address. Example: 44 Ashgrove Road |
| ship_ad_line1_norm_dp | Shipping address | Street and building number normalized by payment company | Type: string · Optional The normalized value of the street and building number on the shipping address provided by the payment company. Example: 44 Ashgrove Road |
| ship_ad_line2 | Shipping address | Apartment number | Type: string · Optional The apartment or flat number on the shipping address. Example: Apt. 4 |
| ship_ad_line3 | Shipping address | Additional info | Type: string · Optional Further additional address information on the shipping address. Example: 2nd floor – left side, 2nd floor |
| ship_ad_line3_norm_dp | Shipping address | Additional info normalized | Type: string · Optional The normalized value of additional details on the shipping address. Example: 2nd floor |
| ship_ad_middle_name | Shipping address | Middle name | Type: string · Optional The middle name of the customer on the shipping address. Example: Brewster Murray |
| ship_ad_name | Shipping address | Full name | Type: string · Optional 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. Example: Grace Brewster Murray Hopper |
| ship_ad_phone | Shipping address | Phone number | Type: string · Optional The phone number that the customer specified for the shipping address. Example: 030-4247582047 |
| ship_ad_state | Shipping address | State | Type: string · Optional The state or another unit of administrative division on the shipping address. Example: New York, Bavaria |
| ship_ad_zip | Shipping address | Postal code | Type: string · Optional The postal code on the shipping address. Example: 10179 |
| ship_ad_zip_norm_dp | Shipping address | Postal code normalized by payment company | Type: string · Optional The normalized value of the postal code on the shipping address provided by the payment company. Example: 10179 |
| ship_name_title | Shipping address | Courtesy title | Type: string · Optional The courtesy title of the customer on the shipping address. Example: Dr. |
General | Transaction
| Name | Display Name | Description |
|---|---|---|
| acquirer_ctry | Transaction | Acquirer country | Type: enum · Optional The country of the acquiring bank. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| amount_cad | Transaction | Amount in CAD as supplied | Type: float · Optional The Canadian-dollar value of the transaction as supplied by the client, converted at the client's own rate and time. Example: 10000.00 |
| asset_class | Transaction | Asset class | Type: enum · Optional Whether the transaction moves fiat money or virtual currency. Supplied by the client. Allowed values: FIAT, VC |
| beneficial_owner_entity_type | Beneficial owner | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| beneficial_owner_name | Beneficial owner | Name | Type: string · Optional The full name of the account holder's beneficial owner. Used to screen the beneficial owner. Example: Maria Garcia |
| branch_id | Transaction | Branch ID | Type: string · Optional 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). Example: BR-0142 |
| bulk_job_id | Transaction | Bulk job ID | Type: string · Optional Optional identifier that links a transaction to a bulk upload job. Example: 0f9ef8c5-1a0a-4d56-8b53-9dfca7b4cf8b |
| conductor_entity_type | Conductor | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| conductor_id | Conductor | ID as per merchant | Type: string · Optional The ID of the party who conducted the transaction, who may differ from the account holder it was conducted for. Example: COND12345, 98765 |
| conductor_is_customer | Conductor | Is the account holder | Type: bool · Optional Whether the conductor of the transaction is the account holder themselves. False marks a transaction conducted by one party on another's account. |
| conductor_name | Conductor | Name | Type: string · Optional The full name of the party who conducted the transaction. Used to screen the conductor separately from the account holder. Example: Jane Doe |
| controlling_person_entity_type | Controlling person | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| controlling_person_name | Controlling person | Name | Type: string · Optional The full name of the person controlling the account holder. Used to screen the controlling person. Example: Ahmed Khan |
| counterparty_entity_type | Counterparty | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| counterparty_name | Counterparty | Name | Type: string · Optional The full name of the transaction's counterparty. Used to screen the counterparty. Example: Acme Trading Ltd |
| custom | Custom attributes | Type: custom · Optional An object that contains arbitrary fields not directly managed by shufti. Can be sent with each transaction and used for rule creation. |
| dest_country | Transaction | Destination country | Type: enum · Optional 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. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| expected_monthly_volume | Transaction | Expected monthly volume | Type: float · Optional The expected monthly volume of the transaction in the original currency. The value is between 0 and 1000000. Example: 10000.00 |
| fireblocks_ref | Transaction | Fireblocks reference | Type: string · Optional The client's Fireblocks transaction reference, tracing a monitored transaction back to the custody platform that executed it. Example: fb_tx_8f3c21a0 |
| from_asset | Transaction | Asset sent | Type: string · Optional The asset the transaction sends or converts FROM - a fiat currency code or a virtual-currency ticker. Example: CAD, BTC, USDT |
| fx_rate | Transaction | FX rate to CAD as supplied | Type: float · Optional The exchange rate the client applied to convert the transaction amount into amount_cad. Example: 1.3642 |
| fx_rate_source | Transaction | FX rate source as supplied | Type: string · Optional Where the client's exchange rate came from (provider or desk). Example: Bank of Canada |
| fx_timestamp | Transaction | FX rate timestamp as supplied | Type: timestamp · Optional The moment the client's exchange rate was taken. Expected to be close to trans_ts. Example: 2026-10-14T09:30:00Z |
| grace_period_end_ts | Grace period end timestamp | Type: timestamp · Optional End of the grace period for deposits. Transactions with ts after this timestamp can be restricted by rules. |
| intermediary_fi_entity_type | Intermediary FI | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| intermediary_fi_name | Intermediary FI | Name | Type: string · Optional The name of an intermediary financial institution (bank, payment institution, VASP, exchange, custodian or wallet provider) in the transaction. Used to screen it. Example: Royal Bank of Canada |
| is_3ds_approved | Transaction | Is 3D approved | Type: enum · Optional Indicates whether the transaction was authenticated with 3D Secure. Relevant in cases where shufti is integrated after authentication and/or authorization. Allowed values: fully_authenticated, not_authenticated, partially_authenticated, unable, failed_authentication |
| is_recurring | Transaction | Is recurring | Type: bool · Optional 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. |
| is_self_transfer | Transaction | Is a self-transfer | Type: bool · Optional Whether the sender and the recipient of the transfer are the same person or entity. Supplied by the client. |
| merchant_entity_type | Merchant | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| merchant_name | Merchant | Name | Type: string · Optional The name of the merchant involved in the transaction. Used to screen the merchant. Example: Coffee Corner Inc |
| orig_country | Transaction | Origin country | Type: enum · Optional 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. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| originator_entity_type | Originator | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| originator_id | Originator | ID as per merchant | Type: string · Optional 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. Example: ORIG12345, 98765 |
| originator_name | Originator | Name | Type: string · Optional The full name of the party the funds originate from. Used to screen the originator. Example: John Smith |
| payment_service_provider | Transaction | Payment service provider (PSP) | Type: enum · Optional The name of the payment service provider or gateway routing the transaction (e.g., Adyen, Stripe, Checkout.com). Allowed values: adyen, stripe, checkout.com, worldpay, nuvei |
| recurrence_type | Transaction | Recurrence type | Type: string · Optional Specifies what recurrence type the transaction has. Only relevant to recurrent transactions. Example: FirstRecurring |
| rule_sets | Transaction | Rule Sets | Type: string[] · Optional 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. Example: ["Gambling", "Trading"] |
| rule_type | Transaction | Rule Type | Type: string · Optional 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. Example: payout |
| sending_wallet_address | Transaction | Sending wallet address | Type: string · Optional The blockchain address the virtual-currency transfer was sent from. Example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq |
| third_party_entity_type | Third party | Entity Type | Type: enum · Optional 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. Allowed values: PERSON, ENTITY |
| third_party_id | Third party | ID as per merchant | Type: string · Optional 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. Example: TP12345, 98765 |
| third_party_name | Third party | Name | Type: string · Optional The full or legal name of the third party the transaction was conducted on behalf of. Used to screen the third party. Example: Northwind Holdings Inc |
| third_party_relationship | Third party | Relationship to the customer | Type: string · Optional The relationship between the third party and the account holder, as recorded by the client. Example: Employer, Family member, Business partner |
| third_party_role | Third party | Role | Type: string · Optional The role the third party plays in the transaction, as recorded by the client. Example: Payer, Payee, Agent |
| third_party_status | Third party | Determination | Type: enum · Optional Whether the transaction was conducted on behalf of a third party: YES, NO, or UNKNOWN when the determination could not be made. Allowed values: YES, NO, UNKNOWN |
| to_asset | Transaction | Asset received | Type: string · Optional The asset the transaction sends or converts TO - a fiat currency code or a virtual-currency ticker. Example: CAD, XMR, ETH |
| trans_amt | Transaction | Amount | Type: float · Optional The transaction amount in the original currency. Example: 23.15 |
| trans_currency | Transaction | Currency | Type: enum · Optional SO-3 currency code in which 'trans_amt' is given. Allowed values: An ISO 4217 currency code, for example EUR, USD, GBP. The full list of accepted codes is in datapoints.json under enums → currency_codes. |
| trans_exchange_direction | Transaction | Exchange Direction | Type: enum · Optional Whether the transaction is a currency purchase or sale at the exchange counter. Allowed values: BUY, SELL |
| trans_id | Transaction | ID | Type: string · Required 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'). Example: X1234567 |
| trans_is_b2b | Transaction | Is B2B | Type: bool · Optional Indicates if the transaction is a B2B transaction. |
| trans_purpose_description | Transaction | Purpose Description | Type: string · Optional The free-text purpose or reason for the transaction, as declared by the customer at initiation. Example: Family support |
| trans_reversed_and_resent_to_different_ba | Transaction | Reversed and Resent to Different Beneficiary | Type: bool · Optional 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. |
| trans_status | Transaction | Status | Type: string · Optional Specifies the transaction approval status communicated by the client. Example: Approved, Declined |
| trans_ts | Transaction | Timestamp | Type: timestamp · Optional Transaction timestamp reported by the client. Example: 2009-11-10T23:00:00Z |
| transaction_type | Transaction | Type | Type: string · Optional 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. Example: deposit, transfer |
Industry | Airlines
| Name | Display Name | Description |
|---|---|---|
| airticket_agency_code | Airlines | IATA agency code | Type: string · Optional IATA code for the travel agency that issued the ticket. Example: 13-3 4637 004 |
| airticket_airline_name | Airlines | Airline name | Type: string · Optional The name of the airline. Example: Lufthansa, Delta |
| airticket_arrival_ts | Airlines | Arrival timestamp | Type: timestamp · Optional 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'. Example: 2021-11-10T23:00:00Z |
| airticket_booking_pos_city | Airlines | Booking (POS) city | Type: string · Optional The city where the customer made the payment for the ticket and where sales taxes may become applicable. Example: Santiago |
| airticket_class | Airlines | Ticket class | Type: enum · Optional 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. Allowed values: P, F, A, C, J, D, I, Z, Y, W, S, B, H, K, L, M, N, Q, V, other, G, T, R, U, O, E |
| airticket_days_to_departure | Airlines | Days to departure | Type: int · Optional Indicates the number of days before the airplane departure. Example: 3 |
| airticket_delivery_method | Airlines | Ticket delivery method | Type: string · Optional The delivery method for the airline ticket. Example: electronic |
| airticket_departure_ts | Airlines | Departure timestamp | Type: timestamp · Optional 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'. Example: 2009-11-10T23:00:00Z |
| airticket_electronic_ticket | Airlines | Electronic ticket | Type: bool · Optional Indicates whether the ticket booking was made electronically. |
| airticket_first_departure_airport | Airlines | First departure airport | Type: string · Optional IATA code for the first departure airport in the itinerary. Example: BER |
| airticket_issuer_address | Airlines | Issuer address | Type: string · Optional The address of the company issuing the ticket. Example: Place Georges-Pompidou, 75004 Paris |
| airticket_issuer_name | Airlines | Issuer name | Type: string · Optional The name of the ticket issuer. May differ from the airline name. Example: ExpediaTravel |
| airticket_last_arrival_airport | Airlines | Last arrival airport | Type: string · Optional IATA code for the last arrival airport in the itinerary. Example: NAP |
| airticket_leg1_arrival_airport | Airlines | Arrival airport | Leg 1 | Type: string · Optional IATA code for the arrival airport in the first leg of the trip. Example: FCO |
| airticket_leg1_arrival_time_segment | Airlines | Arrival time segment | Leg 1 | Type: enum · Optional The arrival time segment for the first leg of the trip. Allowed values: am, pm |
| airticket_leg1_arrival_ts | Airlines | Arrival time | Leg 1 | Type: timestamp · Optional 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'. Example: 2021-10-04T15:20:44 |
| airticket_leg1_carrier_code | Airlines | IATA carrier code | Leg 1 | Type: string · Optional IATA code for the airline for the first leg of the trip. Example: 7H |
| airticket_leg1_class | Airlines | Ticket class | Leg 1 | Type: enum · Optional 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. Allowed values: P, F, A, C, J, D, I, Z, Y, W, S, B, H, K, L, M, N, Q, V, other, G, T, R, U, O, E |
| airticket_leg1_departure_airport | Airlines | Departure airport | Leg 1 | Type: string · Optional IATA code for the departure airport in the first leg of the trip. Example: FCO |
| airticket_leg1_departure_time_segment | Airlines | Departure time segment | Leg 1 | Type: enum · Optional The departure time segment for the first leg of the trip. Allowed values: am, pm |
| airticket_leg1_departure_ts | Airlines | Departure time | Leg 1 | Type: timestamp · Optional 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'. Example: 2021-10-04T15:20:44 |
| airticket_leg1_flight_number | Airlines | Flight number | Leg 1 | Type: string · Optional The flight number for the first leg of the trip. Example: DF3409 |
| airticket_leg1_price | Airlines | Ticket price | Leg 1 | Type: float · Optional The full price of the ticket for the first leg of the trip, before any discounts or vouchers are applied. Example: 49,99 |
| airticket_leg1_stopover | Airlines | Stopover allowed | Leg 1 | Type: bool · Optional Indicates whether a stopover is allowed on the first leg of the trip. |
| airticket_leg2_arrival_airport | Airlines | Arrival airport | Leg 2 | Type: string · Optional IATA code for the arrival airport in the second leg of the trip. Example: CDG |
| airticket_leg2_arrival_time_segment | Airlines | Arrival time segment | Leg 2 | Type: enum · Optional The arrival time segment for the second leg of the trip. Allowed values: am, pm |
| airticket_leg2_arrival_ts | Airlines | Arrival time | Leg 2 | Type: timestamp · Optional 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'. Example: 2021-10-04T15:20:44 |
| airticket_leg2_carrier_code | Airlines | IATA carrier code | Leg 2 | Type: string · Optional IATA code for the airline for the second leg of the trip. Example: 7H |
| airticket_leg2_class | Airlines | Ticket class | Leg 2 | Type: enum · Optional 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. Allowed values: P, F, A, C, J, D, I, Z, Y, W, S, B, H, K, L, M, N, Q, V, other, G, T, R, U, O, E |
| airticket_leg2_departure_airport | Airlines | Departure airport | Leg 2 | Type: string · Optional IATA code for the departure airport in the second leg of the trip. Example: FCO |
| airticket_leg2_departure_time_segment | Airlines | Departure time segment | Leg 2 | Type: enum · Optional The departure time segment for the second leg of the trip. Allowed values: am, pm |
| airticket_leg2_departure_ts | Airlines | Departure time | Leg 2 | Type: timestamp · Optional 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'. Example: 2021-10-04T15:20:44 |
| airticket_leg2_flight_number | Airlines | Flight number | Leg 2 | Type: string · Optional The flight number for the second leg of the trip. Example: DF3409 |
| airticket_leg2_price | Airlines | Ticket price | Leg 2 | Type: float · Optional The full price of the ticket for the second leg of the trip, before any discounts or vouchers are applied. Example: 49,99 |
| airticket_leg2_stopover | Airlines | Stopover allowed | Leg 2 | Type: bool · Optional Indicates whether a stopover is allowed on the second leg of the trip. |
| airticket_loyalty_program_num | Airlines | Loyalty account number | Type: string · Optional The number of the customer that belongs to a loyalty program. Send this datapoint if you're sending 'airticket_loyalty_program_used = true'. Example: 2934-YS |
| airticket_nr | Airlines | Ticket number | Type: string · Optional A 13-digit number that uniquely identifies the issued airline ticket. Example: 8382124676356 |
| airticket_pnr | Airlines | Passenger name record | Type: string · Optional The passenger name record for the ticket. Example: 230-U8F16G |
| airticket_purchase_type | Airlines | Purchase type | Type: enum · Optional Indicates the type of purchase in the booking. Allowed values: ticket_only, ticket_and_other, other_only |
| airticket_third_party_booking | Airlines | Third-party booking | Type: bool · Optional Indicates whether the booking was made by a third-party entity. |
Industry | Digital
| Name | Display Name | Description |
|---|---|---|
| digital_delivery_email | Digital | Delivery email | Type: string · Optional The email address where the digital product is supposed to be delivered. Example: grace.hopper@example.com |
| digital_event_date | Digital | Event date | Type: date · Optional Indicates the date of the event the customer is buying tickets for. The date part of an RFC3339 -encoded UTC timestamp. Example: 2021-10-04T |
| digital_lifetime_license | Digital | Lifetime license | Type: bool · Optional Indicates if the customer has a lifetime subscription with a merchant. |
| digital_product_category | Digital | Product category | Type: enum · Optional 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. Allowed values: digital_goods, digital_services, on-demand_digital, software, internet, gaming, travel, entertainment |
| digital_product_type | Digital | Product type | Type: enum · Optional 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. Allowed values: ebooks, audiobooks, digital_imagery, video_content, audio_content, music_streaming, video_streaming, paid_podcasts, computer_software, mobile_apps, hosting_services, saas_products, internet_providers, media_subscriptions, console_games, computer_games, mobile_games, accommodation_rentals, event_tickets, food_delivery_once, food_delivery_subscription, insurance, e_learning, online_ads, giftcards_prepaids |
Industry | Gaming
| Name | Display Name | Description |
|---|---|---|
| gaming_donatable_item | Gaming | Donatable item | Type: bool · Optional Specifies if the item purchased is donatable. |
| gaming_locked_country | Gaming | Locked country availability | Type: enum · Optional Indicates the country where an item is available. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| gaming_platform | Gaming | Platform | Type: enum · Optional Specifies the platform where the game is available. Allowed values: mobile, console, desktop |
| gaming_product_type | Gaming | Product type | Type: enum · Optional Specifies the type of the gaming product being purchased. Allowed values: game, dlc, premium_currency, soft_currency, cosmetic_items, character, loot_box, season_pass, battle_pass, starter_pack, other |
| gaming_tutorial_finished | Gaming | Tutorial finished | Type: bool · Optional 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. |
| gaming_user_ranking | Gaming | User ranking | Type: string · Optional Indicates the status/ranking the user has reached in a product. In some cases, a lower/non-existent ranking may indicate fraudulent activity. Example: advanced |
Industry | Hotels
| Name | Display Name | Description |
|---|---|---|
| hotels_days_until_stay | Hotels | Days until stay begins | Type: int · Optional The number of days until the arrival at the hotel. Example: 25 |
| hotels_final_price | Hotels | Final price | Type: float · Optional 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. Example: 435,50 |
| hotels_hotel_name | Hotels | Hotel name | Type: int · Optional The name of the hotel. Example: Grand Hotel Saint Lucia |
| hotels_lodging_days | Hotels | Lodging days | Type: int · Optional The number of lodging days at the hotel. Example: 14 |
| hotels_number_of_rooms | Hotels | Rooms in the booking | Type: int · Optional The number of rooms in the hotel booking. Example: 1 |
| hotels_payment_type | Hotels | Payment type | Type: enum · Optional The payment type used to pay for the stay at the hotel. Allowed values: credit_card, bank_transfer, delayed_payment, payment_at_hotel, paypal, agency_cc, other |
| hotels_room_type | Hotels | Room type | Type: string · Optional The type of the hotel room. Example: Sea view suite |
| hotels_stay_end_date | Hotels | Stay end date | Type: date · Optional The date of the departure from the hotel. The date part of an RFC3339 -encoded UTC timestamp. Example: 2022-01-02Z |
| hotels_stay_incl_weekend | Hotels | Stay includes weekend | Type: bool · Optional Indicates if the stay at the hotel includes at least one weekend. |
| hotels_stay_start_date | Hotels | Stay start date | Type: date · Optional The date of the arrival at the hotel. The date part of an RFC3339 -encoded UTC timestamp. Example: 2022-01-02Z |
Payment Method | Bank Transfer
| Name | Display Name | Description |
|---|---|---|
| ba_bic | Bank account | BIC | Type: string · Optional The BIC (bank identifier code) of the bank account. Up to 11 characters. Example: DEUTDEDBBER, BOFIIE2D |
| ba_first_name | Bank account | Account holder first name | Type: string · Optional The first name of the bank account holder. Example: Grace |
| ba_iban | Bank account | IBAN | Type: string · Optional IBAN (International bank account number). Up to 34 alphanumeric characters. Example: IE64BOFI90583812345678 |
| ba_last_name | Bank account | Account holder last name | Type: string · Optional The last name of the bank account holder. Example: Hopper |
| ba_middle_name | Bank account | Account holder middle name | Type: string · Optional The middle name of the bank account holder. Example: Brewster Murray |
| ba_name | Bank account | Account holder full name | Type: string · Optional 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'. Example: Grace Brewster Murray Hopper |
| ba_rtn_num | Bank account | Routing number | Type: string · Optional The routing number of the bank account. Example: 122105155 |
| first_payment_day | Open invoice | First payment day | Type: int · Optional The day of the month for the first installment. Example: 1 |
| pmt_due_date | Open invoice | Payment due date | Type: date · Optional The date on which the invoice payment is due. Example: 2018-01-25Z |
Payment Method | Bnpl
| Name | Display Name | Description |
|---|---|---|
| bnpl_active_order | BNPL | Active order | Type: bool · Optional Indicates if the customer has an active order with the merchant and is still paying installments on it. |
| bnpl_active_order_count | BNPL | Active order count | Type: int · Optional The number of active orders the customer has and is still paying installments on. Example: 2 |
| bnpl_collection_frequency | BNPL | Collection frequency | Type: int · Optional Indicates the frequency of installment collections in weeks. Example: if the collection happens once a month, the frequency is defined as every 4 weeks. Example: 4 |
| bnpl_credit_check_performed | BNPL | Credit check performed | Type: bool · Optional Indicates if a credit check was performed for the customer. Use 'bnpl_credit_score' if you want to send the credit score also. |
| bnpl_credit_score | BNPL | Credit score | Type: int · Optional 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. Example: 850 |
| bnpl_first_installment_due_date | BNPL | First installment | Due date | Type: timestamp · Optional An RFC3339-encoded UTC timestamp indicating the date on which the first installment is due. Example: 2019-02-04T15:04:05Z |
| bnpl_installments_count | BNPL | Installments count | Type: int · Optional 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. Example: 3 |
| bnpl_missed_payment | BNPL | Missed payment | Type: bool · Optional Indicates if the customer has ever missed an installment payment on previous orders. |
| bnpl_missed_payment_count | BNPL | Missed payment count | Type: int · Optional Indicates the number of times the customer missed installment payments on previous orders. Example: 5 |
| bnpl_order_count | BNPL | Order count | Type: int · Optional This count indicates the number of times the customer placed an order with this merchant. Example: 4 |
| bnpl_order_paid_off | BNPL | Previous order paid off | Type: bool · Optional 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. |
| bnpl_previous_order_value | BNPL | Previous order value | Type: float · Optional Indicates the total value of the items in the previous order. Example: 159,99 |
Payment Method | Cards
| Name | Display Name | Description |
|---|---|---|
| bin_ctry | BIN | Country | Type: enum · Optional The country of the credit card issuer. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| cc_bin | BIN | Number | Type: string · Optional The BIN number of the credit card (the first 6 digits). Example: 572543 |
| cc_cardholder | Credit card | Cardholder full name | Type: string · Optional 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'. Example: Grace Brewster Murray Hopper |
| cc_exp_dt | Credit card | Expiry date | Type: string · Optional The expiry date of the credit card in format MMYYYY. Example: 042023 |
| cc_exp_month | Credit card | Expiry month | Type: string · Optional The expiry month of the credit card. Example: 10 |
| cc_exp_year | Credit card | Expiry year | Type: string · Optional The expiry year of the credit card. Example: 2020 |
| cc_first_name | Credit card | Cardholder first name | Type: string · Optional The first name of the credit card holder. Example: Grace |
| cc_last_4_dig | Credit card | Last 4 digits | Type: string · Optional The last 4 digits of the credit card. Example: 1234 |
| cc_last_name | Credit card | Cardholder last name | Type: string · Optional The last name of the credit card holder. Example: Hopper |
| cc_middle_name | Credit card | Cardholder middle name | Type: string · Optional The middle name of the credit card holder. Example: Brewster Murray |
| cc_num_hash | Credit card | Hashed number | Type: string · Optional 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'. Example: 6T5tdyWRiuhPuFhupAZYZzFESBYrOiOoYyqO8Zb4WEw= |
| cc_num_type | Credit card | Number type | Type: string · Optional The type of the credit card number. Example: PAN |
| cc_num | Credit card number | Type: string · Optional The credit card number (PAN) of the customer. It gets replaced with a token when it reaches the shufti PCI-compliant environment. Example: 1111222233334444555566 |
| cc_sub_brand | Credit card | Sub-brand | Type: string · Optional The sub-brand of the credit card. Example: Visa Online |
| cvc | Credit card | CVC | Type: string · Optional The CVC (card verification code). The 3 digits on the back of the card. Example: 123 |
| cvc_error_code | Credit card | CVC error code | Type: string · Optional The error code captured for the CVC information. Example: 103 |
| cvc_error_message | Credit card | CVC error message | Type: string · Optional The error message captured for the CVC information. Example: CVC is not the right length. |
| cvc_source | Credit card | CVC source | Type: string · Optional The source of the CVC value. Example: GeneralValidation |
| bin_brand | BIN | Brand | Type: string · Optional The card brand of the customer's payment method. Letters and spaces only, up to 50 characters. Example: Mastercard, Visa |
| bin_issuer | BIN | Issuer | Type: string · Optional The issuer of the credit card. Example: New Millenium Bank, Deutsche Bank |
| cc_num_frg_token | Credit card | Encrypted number | Type: string · Optional 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. Example: 123123sdfl234kfi355n21123sdfl234kfi355nsf2421 |
Payment Method | General
| Name | Display Name | Description |
|---|---|---|
| pmt_method | Transaction | Payment method | Type: enum · Optional The payment method used for the transaction. Allowed values: cash, direct_debit, bnpl, banking_transfer, wallet, card, prepaid_voucher_giftcard, mobile |
| pmt_method_brand | Transaction | Payment method brand | Type: enum · Optional Indicates the specific payment method brand used by the customer. Allowed values: affirm, afterpay, alipay, amazon_pay, apple_pay, bancontact, billpay, bonus_card, eprzelewy24, eps, giropay, google_pay, ideal, myone, oney, jaccs, konbini, paybright, paydirekt, paypal, postfinance, rakuten_pay, sepa, sofort, twint, masterpass, visa_checkout, trustly, billink, bancontact_mobile, belfius, blik, coupons, credit_cards, cryptocurrency, dotpay, klarna_pay_now, klarna_pay_later, mb_way, mobile_pay, multibanco, my_bank, neteller, paysafecard, paysera, payshop, paytrail, rapid_transfer, skrill, swish, vipps, zimpler, kbc_cbc, cashpresso, mondu, mondu_installments |
Add-on Service | Sanctions Lists
| Name | Display Name | Description |
|---|---|---|
| cust_istr_flag | Customer | ISTR Flag | Type: enum · Optional Whether an Internal Suspicious Transaction Report has been raised against the customer. Allowed values: TRUE, FALSE, UNKNOWN |
| cust_str_filed | Customer | STR Filed | Type: enum · Optional Whether a Suspicious Transaction Report has been filed with the regulator for this customer. Allowed values: TRUE, FALSE, UNKNOWN |
Todo
| Name | Display Name | Description |
|---|---|---|
| cust_tmz_offset | Customer Timezone Offset | Type: string · Optional TODO. Example: -0500 |
Beneficiary
Details of the person or account receiving the funds. Send these for transfers and payouts so rules and AML screening can assess the receiving party.
| Name | Display Name | Description |
|---|---|---|
| beneficiary_id | Beneficiary | ID as per merchant | Type: string · Optional The ID of the beneficiary in the merchant's database. Letters, digits, hyphens and underscores, up to 255 characters. Example: BEN7H9K2L4M6 |
| beneficiary_name | Beneficiary | Full name | Type: string · Optional The full name of the beneficiary. Example: Michael Chen |
| beneficiary_email | Beneficiary | Email | Type: string · Optional The email address of the beneficiary. Must be a valid email address. Example: m.chen@example.com |
| beneficiary_dob | Beneficiary | Date of birth | Type: date · Optional The date of birth of the beneficiary. Cannot be in the future. Example: 1992-07-18Z |
| beneficiary_phone | Beneficiary | Phone | Type: string · Optional The phone number of the beneficiary. Digits only, optionally starting with +. Example: +8613912345678 |
| beneficiary_nationality | Beneficiary | Nationality | Type: string · Optional The nationality of the beneficiary. Example: Chinese |
| beneficiary_ba_bic | Beneficiary | Bank account | BIC | Type: string · Optional The BIC (bank identifier code) of the beneficiary's bank account. 8 to 11 uppercase letters and digits. Example: ICBKCNBJ110 |
| beneficiary_ba_iban | Beneficiary | Bank account | IBAN | Type: string · Optional The IBAN (international bank account number) of the beneficiary's bank account. Up to 34 uppercase letters and digits. Example: GB82WEST12345698765432 |
| beneficiary_ba_name | Beneficiary | Bank account | Account holder full name | Type: string · Optional The full name of the beneficiary's bank account holder. Example: Michael Chen |
| beneficiary_ba_rtn_num | Beneficiary | Bank account | Routing number | Type: string · Optional The routing number of the beneficiary's bank account. Exactly 9 digits. Example: 121000248 |
| beneficiary_bin_ctry | Beneficiary | BIN | Country | Type: enum · Optional The country of the card issuer for the beneficiary's payment method. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| beneficiary_bin_brand | Beneficiary | BIN | Brand | Type: string · Optional The card brand of the beneficiary's payment method. Letters and spaces only, up to 50 characters. Example: UnionPay |
| agent_ctry | Agent | Country | Type: enum · Optional 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. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| beneficiary_identified | Beneficiary | Identified | Type: bool · Optional Whether the beneficiary is an identified party rather than only a destination address. |
| beneficiary_idv_status | Beneficiary | Identity verification status | Type: string · Optional 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. Example: VERIFIED, NOT_VERIFIED, PENDING |
| beneficiary_wallet_address | Beneficiary | Wallet address | Type: string · Optional The blockchain address the virtual-currency transfer was sent to. Example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh |
| correspondent_account_id | Correspondent | Account ID | Type: string · Optional The account identifier of the correspondent bank used to route the payment, where the transaction passes through a correspondent banking relationship. Example: CORR-9981 |
| correspondent_bank_bic | Correspondent | Bank BIC | Type: string · Optional 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. Example: DEUTDEDBBER |
| correspondent_bank_ctry | Correspondent | Bank Country | Type: enum · Optional The country of the correspondent (intermediary) institution used to route the payment. An ISO 3166-1 alpha-2 code. Allowed values: An ISO 3166-1 alpha-2 country code, for example DE, GB, US. The full list of accepted codes is in datapoints.json under enums → country_code_iso. |
| correspondent_bank_name | Correspondent | Bank Name | Type: string · Optional 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. Example: Deutsche Bank AG |
AML Screening
| Name | Display Name | Description |
|---|---|---|
| aml_screening | AML Screening | Type: object · Optional AML screening object for the customer. |
| aml_screening.name | AML Screening Name | Type: object · Optional Name object used for AML screening checks. |
| aml_screening.name.full_name | AML Screening Full Name | Type: string · Optional Customer full name used for AML screening. Example: Sarah Martinez |
| aml_screening.filters | AML Screening Filters | Type: string[] · Optional AML filters to apply during screening. Example: Sanctions, PEP |
Beneficiary AML Screening
| Name | Display Name | Description |
|---|---|---|
| beneficiary_aml_screening | Beneficiary AML Screening | Type: object · Optional AML screening object for beneficiary screening. |
| beneficiary_aml_screening.name | Beneficiary AML Screening Name | Type: object · Optional Name object used for beneficiary AML checks. |
| beneficiary_aml_screening.name.full_name | Beneficiary AML Screening Full Name | Type: string · Optional Beneficiary full name used for AML screening. Example: Michael Chen |
| beneficiary_aml_screening.filters | Beneficiary AML Screening Filters | Type: string[] · Optional AML filters to apply for beneficiary screening. Example: Sanctions, Adverse Media |
Object Types
ShoppingCartItem
Each element of the items array is a ShoppingCartItem object with the fields below.
| Name | Display Name | Description |
|---|---|---|
| item_id | Item ID | Type: string 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. Example: 5586463 |
| unique_item_id | Unique item ID | Type: string 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. Example: NAK1237005000003 |
| item_desc | Item description | Type: string The description of the item, for example the category or group the item belongs to. Example: Laufschuhe AltaRun für Jungen |
| additional_description | Additional item description | Type: string Any additional details about the item, for example color, size, etc. Example: Red \| One Size |
| item_amt | Amount paid | Type: float The amount paid for the item in the currency of the transaction. |
| discount | Discount | Type: float The discount applied to the item in the currency of the transaction. |
| tax_rate | Tax rate | Type: float The tax rate applied to the item in percent. |
| quantity | Order quantity | Type: int The order quantity for this item in the purchase. |
| shop_id | Shop ID | Type: string 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. Example: Bill's Sandals Shop |
| item_category | Item category | Type: string The category of the item in the merchant’s system, for example mountain bikes or books. Example: Apparel |
| item_type | Item type | Type: string The type of purchased item, for example physical or digital. Example: digital |