Skip to main content

Atrium API

Transactions

A transaction represents any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, etc. Each transaction belongs to only one account.

Transaction Fields

Field NameData TypeDescription
account_guidStringA unique identifier for the account to which the transaction belongs. Defined by MX.
amountDecimalThe monetary amount of the transaction. Max length is 10,2.
categoryStringThe category of the transaction.
check_numberIntegerDEPRECATED. Use check_number_string instead.
check_number_stringStringThe check number for the transaction.
created_atStringThe date and time the transaction was stored in the MX system.
currency_codeStringThe three-character ISO 4217 currency code, e.g. USD.
dateStringThe date on which the transaction took place. This is the field used when searching for transactions by date. This field is generally the same as transacted_at, but uses posted_at as a fallback.
descriptionStringA human-readable version of the original_description field. This is provided by the MX Platform.
guidStringA unique identifier for the transaction. Defined by MX.
is_bill_payBooleanIf the transaction is a bill pay, this field will be true. Otherwise, this field will be false.
is_direct_depositBooleanIf the transaction is a direct deposit, this field will be true. Otherwise, this field will be false.
is_expenseBooleanIf the transaction is an expense, this field will be true. Otherwise, this field will be false.
is_feeBooleanIf the transaction is a fee, this field will be true. Otherwise, this field will be false.
is_incomeBooleanIf the transaction is income, this field will be true. Otherwise, this field will be false.
is_internationalBooleanIf the transaction is international as defined by the data provider, this field will be true. If the data provider determines it is not international then it will be false. It will be null if the data provider does not have this information.
is_overdraft_feeBooleanIf the transaction is an overdraft fee, this field will be true. Otherwise, this field will be false.
is_payroll_advanceBooleanIf the transaction is a payroll advance fee, this field will be true. Otherwise, this field will be false.
is_subscriptionBooleanIf the transaction represents a payment for a subscription service.
latitudeDecimalThe latitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's latitude is -22.9027800 and Tokyo's latitude is 35.689488).
longitudeDecimalThe longitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706).
member_guidStringA unique identifier for the member to which the transaction belongs. Defined by MX.
memostringThis field contains additional descriptive information about the transaction.
merchant_category_codeIntegerThe ISO 18245 category code for the transaction.
merchant_guidStringThe unique identifier for the merchant associated with this transaction. Defined by MX.
merchant_location_guidStringThe unique identifier for the merchant_location associated with this transaction. Defined by MX.
original_descriptionStringThe original description of the transaction as provided by our data feed. See description for more information.
posted_atStringThe date and time the transaction was posted to the account.
statusStringThe status of the transaction, i.e., POSTED or PENDING.
top_level_categoryStringThe parent category that this transaction's category is assigned to.
transacted_atStringThe date and time the transaction took place.
typeStringThe type of transaction, i.e., CREDIT or DEBIT.
updated_atStringThe date and time the transaction was updated.
user_guidStringA unique identifier for the user to which this transaction belongs. Defined by MX.

