atrium-ruby

Atrium - the Ruby gem for the MX API

The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access.

Installation

Build a gem

To build the Ruby code into a gem:

gem build atrium-ruby.gemspec

Then either install the gem locally:

gem install ./atrium-ruby-2.10.7.gem

Finally add this to the Gemfile:

gem 'atrium-ruby', '~> 2.10.7'

Install from Git

Add the following in the Gemfile:

gem 'atrium-ruby', :git => 'https://github.com/mxenabled/atrium-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Example Usage

Please see docs directory for additional endpoint examples

# Load the gemrequire'atrium-ruby'client=Atrium::AtriumClient.new("YOUR_API_KEY","YOUR_CLIENT_ID")account_guid="ACT-123"# String | The unique identifier for an `account`.user_guid="USR-123"# String | The unique identifier for a `user`.opts={from_date: "2016-09-20",# String | Filter transactions from this date.to_date: "2016-10-20"# String | Filter transactions to this date.page: 1,# Integer | Specify current page.records_per_page: 12# Integer | Specify records per page.}begin#List account transactionsresponse=client.accounts.list_account_transactions(account_guid,user_guid,,opts)presponserescueAtrium::ApiError=>eputs"Exception when calling AccountsApi->list_account_transactions: #{e}"end

Documentation for API Endpoints

Class	Method	HTTP request	Description
Atrium::AccountsApi	list_account_transactions	GET /users/{user_guid}/accounts/{account_guid}/transactions	List account transactions
Atrium::AccountsApi	list_user_accounts	GET /users/{user_guid}/accounts	List accounts for a user
Atrium::AccountsApi	read_account	GET /users/{user_guid}/accounts/{account_guid}	Read an account
Atrium::AccountsApi	read_account_by_member_guid	GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}	Read an account
Atrium::ConnectWidgetApi	get_connect_widget	POST /users/{user_guid}/connect_widget_url	Embedding in a website
Atrium::HoldingsApi	list_holdings	GET /users/{user_guid}/holdings	List holdings
Atrium::HoldingsApi	list_holdings_by_account	GET /users/{user_guid}/accounts/{account_guid}/holdings	List holdings by account
Atrium::HoldingsApi	list_holdings_by_member	GET /users/{user_guid}/members/{member_guid}/holdings	List holdings by member
Atrium::HoldingsApi	read_holding	GET /users/{user_guid}/holdings/{holding_guid}	Read holding
Atrium::IdentityApi	identify_member	POST /users/{user_guid}/members/{member_guid}/identify	Identify
Atrium::IdentityApi	list_account_owners	GET /users/{user_guid}/members/{member_guid}/account_owners	List member account owners
Atrium::InstitutionsApi	list_institutions	GET /institutions	List institutions
Atrium::InstitutionsApi	read_institution	GET /institutions/{institution_code}	Read institution
Atrium::InstitutionsApi	read_institution_credentials	GET /institutions/{institution_code}/credentials	Read institution credentials
Atrium::MembersApi	aggregate_member	POST /users/{user_guid}/members/{member_guid}/aggregate	Aggregate member
Atrium::MembersApi	aggregate_member_balances	POST /users/{user_guid}/members/{member_guid}/balance	Aggregate member account balances
Atrium::MembersApi	create_member	POST /users/{user_guid}/members	Create member
Atrium::MembersApi	delete_member	DELETE /users/{user_guid}/members/{member_guid}	Delete member
Atrium::MembersApi	extend_history	POST /users/{user_guid}/members/{member_guid}/extend_history	Extend history
Atrium::MembersApi	list_member_accounts	GET /users/{user_guid}/members/{member_guid}/accounts	List member accounts
Atrium::MembersApi	list_member_credentials	GET /users/{user_guid}/members/{member_guid}/credentials	List member credentials
Atrium::MembersApi	list_member_mfa_challenges	GET /users/{user_guid}/members/{member_guid}/challenges	List member MFA challenges
Atrium::MembersApi	list_member_transactions	GET /users/{user_guid}/members/{member_guid}/transactions	List member transactions
Atrium::MembersApi	list_members	GET /users/{user_guid}/members	List members
Atrium::MembersApi	read_member	GET /users/{user_guid}/members/{member_guid}	Read member
Atrium::MembersApi	read_member_status	GET /users/{user_guid}/members/{member_guid}/status	Read member connection status
Atrium::MembersApi	read_o_auth_window_uri	GET /users/{user_guid}/members/{member_guid}/oauth_window_uri	Read OAuth Window URI
Atrium::MembersApi	resume_member	PUT /users/{user_guid}/members/{member_guid}/resume	Resume aggregation from MFA
Atrium::MembersApi	update_member	PUT /users/{user_guid}/members/{member_guid}	Update member
Atrium::MerchantsApi	list_merchant_locations	GET /merchants/{merchant_guid}/merchant_locations	List merchant locations
Atrium::MerchantsApi	list_merchants	GET /merchants	List merchants
Atrium::MerchantsApi	read_merchant	GET /merchants/{merchant_guid}	Read merchant
Atrium::MerchantsApi	read_merchant_location	GET /merchants/{merchant_guid}/merchant_locations/{merchant_location_guid}	Read merchant location
Atrium::StatementsApi	download_statement_pdf	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf	Download statement PDF
Atrium::StatementsApi	fetch_statements	POST /users/{user_guid}/members/{member_guid}/fetch_statements	Fetch statements
Atrium::StatementsApi	list_member_statements	GET /users/{user_guid}/members/{member_guid}/statements	List member statements
Atrium::StatementsApi	read_member_statement	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}	Read statement JSON
Atrium::TransactionsApi	cleanse_and_categorize_transactions	POST /transactions/cleanse_and_categorize	Categorize transactions
Atrium::TransactionsApi	list_user_transactions	GET /users/{user_guid}/transactions	List transactions for a user
Atrium::TransactionsApi	read_transaction	GET /users/{user_guid}/transactions/{transaction_guid}	Read a transaction
Atrium::UsersApi	create_user	POST /users	Create user
Atrium::UsersApi	delete_user	DELETE /users/{user_guid}	Delete user
Atrium::UsersApi	list_users	GET /users	List users
Atrium::UsersApi	read_user	GET /users/{user_guid}	Read user
Atrium::UsersApi	update_user	PUT /users/{user_guid}	Update user
Atrium::VerificationApi	list_account_numbers	GET /users/{user_guid}/members/{member_guid}/account_numbers	Read account numbers
Atrium::VerificationApi	list_account_numbers_by_account	GET /users/{user_guid}/accounts/{account_guid}/account_numbers	Read account numbers by account GUID
Atrium::VerificationApi	verify_member	POST /users/{user_guid}/members/{member_guid}/verify	Verify

