Module: Atrium

Defined in:
lib/atrium-ruby/version.rb,
lib/atrium-ruby.rb,
lib/atrium-ruby/api_error.rb,
lib/atrium-ruby/api_client.rb,
lib/atrium-ruby/models/user.rb,
lib/atrium-ruby/api/users_api.rb,
lib/atrium-ruby/configuration.rb,
lib/atrium-ruby/models/member.rb,
lib/atrium-ruby/models/account.rb,
lib/atrium-ruby/models/holding.rb,
lib/atrium-ruby/api/members_api.rb,
lib/atrium-ruby/models/merchant.rb,
lib/atrium-ruby/api/accounts_api.rb,
lib/atrium-ruby/api/holdings_api.rb,
lib/atrium-ruby/api/identity_api.rb,
lib/atrium-ruby/models/challenge.rb,
lib/atrium-ruby/models/statement.rb,
lib/atrium-ruby/api/atrium_client.rb,
lib/atrium-ruby/api/merchants_api.rb,
lib/atrium-ruby/models/pagination.rb,
lib/atrium-ruby/api/statements_api.rb,
lib/atrium-ruby/models/institution.rb,
lib/atrium-ruby/models/transaction.rb,
lib/atrium-ruby/api/institutions_api.rb,
lib/atrium-ruby/api/transactions_api.rb,
lib/atrium-ruby/api/verification_api.rb,
lib/atrium-ruby/models/account_owner.rb,
lib/atrium-ruby/models/account_number.rb,
lib/atrium-ruby/models/connect_widget.rb,
lib/atrium-ruby/api/connect_widget_api.rb,
lib/atrium-ruby/models/challenge_option.rb,
lib/atrium-ruby/models/credential_option.rb,
lib/atrium-ruby/models/merchant_location.rb,
lib/atrium-ruby/models/credential_request.rb,
lib/atrium-ruby/models/user_response_body.rb,
lib/atrium-ruby/models/credential_response.rb,
lib/atrium-ruby/models/users_response_body.rb,
lib/atrium-ruby/models/member_response_body.rb,
lib/atrium-ruby/models/account_response_body.rb,
lib/atrium-ruby/models/holding_response_body.rb,
lib/atrium-ruby/models/member_create_request.rb,
lib/atrium-ruby/models/member_resume_request.rb,
lib/atrium-ruby/models/member_update_request.rb,
lib/atrium-ruby/models/members_response_body.rb,
lib/atrium-ruby/models/accounts_response_body.rb,
lib/atrium-ruby/models/challenge_image_option.rb,
lib/atrium-ruby/models/holdings_response_body.rb,
lib/atrium-ruby/models/merchant_response_body.rb,
lib/atrium-ruby/models/merchants_response_body.rb,
lib/atrium-ruby/models/statement_response_body.rb,
lib/atrium-ruby/models/challenges_response_body.rb,
lib/atrium-ruby/models/member_connection_status.rb,
lib/atrium-ruby/models/statements_response_body.rb,
lib/atrium-ruby/models/user_create_request_body.rb,
lib/atrium-ruby/models/user_update_request_body.rb,
lib/atrium-ruby/models/credentials_response_body.rb,
lib/atrium-ruby/models/institution_response_body.rb,
lib/atrium-ruby/models/transaction_response_body.rb,
lib/atrium-ruby/models/institutions_response_body.rb,
lib/atrium-ruby/models/member_create_request_body.rb,
lib/atrium-ruby/models/member_resume_request_body.rb,
lib/atrium-ruby/models/member_update_request_body.rb,
lib/atrium-ruby/models/transactions_response_body.rb,
lib/atrium-ruby/models/connect_widget_request_body.rb,
lib/atrium-ruby/models/account_owners_response_body.rb,
lib/atrium-ruby/models/connect_widget_response_body.rb,
lib/atrium-ruby/models/account_numbers_response_body.rb,
lib/atrium-ruby/models/merchant_location_response_body.rb,
lib/atrium-ruby/models/merchant_locations_response_body.rb,
lib/atrium-ruby/models/member_connection_status_response_body.rb,
lib/atrium-ruby/models/transaction_cleanse_and_categorize_request.rb,
lib/atrium-ruby/models/transaction_cleanse_and_categorize_response.rb,
lib/atrium-ruby/models/transactions_cleanse_and_categorize_request_body.rb,
lib/atrium-ruby/models/transactions_cleanse_and_categorize_response_body.rb

Overview

#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.

Defined Under Namespace

Classes: Account, AccountNumber, AccountNumbersResponseBody, AccountOwner, AccountOwnersResponseBody, AccountResponseBody, AccountsApi, AccountsResponseBody, ApiClient, ApiError, AtriumClient, Challenge, ChallengeImageOption, ChallengeOption, ChallengesResponseBody, Configuration, ConnectWidget, ConnectWidgetApi, ConnectWidgetRequestBody, ConnectWidgetResponseBody, CredentialOption, CredentialRequest, CredentialResponse, CredentialsResponseBody, Holding, HoldingResponseBody, HoldingsApi, HoldingsResponseBody, IdentityApi, Institution, InstitutionResponseBody, InstitutionsApi, InstitutionsResponseBody, Member, MemberConnectionStatus, MemberConnectionStatusResponseBody, MemberCreateRequest, MemberCreateRequestBody, MemberResponseBody, MemberResumeRequest, MemberResumeRequestBody, MemberUpdateRequest, MemberUpdateRequestBody, MembersApi, MembersResponseBody, Merchant, MerchantLocation, MerchantLocationResponseBody, MerchantLocationsResponseBody, MerchantResponseBody, MerchantsApi, MerchantsResponseBody, Pagination, Statement, StatementResponseBody, StatementsApi, StatementsResponseBody, Transaction, TransactionCleanseAndCategorizeRequest, TransactionCleanseAndCategorizeResponse, TransactionResponseBody, TransactionsApi, TransactionsCleanseAndCategorizeRequestBody, TransactionsCleanseAndCategorizeResponseBody, TransactionsResponseBody, User, UserCreateRequestBody, UserResponseBody, UserUpdateRequestBody, UsersApi, UsersResponseBody, VerificationApi

Constant Summary collapse

VERSION = 
'2.10.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Atrium.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



96
97
98
99
100
101
102
 
# File 'lib/atrium-ruby.rb', line 96

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end