Transaction Categories

  • Auto & Transport
    • Auto Insurance
    • Auto Payment
    • Gas
    • Parking
    • Public Transportation
    • Service & Parts
  • Bills & Utilities
    • Domain Names
    • Fraud Protection
    • Home Phone
    • Hosting
    • Internet
    • Mobile Phone
    • Television
    • Utilities
  • Business Services
    • Advertising
    • Legal
    • Office Supplies
    • Printing
    • Shipping
  • Education
    • Books & Supplies
    • Student Loan
    • Tuition
  • Entertainment
    • Amusement
    • Arts
    • Movies & DVDs
    • Music
    • Newspapers & Magazines
  • Fees & Charges
    • ATM Fee
    • Banking Fee
    • Finance Charge
    • Late Fee
    • Service Fee
    • Trade Commissions
  • Financial
    • Financial Advisor
    • Life Insurance
  • Food & Dining
    • Alcohol & Bars
    • Coffee Shops
    • Fast Food
    • Groceries
    • Restaurants
  • Gifts & Donations
    • Charity
    • Gift
  • Health & Fitness
    • Dentist
    • Doctor
    • Eyecare
    • Gym
    • Health Insurance
    • Pharmacy
    • Sports
  • Home
    • Furnishings
    • Home Improvement
    • Home Insurance
    • Home Services
    • Home Supplies
    • Lawn & Garden
    • Mortgage & Rent
  • Income
    • Bonus
    • Interest Income
    • Paycheck
    • Reimbursement
    • Rental Income
  • Investments
    • Buy
    • Deposit
    • Dividend & Cap Gains
    • Sell
    • Withdrawal
  • Kids
    • Allowance
    • Baby Supplies
    • Babysitter & Daycare
    • Child Support
    • Kids Activities
    • Toys
  • Personal Care
    • Hair
    • Laundry
    • Spa & Massage
  • Pets
    • Pet Food & Supplies
    • Pet Grooming
    • Veterinary
  • Shopping
    • Books
    • Clothing
    • Electronics & Software
    • Hobbies
    • Sporting Goods
  • Taxes
    • Federal Tax
    • Local Tax
    • Property Tax
    • Sales Tax
    • State Tax
  • Transfer
    • Credit Card Payment
    • Transfer for Cash Spending
    • Mortgage Payment
  • Travel
    • Air Travel
    • Hotel
    • Rental Car & Taxi
    • Vacation
  • Uncategorized
    • Cash
    • Check

Merchant Category Codes