Documentation for Models

• Atrium::Account
• Atrium::AccountNumber
• Atrium::AccountNumbersResponseBody
• Atrium::AccountOwner
• Atrium::AccountOwnersResponseBody
• Atrium::AccountResponseBody
• Atrium::AccountsResponseBody
• Atrium::Challenge
• Atrium::ChallengeImageOption
• Atrium::ChallengeOption
• Atrium::ChallengesResponseBody
• Atrium::ConnectWidget
• Atrium::ConnectWidgetRequestBody
• Atrium::ConnectWidgetResponseBody
• Atrium::CredentialOption
• Atrium::CredentialRequest
• Atrium::CredentialResponse
• Atrium::CredentialsResponseBody
• Atrium::Holding
• Atrium::HoldingResponseBody
• Atrium::HoldingsResponseBody
• Atrium::Institution
• Atrium::InstitutionResponseBody
• Atrium::InstitutionsResponseBody
• Atrium::Member
• Atrium::MemberConnectionStatus
• Atrium::MemberConnectionStatusResponseBody
• Atrium::MemberCreateRequest
• Atrium::MemberCreateRequestBody
• Atrium::MemberResponseBody
• Atrium::MemberResumeRequest
• Atrium::MemberResumeRequestBody
• Atrium::MemberUpdateRequest
• Atrium::MemberUpdateRequestBody
• Atrium::MembersResponseBody
• Atrium::Merchant
• Atrium::MerchantLocation
• Atrium::MerchantLocationResponseBody
• Atrium::MerchantLocationsResponseBody
• Atrium::MerchantResponseBody
• Atrium::MerchantsResponseBody
• Atrium::Pagination
• Atrium::Statement
• Atrium::StatementResponseBody
• Atrium::StatementsResponseBody
• Atrium::Transaction
• Atrium::TransactionCleanseAndCategorizeRequest
• Atrium::TransactionCleanseAndCategorizeResponse
• Atrium::TransactionResponseBody
• Atrium::TransactionsCleanseAndCategorizeRequestBody
• Atrium::TransactionsCleanseAndCategorizeResponseBody
• Atrium::TransactionsResponseBody
• Atrium::User
• Atrium::UserCreateRequestBody
• Atrium::UserResponseBody
• Atrium::UserUpdateRequestBody
• Atrium::UsersResponseBody