| Method | HTTP request | Description |
|---|---|---|
| aggregate_member | POST /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member |
| aggregate_member_balances | POST /users/{user_guid}/members/{member_guid}/balance | Aggregate member account balances |
| create_member | POST /users/{user_guid}/members | Create member |
| delete_member | DELETE /users/{user_guid}/members/{member_guid} | Delete member |
| extend_history | POST /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
| list_member_accounts | GET /users/{user_guid}/members/{member_guid}/accounts | List member accounts |
| list_member_credentials | GET /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
| list_member_mfa_challenges | GET /users/{user_guid}/members/{member_guid}/challenges | List member MFA challenges |
| list_member_transactions | GET /users/{user_guid}/members/{member_guid}/transactions | List member transactions |
| list_members | GET /users/{user_guid}/members | List members |
| read_member | GET /users/{user_guid}/members/{member_guid} | Read member |
| read_member_status | GET /users/{user_guid}/members/{member_guid}/status | Read member connection status |
| read_o_auth_window_uri | GET /users/{user_guid}/members/{member_guid}/oauth_window_uri | Read OAuth Window URI |
| resume_member | PUT /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA |
| update_member | PUT /users/{user_guid}/members/{member_guid} | Update member |
MemberResponseBody aggregate_member(member_guid, user_guid, )
Aggregate member
Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Aggregate member
response = client.members.aggregate_member(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->aggregate_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
MemberResponseBody aggregate_member_balances(member_guid, user_guid, )
Aggregate member account balances
This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Aggregate member account balances
response = client.members.aggregate_member_balances(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->aggregate_member_balances: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
MemberResponseBody create_member(user_guid, body)
Create member
This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.
When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.
If successful, Atrium will respond with the newly-created member object.
Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
user_guid = "USR-123" # String | The unique identifier for a `user`.
body = Atrium::MemberCreateRequestBody.new # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
begin
#Create member
response = client.members.create_member(user_guid, body)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->create_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| user_guid | String | The unique identifier for a `user`. | |
| body | MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code) |
delete_member(member_guid, user_guid, )
Delete member
Accessing this endpoint will permanently delete a member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Delete member
client.members.delete_member(member_guid, user_guid, )
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->delete_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
nil (empty response body)
MemberResponseBody extend_history(member_guid, user_guid, )
Extend history
The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Extend history
response = client.members.extend_history(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->extend_history: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
AccountsResponseBody list_member_accounts(member_guid, user_guid, , opts)
List member accounts
This endpoint returns an array with information about every account associated with a particular member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
opts = {
page: 1, # Integer | Specify current page.
records_per_page: 12 # Integer | Specify records per page.
}
begin
#List member accounts
response = client.members.list_member_accounts(member_guid, user_guid, , opts)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->list_member_accounts: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. | |
| page | Integer | Specify current page. | [optional] |
| records_per_page | Integer | Specify records per page. | [optional] |
CredentialsResponseBody list_member_credentials(member_guid, user_guid, )
List member credentials
This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#List member credentials
response = client.members.list_member_credentials(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->list_member_credentials: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid, )
List member MFA challenges
Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.
If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.
If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#List member MFA challenges
response = client.members.list_member_mfa_challenges(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->list_member_mfa_challenges: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
TransactionsResponseBody list_member_transactions(member_guid, user_guid, , opts)
List member transactions
Use this endpoint to get all transactions from all accounts associated with a specific member.
This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, from_date will default to 90 days prior to the request and to_date will default to 5 days from the time of the request.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
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 member transactions
response = client.members.list_member_transactions(member_guid, user_guid, , opts)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->list_member_transactions: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. | |
| from_date | String | Filter transactions from this date. | [optional] |
| to_date | String | Filter transactions to this date. | [optional] |
| page | Integer | Specify current page. | [optional] |
| records_per_page | Integer | Specify records per page. | [optional] |
MembersResponseBody list_members(user_guid, , opts)
List members
This endpoint returns an array which contains information on every member associated with a specific user.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
user_guid = "USR-123" # String | The unique identifier for a `user`.
opts = {
page: 1, # Integer | Specify current page.
records_per_page: 12 # Integer | Specify records per page.
}
begin
#List members
response = client.members.list_members(user_guid, , opts)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->list_members: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| user_guid | String | The unique identifier for a `user`. | |
| page | Integer | Specify current page. | [optional] |
| records_per_page | Integer | Specify records per page. | [optional] |
MemberResponseBody read_member(member_guid, user_guid, )
Read member
Use this endpoint to read the attributes of a specific member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Read member
response = client.members.read_member(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->read_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
MemberConnectionStatusResponseBody read_member_status(member_guid, user_guid, )
Read member connection status
This endpoint provides the status of the member's most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member.
MX has introduced new, more detailed information on the current status of a member's connection to a financial institution and the state of its aggregation: the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
begin
#Read member connection status
response = client.members.read_member_status(member_guid, user_guid, )
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->read_member_status: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. |
MemberConnectionStatusResponseBody
MemberResponseBody read_o_auth_window_uri(member_guid, user_guid, , opts)
Read OAuth Window URI
This endpoint will generate an oauth_window_uri for the specified member.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
opts = {
referral_source: "BROWSER", # String | Should be either BROWSER or APP depending on the implementation.
ui_message_webview_url_scheme: "ui_message_webview_url_scheme_example" # String | A scheme for routing the user back to the application state they were previously in.
}
begin
#Read OAuth Window URI
response = client.members.read_o_auth_window_uri(member_guid, user_guid, , opts)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->read_o_auth_window_uri: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. | |
| referral_source | String | Should be either BROWSER or APP depending on the implementation. | [optional] |
| ui_message_webview_url_scheme | String | A scheme for routing the user back to the application state they were previously in. | [optional] |
MemberResponseBody resume_member(member_guid, user_guid, body)
Resume aggregation from MFA
This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
body = Atrium::MemberResumeRequestBody.new # MemberResumeRequestBody | Member object with MFA challenge answers
begin
#Resume aggregation from MFA
response = client.members.resume_member(member_guid, user_guid, body)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->resume_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. | |
| body | MemberResumeRequestBody | Member object with MFA challenge answers |
MemberResponseBody update_member(member_guid, user_guid, , opts)
Update member
Use this endpoint to update a member's attributes. Only the credentials, identifier, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.
# load the gem
require 'atrium-ruby'
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
member_guid = "MBR-123" # String | The unique identifier for a `member`.
user_guid = "USR-123" # String | The unique identifier for a `user`.
opts = {
body: Atrium::MemberUpdateRequestBody.new # MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata)
}
begin
#Update member
response = client.members.update_member(member_guid, user_guid, , opts)
p response
rescue Atrium::ApiError => e
puts "Exception when calling MembersApi->update_member: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| member_guid | String | The unique identifier for a `member`. | |
| user_guid | String | The unique identifier for a `user`. | |
| body | MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata) | [optional] |