Merchant Category CodeMX CategoryMerchant Category
742VeterinaryVeterinary Services
763Food & DiningAgricultural Cooperative
780Lawn & GardenLandscaping Services
1520Home ImprovementGeneral Contractors
1711Home ImprovementHeating, Plumbing, A/C
1731Home ImprovementElectrical Contractors
1740Home ImprovementMasonry, Stonework, and Plaster
1750Home ImprovementCarpentry Contractors
1761Home ImprovementRoofing/Siding, Sheet Metal
1771Home ImprovementConcrete Work Contractors
1799Home ImprovementSpecial Trade Contractors
2741PrintingMiscellaneous Publishing and Printing
2791PrintingTypesetting, Plate Making, and Related Services
2842Home ServicesSpecialty Cleaning
3000Air TravelDefault Category For 3000-3301
3351Rental Car & TaxiDefault Category For 3351-3441
3501HotelDefault Category For 3501-3836
4011TravelRailroads
4111TravelCommuter Transport, Ferries
4112TravelPassenger Railways
4119DoctorAmbulance Services
4121Rental Car & TaxiTaxicabs/Limousines
4131TravelBus Lines
4214ShippingMotor Freight Carriers and Trucking
4215ShippingCourier Services
4225ShippingPublic Warehousing and Storage - Farm Products, Refrigerated Goods
4411TravelCruise Lines
4457TravelBoat Rentals and Leases
4468TravelMarinas, Service and Supplies
4511Air TravelAirlines, Air Carriers
4582TravelAirports, Flying Fields
4722TravelTravel Agencies, Tour Operators
4723TravelTUI Travel - Germany
4784TravelTolls/Bridge Fees
4789TravelTransportation Services (Not Elsewhere Classified)
4812Home PhoneTelecommunication Equipment and Telephone Sales
4814Home PhoneTelecommunication Services
4816InternetComputer Network Services
4821Bills & UtilitiesTelegraph Services
4829TransferWires, Money Orders
4899UtilitiesCable, Satellite, and Other Pay Television and Radio
4900UtilitiesUtilities
5013Service & PartsMotor Vehicle Supplies and New Parts
5021FurnishingsOffice and Commercial Furniture
5039Home ImprovementConstruction Materials (Not Elsewhere Classified)
5044Business ServicesPhotographic, Photocopy, Microfilm Equipment, and Supplies
5045Electronics & SoftwareComputers, Peripherals, and Software
5046ShoppingCommercial Equipment (Not Elsewhere Classified)
5047Health & FitnessMedical, Dental, Ophthalmic, and Hospital Equipment and Supplies
5051HomeMetal Service Centers
5065HomeElectrical Parts and Equipment
5072HomeHardware, Equipment, and Supplies
5074HomePlumbing, Heating Equipment, and Supplies
5085HomeIndustrial Supplies (Not Elsewhere Classified)
5094ShoppingPrecious Stones and Metals, Watches and Jewelry
5099ShoppingDurable Goods (Not Elsewhere Classified)
5111Office SuppliesStationary, Office Supplies, Printing and Writing Paper
5122PharmacyDrugs, Drug Proprietaries, and Druggist Sundries
5131ClothingPiece Goods, Notions, and Other Dry Goods
5137ClothingUniforms, Commercial Clothing
5139ClothingCommercial Footwear
5169HomeChemicals and Allied Products (Not Elsewhere Classified)
5172GasPetroleum and Petroleum Products
5192BooksBooks, Periodicals, and Newspapers
5193ShoppingFlorists Supplies, Nursery Stock, and Flowers
5198Home SuppliesPaints, Varnishes, and Supplies
5199HomeNondurable Goods (Not Elsewhere Classified)
5200HomeHome Supply Warehouse Stores
5211HomeLumber, Building Materials Stores
5231HomeGlass, Paint, and Wallpaper Stores
5251HomeHardware Stores
5261Lawn & GardenNurseries, Lawn and Garden Supply Stores
5271ShoppingMobile Home Dealers
5300ShoppingWholesale Clubs
5309ShoppingDuty Free Stores
5310ShoppingDiscount Stores
5311ShoppingDepartment Stores
5331ShoppingVariety Stores
5399ShoppingMiscellaneous General Merchandise
5411GroceriesGrocery Stores, Supermarkets
5422GroceriesFreezer and Locker Meat Provisioners
5441GroceriesCandy, Nut, and Confectionery Stores
5451GroceriesDairy Products Stores
5462GroceriesBakeries
5499GroceriesMiscellaneous Food Stores - Convenience Stores and Specialty Markets
5511Auto & TransportCar and Truck Dealers (New & Used) Sales, Service, Repairs Parts and Leasing
5521Auto & TransportCar and Truck Dealers (Used Only) Sales, Service, Repairs Parts and Leasing
5531Auto & TransportAuto and Home Supply Stores
5532Auto & TransportAutomotive Tire Stores
5533Auto & TransportAutomotive Parts and Accessories Stores
5541GasService Stations
5542GasAutomated Fuel Dispensers
5551Auto & TransportBoat Dealers
5561Auto & TransportMotorcycle Shops, Dealers
5571Auto & TransportMotorcycle Shops and Dealers
5592Auto & TransportMotor Homes Dealers
5598Sporting GoodsSnowmobile Dealers
5599Auto & TransportMiscellaneous Auto Dealers
5611ClothingMen's and Boy's Clothing and Accessories Stores
5621ClothingWomen's Ready-To-Wear Stores
5631ClothingWomen's Accessory and Specialty Shops
5641ClothingChildren's and Infant's Wear Stores
5651ClothingFamily Clothing Stores
5655ClothingSports and Riding Apparel Stores
5661ClothingShoe Stores
5681ClothingFurriers and Fur Shops
5691ClothingMen's, Women's Clothing Stores
5697ClothingTailors, Alterations
5698HairWig and Toupee Stores
5699ClothingMiscellaneous Apparel and Accessory Shops
5712FurnishingsFurniture, Home Furnishings, and Equipment Stores, Except Appliances
5713FurnishingsFloor Covering Stores
5714FurnishingsDrapery, Window Covering, and Upholstery Stores
5718FurnishingsFireplace, Fireplace Screens, and Accessories Stores
5719FurnishingsMiscellaneous Home Furnishing Specialty Stores
5722HomeHousehold Appliance Stores
5732Electronics & SoftwareElectronics Stores
5733MusicMusic Stores-Musical Instruments, Pianos, and Sheet Music
5734Electronics & SoftwareComputer Software Stores
5735MusicRecord Stores
5811RestaurantsCaterers
5812RestaurantsEating Places, Restaurants
5813Alcohol & BarsDrinking Places
5814Fast FoodFast Food Restaurants
5815EntertainmentDigital Goods Media - Books, Movies, Music
5816EntertainmentDigital Goods - Games
5817ShoppingDigital Goods - Applications (Excludes Games)
5818ShoppingDigital Goods - Large Digital Goods Merchant
5912PharmacyDrug Stores and Pharmacies
5921Alcohol & BarsPackage Stores-Beer, Wine, and Liquor
5931ClothingUsed Merchandise and Secondhand Stores
5932ShoppingAntique Shops
5933ShoppingPawn Shops
5935Service & PartsWrecking and Salvage Yards
5937ShoppingAntique Reproductions
5940Sporting GoodsBicycle Shops
5941Sporting GoodsSporting Goods Stores
5942BooksBook Stores
5943Office SuppliesStationery Stores, Office, and School Supply Stores
5944ShoppingJewelry Stores, Watches, Clocks, and Silverware Stores
5945ShoppingHobby, Toy, and Game Shops
5946ShoppingCamera and Photographic Supply Stores
5947ShoppingGift, Card, Novelty, and Souvenir Shops
5948ShoppingLuggage and Leather Goods Stores
5949ShoppingSewing, Needlework, Fabric, and Piece Goods Stores
5950ShoppingGlassware, Crystal Stores
5960FinancialDirect Marketing - Insurance Services
5962TravelDirect Marketing - Travel
5963ShoppingDoor-To-Door Sales
5964ShoppingDirect Marketing - Catalog Merchant
5965ShoppingDirect Marketing - Combination Catalog and Retail Merchant
5966ShoppingDirect Marketing - Outbound Tele
5967ShoppingDirect Marketing - Inbound Tele
5968ShoppingDirect Marketing - Subscription
5969ShoppingDirect Marketing - Other
5970ShoppingArtist's Supply and Craft Shops
5971ArtsArt Dealers and Galleries
5972ShoppingStamp and Coin Stores
5973ShoppingReligious Goods Stores
5975Health & FitnessHearing Aids Sales and Supplies
5976Health & FitnessOrthopedic Goods - Prosthetic Devices
5977Personal CareCosmetic Stores
5978Office SuppliesTypewriter Stores
5983GasFuel Dealers (Non Automotive)
5992ShoppingFlorists
5993ShoppingCigar Stores and Stands
5994BooksNews Dealers and Newsstands
5995Pet Food & SuppliesPet Shops, Pet Food, and Supplies
5996HomeSwimming Pools Sales
5997Personal CareElectric Razor Stores
5998ShoppingTent and Awning Shops
5999ShoppingMiscellaneous Specialty Retail
6010CashManual Cash Disburse
6011CashAutomated Cash Disburse
6012FinancialFinancial Institutions
6050UncategorizedQuasi Cash - Member Financial Institution
6051TransferNon-FI, Money Orders
6211InvestmentsSecurity Brokers/Dealers
6300FinancialInsurance Underwriting, Premiums
6399FinancialInsurance - Default
6513Mortgage & RentReal Estate Agents and Managers - Rentals
6536TransferMoneySend Intracountry
6540UncategorizedNon-Financial Institutions - Stored Value Card Purchase/Load
7011HotelHotels, Motels, and Resorts
7012VacationTimeshares
7032VacationSporting/Recreation Camps
7033VacationTrailer Parks, Campgrounds
7210LaundryLaundry, Cleaning Services
7211LaundryLaundries
7216LaundryDry Cleaners
7217Home ServicesCarpet/Upholstery Cleaning
7221ShoppingPhotographic Studios
7230HairBarber and Beauty Shops
7251ClothingShoe Repair/Hat Cleaning
7261UncategorizedFuneral Services, Crematories
7273EntertainmentDating/Escort Services
7276FinancialTax Preparation Services
7277DoctorCounseling Services
7278ShoppingBuying/Shopping Services
7296ClothingClothing Rental
7297Spa & MassageMassage Parlors
7298Spa & MassageHealth and Beauty Spas
7299Business ServicesMiscellaneous General Services
7311AdvertisingAdvertising Services
7321FinancialCredit Reporting Agencies
7333Business ServicesCommercial Photography, Art and Graphics
7338PrintingQuick Copy, Repro, and Blueprint
7339Business ServicesSecretarial Support Services
7342HomeExterminating Services
7349HomeCleaning and Maintenance
7361Business ServicesEmployment/Temp Agencies
7372Business ServicesComputer Programming
7375Business ServicesInformation Retrieval Services
7379Electronics & SoftwareComputer Repair
7392Business ServicesConsulting, Public Relations
7393Business ServicesDetective Agencies
7394Business ServicesEquipment Rental
7395Business ServicesPhoto Developing
7399Business ServicesMiscellaneous Business Services
7511GasTruck Stop
7512Rental Car & TaxiCar Rental Agencies
7513Rental Car & TaxiTruck/Utility Trailer Rentals
7519Rental Car & TaxiRecreational Vehicle Rentals
7523ParkingParking Lots, Garages
7531Service & PartsAuto Body Repair Shops
7534Service & PartsTire Retreading and Repair
7535Service & PartsAuto Paint Shops
7538Service & PartsAuto Service Shops
7542Service & PartsCar Washes
7549Service & PartsTowing Services
7622Electronics & SoftwareElectronics Repair Shops
7623HomeA/C, Refrigeration Repair
7629HomeSmall Appliance Repair
7631ShoppingWatch/Jewelry Repair
7641FurnishingsFurniture Repair, Refinishing
7692Service & PartsWelding Repair
7699Service & PartsMiscellaneous Repair Shops
7829Movies & DVDsPicture/Video Production
7800EntertainmentGovernment-Owned Lotteries
7801EntertainmentGovernment Licensed On-Line Casinos (On-Line Gambling)
7802EntertainmentGovernment-Licensed Horse/Dog Racing
7832Movies & DVDsMotion Picture Theaters
7841Movies & DVDsVideo Tape Rental Stores
7911EntertainmentDance Hall, Studios, Schools
7922EntertainmentTheatrical Ticket Agencies
7929EntertainmentBands, Orchestras
7932EntertainmentBilliard/Pool Establishments
7933EntertainmentBowling Alleys
7941EntertainmentSports Clubs/Fields
7991EntertainmentTourist Attractions and Exhibits
7992EntertainmentGolf Courses - Public
7993EntertainmentVideo Amusement Game Supplies
7994EntertainmentVideo Game Arcades
7995EntertainmentBetting/Casino Gambling
7996EntertainmentAmusement Parks/Carnivals
7997EntertainmentCountry Clubs
7998EntertainmentAquariums
7999EntertainmentMiscellaneous Recreation Services
8011DoctorDoctors
8021DentistDentists, Orthodontists
8031DoctorOsteopaths
8041DoctorChiropractors
8042EyecareOptometrists, Ophthalmologist
8043EyecareOpticians, Eyeglasses
8044EyecareOpticians, Eyeglasses
8049DoctorChiropodists, Podiatrists
8050Health & FitnessNursing/Personal Care
8062DoctorHospitals
8071DoctorMedical and Dental Labs
8099DoctorMedical Services
8111LegalLegal Services, Attorneys
8211EducationElementary, Secondary Schools
8220EducationColleges, Universities
8241EducationCorrespondence Schools
8244EducationBusiness/Secretarial Schools
8249EducationVocational/Trade Schools
8299EducationEducational Services
8351Babysitter & DaycareChild Care Services
8398Gifts & DonationsCharitable and Social Service Organizations - Fundraising
8641Gifts & DonationsCivic, Social, Fraternal Associations
8651Gifts & DonationsPolitical Organizations
8661Gifts & DonationsReligious Organizations
8675Gifts & DonationsAutomobile Associations
8699Gifts & DonationsMembership Organizations
8734Health & FitnessTesting Laboratories
8911Business ServicesArchitectural/Surveying Services
8931Business ServicesAccounting/Bookkeeping Services
8999Business ServicesProfessional Services
9211LegalCourt Costs, Including Alimony and Child Support - Courts of Law
9222LegalFines - Government Administrative Entities
9223LegalBail and Bond Payments
9311TaxesTax Payments - Government Agencies
9399UncategorizedGovernment Services (Not Elsewhere Classified)
9402ShippingPostal Services - Government Only
9405TaxesU.S. Federal Government Agencies or Departments
9950Business ServicesIntra-Company Purchases

Transaction Statuses

Transactions may have one of two statuses: PENDING or POSTED. How these statuses are reconciled depends on a number of factors.

  • All transaction data on MX systems represent what we get through our data feed, i.e., what institutions make available for aggregation. Many institutions simply do not provide data for pending transactions; transactions from those accounts will always have a status of POSTED.
  • For pending data we do get, it is sometimes possible for a single transaction to be updated from PENDING to POSTED and keep the same unique GUID. This is done through various matching methods performed automatically by MX.
  • If a single transaction can't be updated, the PENDING transaction will often be deleted and replaced with a new POSTED transaction (with a new GUID) when it is sent to us; this is the most common scenario when pending data is available.
  • In unusual circumstances, there may be separate PENDING and POSTED transactions on MX systems for up to 14 days. All PENDING transactions are deleted after 14 days as a failsafe.

Categorize Transactions

Categorize Transaction Fields

Field NameData TypeDefinition
amountDecimalThe monetary amount of the transaction.
categorized_byIntegerThe method used to determine the category assigned to the transaction.
categoryStringThe category of the transaction.
category_guidStringThe unique identifier for the category assigned to the transaction.
described_byIntegerThe method used to describe the transaction.
descriptionStringA human-readable version of the original_description field. This is provided by the MX Platform.
identifierStringThe unique partner-defined identifier for the transaction.
is_bill_payBooleanThis indicates whether the transaction represents a bill pay.
is_direct_depositBooleanThis indicates whether the transaction represents a direct deposit.
is_expenseBooleanThis indicates whether the transaction represents an expense.
is_feeBooleanThis indicates whether the transaction represents a fee.
is_incomeBooleanThis indicates whether the transaction represents income.
is_internationalBooleanIf the transaction is international as defined by the data provider, this field will be true. If the data provider determines it is not international then it will be false. It will be null if the data provider does not have this information.
is_overdraft_feeBooleanThis indicates whether the transaction represents an overdraft fee.
is_payroll_advanceBooleanThis indicates whether the transaction represents a payroll advance.
is_subscriptionBooleanThis indicates whether the transaction represents a payment for a subscription service.
memoStringThis field contains additional descriptive information about the transaction.
merchant_category_codeIntegerThe ISO 18245 category code for the transaction.
merchant_guidStringThe unique identifier for the merchant associated with this transaction. Defined by MX.
merchant_location_guidStringThe unique identifier for the merchant_location associated with this transaction. Defined by MX.
original_descriptionStringThe original description of the transaction as provided by our data feed. See description for more information.
typeStringThe type of transaction. This will be either CREDIT or DEBIT.

categorized_by Values

IntegerEnumDefinition
0CATEGORIZATION_SOURCE_AUTOCATThis is obsolete and will no longer assign categories.
1CATEGORIZATION_SOURCE_USERThe end user assigned a category manually.
2CATEGORIZATION_SOURCE_FEEDThe data feed assigned a category.
3CATEGORIZATION_SOURCE_LEVENSHTEINThis is obsolete and will no longer assign categories.
4CATEGORIZATION_SOURCE_PARSERA parser created by MX assigned the category based on patterns in the available data.
5CATEGORIZATION_SOURCE_TRAINERThis is obsolete and will no longer assign categories.
6CATEGORIZATION_SOURCE_SPHINXThis is obsolete and will no longer assign categories.
7CATEGORIZATION_SOURCE_NAIVE_BAYESThis is obsolete and will no longer assign categories.
8CATEGORIZATION_SOURCE_TERMINATIONAfter other methods failed to assign a category, it was set to 'UNCATEGORIZED'.
9CATEGORIZATION_SOURCE_KEYWORD_CATEGORIZERThe category was assigned based on keywords appearing in the original description (feed description).
10CATEGORIZATION_SOURCE_CATCHERThe category was assigned by a catcher based on the available data.
11CATEGORIZATION_SOURCE_HOPSCOTCHThis is obsolete and will no longer assign categories.
12CATEGORIZATION_SOURCE_USER_RULEA transaction rule created by the end user assigned the category.
13CATEGORIZATION_SOURCE_SYSTEM_RULEA transaction rule created by MX assigned the category.
14CATEGORIZATION_SOURCE_CLIENT_RULEA transaction rule created by the partner assigned the category.
15CATEGORIZATION_SOURCE_MERCHANT_CATEGORY_CODEThe category was assigned based on the merchant category code.
16CATEGORIZATION_SOURCE_FLOORThe transaction was assigned UNCATEGORIZED because it was uncategorizable as such, rather than because other methods failed; for example, the description simply contained withdrawal with no other information.
17CATEGORIZATION_SOURCE_QUICKVERSEThe category was assigned by a machine-learning model.
18CATEGORIZATION_SOURCE_MAPPINGThe category was assigned by mapping from our new extended category system to legacy categories. This new system has yet to be fully released to clients.
19CATEGORIZATION_SOURCE_TRANSFER_CATEGORIZERThe category was assigned by a categorizer designed specifically to look for transfers.

described_by Values

IntegerEnumDefinition
0DESCRIPTION_SOURCE_SCRUBBERThe description is the result of various pattern replacement and other cleansing mechanisms.
1DESCRIPTION_SOURCE_USERThe end user provided the description.
2DESCRIPTION_SOURCE_FEEDThe data feed provided the description.
3DESCRIPTION_SOURCE_LEVENSHTEINThis is obsolete and will no longer provide descriptions.
4DESCRIPTION_SOURCE_USER_RULEA transaction rule created by the end user provided the description.
5DESCRIPTION_SOURCE_TRAINERThis is obsolete and will no longer provide descriptions.
6DESCRIPTION_SOURCE_SYSTEM_RULEA transaction rule created by MX provided the description.
7DESCRIPTION_SOURCE_CLIENT_RULEA transaction rule created by the partner provided the description.
8DESCRIPTION_SOURCE_FLOORNo cleansed description could be provided as such, rather than because other methods failed.

Users

A user represents a person using Atrium via your application, be it a mobile app, web app, desktop app, etc.

info

The development environment limits you to 100 users.

Field NameData TypeDescription
guidStringA unique identifier, defined by MX.
identifierStringA unique, enforced identifier for the user, defined by you.
is_disabledBooleanThis indicates whether the user has been disabled.
metadataStringAdditional information you can store about this user. MX recommends using JSON-structured data.