NAV Navbar
cURL C# Go Java Node PHP Python Ruby
  • Introduction
  • Getting started
  • Things you need to know
  • Users
  • Institutions
  • Members
  • Accounts
  • Transactions
  • Merchants
  • Holdings
  • Extended transaction history
  • Identity
  • Statements
  • Verification
  • MX Connect widget
  • Webhooks
  • Changelog
  • MX Atrium API
    Technical Reference

    Introduction

    Production environment

    https://atrium.mx.com/
    

    Development environment

    https://vestibule.mx.com/
    

    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 and access to the top 15 institutions. Contact MX to purchase production access.

    Getting started

    A detailed guide to getting started with Atrium is available here. It covers some of the most common questions and scenarios you'll run into when getting up and running, offers step-buy-step guides for testing, provides downloadable resources, and offers workflow examples and explanations.

    Wrapper libraries

    To help you get started with Atrium, we've provided wrapper libraries in several languages. Visit the appropriate GitHub page below.

    C#

    Go

    Java

    Node

    PHP

    Python

    Ruby

    Things you need to know

    Standards and conventions

    Thing Description
    API architecture Atrium is designed around the REST architecture and uses predictable, resource-oriented URLs. Requests are made with HTTP methods and HTTP response codes indicate the success or failure of those requests.
    IP address whitelisting All IP addresses which will make calls to Atrium's production environment must be whitelisted first. A 403 Forbidden error will be returned for non-whitelisted addresses. The vestibule environment does not require any whitelisting.

    You can whitelist IP addresses on your account profile.
    Security Atrium API requests must be HTTPS with encryption TLSv1.2 or higher or else they will fail.
    Authentication All requests to Atrium are authenticated with tokens: MX-API-Key and MX-Client-ID. The production and development environments require separate tokens. Development tokens are granted automatically during the signup process, and are available in your profile page. Contact MX for information on moving to production. Because these tokens grant access to all of your data, you must keep them secret and keep them safe. Do not share them in public areas, use them in client-side code, or otherwise use them in a way that may compromise their security. In some instances, requests that require authentication will return 404 Not Found, instead of 401 Unauthorized. This is to prevent leaking private information.
    Versioning We always try to make API changes backwards-compatible. However, when we make breaking changes to Atrium, we'll increment the version number. The current version is v1. Versions are specified in a request's Accept header. All requests will access the current version unless a different version is specified with the request, so it's best to always specify the API version. The current Accept header is application/vnd.mx.atrium.v1+json.
    Data formats By default, JSON structured data is returned in responses, including some errors.
    Character encoding Requests and responses to Atrium must use characters encoded with the UTF-8 standard.
    Dates and times Dates and times follow ISO 8601 format. E.g., 2015-04-13T12:01:23-06:00.
    Percentages Percentages are in decimal format without the percentage sign. E.g., 2.99% is written 2.99.
    Numbers Number limits are described by their precision and scale. Precision refers to the total number of digits. Scale refers to the number of digits to the right of the decimal. E.g., 538.46's precision,scale is 5,2.
    Pagination All endpoints which return lists are paginated with defaults of page=1 and records_per_page=25. You may override these defaults with URL query parameters. The records_per_page parameter supports any integer within the range 10-1000.
    Limits The development environment limits developers to 100 users and access to the top 15 institutions.

    No user may have more than 25 members, regardless of the environment.

    The default minimum time between aggregation events is 10,800 seconds (3 hours), though this limit can vary by institution. Aggregating within this limit will not return an error, however; the response will simply contain the current state of the member, including the latest connection_status. Certain codepaths may also bypass this limit — for instance, updating a member's credentials.

    The MX Bank test institution has no aggregation limits.

    Resource structure

    Atrium has five broad groups of resources, each with their own attributes and endpoints:

    Resource Description
    user A user represents a person using Atrium via your application, be it a mobile app, web app, desktop app, etc.
    institution An institution represents a financial institution like Chase or Wells Fargo. It's important to point out that many real-world financial institutions will actually have several different institution objects within Atrium. This is because, for example, the mortgage division of Wells Fargo might use a separate system than its everyday banking division, which is different from its credit card division, etc.
    member A member represents the relationship between a user and an institution, and creating one is how you connect a user to an institution. A user may have one member each for their bank, their mortgage broker, their credit card provider, etc. Aggregation takes place via members.
    account An account represents a financial account held by a financial institution, e.g., a user's checking or savings account. Because a user's relationship with an institution may involve more than one account, a member may have more than one account associated with it. For instance, a user may have both a checking and savings account with Chase. In that case, the user would have a member that represents their connection with the Chase institution. That member would have two accounts, a checking account and a savings account.
    transaction 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.

    Identifiers and metadata

    Example metadata request

    $ curl -i -X POST 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "user": {
              "metadata": "{\"username\":\"steven\"}"
            }
          }'
    

    Example identifier request

    $ curl -X POST 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "user": {
              "identifier": "5935d8ef-20c0-4bc1-997c-b2cccf4d601d"
            }
          }'
    

    Example of an identifier conflict response

    Status: 409 Conflict
    
    {
      "error": {
        "message": "A user already exists with identifier: '5935d8ef-20c0-4bc1-997c-b2cccf4d601d'."
      }
    }
    

    Atrium gives you two special — but optional — fields which you can define for any resource created with the API: identifier and metadata. These fields make it easier to customize and integrate Atrium with your systems.

    For instance, you may need to make certain that some resources are created only once. In these situations, you can give an unique identifier to resources created with Atrium. Atrium will return a 409 Conflict error if a resource is created with an identifier that already exists.

    You might also use the metadata field to store custom data about a resource. For example, you could store a user's username for your system, their sign-up date, the date and time of their last logon in your system, or all of these.

    Field Description
    identifier A unique, enforced identifier for a user or member, defined by you. An identifier may contain letters, numbers, dashes, and underscores — but they should not be longer than 200 characters. MX recommends using GUIDs. Atrium will return a 409 Conflict error if a resource is created with an identifier that already exists.
    metadata This field that can be used to store additional information about a particular user or member. Any UTF-8 string can be stored, but MX recommends using structured key-value data such as JSON.

    Background Aggregation

    MX automatically aggregates certain members in the background every 24 hours. Specifically, we aggregate all members whose connection_status is either CONNECTED, CREATED, IMPEDED, or UPDATED — unless the member has been disabled. You may aggregate a member in the foreground via the aggregate member endpoint to get the most up-to-date information on accounts and transactions.

    Caching

    Certain Atrium resources are subject to change at any time; for instance, institutions and institution credentials. For this reason, MX discourages partners from caching lists of resources. If caching is necessary, MX recommends refreshing a cached list at least daily.

    Errors

    Example error message

    {
      "error": {
        "message": "Unrecognized institution.",
      }
    }
    

    Atrium uses conventional HTTP response codes to indicate the success or failure of a request, with supplementary error messaging as needed within response bodies.

    Status codes

    Status Explanation
    2xx Success
    200 OK Everything worked as expected with content returned.
    202 Accepted Everything worked and MX's system is processing the request.
    204 No Content Everything worked as expected without content returned.
    4xx Requester error
    400 Bad Request Often, this means a required parameter was missing.
    401 Unauthorized Invalid MX-API-Key or MX-Client-ID provided.
    403 Forbidden The request was made from a non-whitelisted address.
    404 Not Found Invalid item/id/URL requested.
    405 Method Not Allowed A constraint on the requested endpoint wasn't met.
    406 Not Acceptable The request didn't specify a valid API version.
    409 Conflict An object with the given attributes already exists.
    422 Unprocessable Entity The data provided cannot be processed.
    5xx Responder error — which are rare
    500, 502, 504 Server errors Something went wrong with MX's servers.
    503 Service Unavailable The MX Platform is being updated.

    Users

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

    Endpoint Method Description
    /users POST Creates a new user.
    /users GET Returns a list of all your users in Atrium.
    /users/{user_guid} GET Returns a user's attributes.
    /users/{user_guid} PUT Updates a user's attributes.
    /users/{user_guid} DELETE Permanently deletes a user.

    Create user

    Endpoint: POST /users

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "user": {
              "identifier": "unique_id",
              "metadata": "{\"first_name\": \"Steven\"}"
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateUserExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var body = new UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
                try
                {
                    // Create user
                    UserResponseBody response = client.users.CreateUser(body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.CreateUser: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      body := atrium.UserCreateRequestBody{} // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
      response, _, err := client.Users.CreateUser(ctx, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            UserCreateRequestBody body = new UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
            try {
                UserResponseBody response = client.users.createUser(body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#createUser");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var body = new atrium.UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    var response = client.users.createUser(body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $body = new \atrium\model\UserCreateRequestBody(); // \atrium\model\UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    try {
        $result = $client->users->createUser($body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->createUser: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    body = atrium.UserCreateRequestBody() # UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    try:
        # Create user
        response = client.users.create_user(body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->create_user: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    body = Atrium::UserCreateRequestBody.new # UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    begin
      #Create user
      response = client.users.create_user(body)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->create_user: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "user": {
        "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
        "identifier": "unique_id",
        "is_disabled": false,
        "metadata": "{\"first_name\": \"Steven\"}"
      }
    }
    
    class UserResponseBody {
      User:
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    {
      User:
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    class UserResponseBody {
      user:
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    UserResponseBody {
      user:
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    atrium/model/UserResponseBody Object (
      [user] =>
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )
    )
    
    {
      'user':
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    #<MX::UserResponseBody
      @user=
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >
    >
    

    Call this endpoint to create a new user. Atrium will respond with the newly-created user object if successful.

    This endpoint accepts several parameters: identifier, metadata, and is_disabled. The identifier and metadata fields are discussed above.

    Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill.

    Parameters

    Field Data Type Description Required?
    identifier String A unique, enforced identifier for the user, defined by you. No
    is_disabled Boolean True if you want the user disabled, false otherwise. No
    metadata String Additional information you can store about this user. MX recommends using JSON-structured data. No

    Read user

    Endpoint: GET /users/{user_guid}

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadUserExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read user
                    UserResponseBody response = client.users.ReadUser(userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.ReadUser: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Users.ReadUser(ctx, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                UserResponseBody response = client.users.readUser(userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#readUser");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.users.readUser(userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->users->readUser($user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->readUser: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read user
        response = client.users.read_user(user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->read_user: %s\n" % e)
    
    # 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`.
    
    begin
      #Read user
      response = client.users.read_user(user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->read_user: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "user": {
        "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
        "identifier": "unique_id",
        "is_disabled": false,
        "metadata": "{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}"
      }
    }
    
    class UserResponseBody {
      User:
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    {
      User:
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    class UserResponseBody {
      user:
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    UserResponseBody {
      user:
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    atrium/model/UserResponseBody Object (
      [user] =>
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )
    )
    
    {
      'user':
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    #<MX::UserResponseBody
      @user=
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >
    >
    

    Use this endpoint to read the attributes of a specific user. The following attributes will be included in user object:

    Field Data Type Description
    guid String A unique identifier, defined by MX.
    identifier String A unique, enforced identifier for the user, defined by you.
    is_disabled Boolean True if you want the user disabled, false otherwise.
    metadata String Additional information you can store about this user. MX recommends using JSON-structured data.

    Update user

    Endpoint: PUT /users/{user_guid}

    Example request

    $ curl -i -X PUT 'https://vestibule.mx.com/users/{user_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "user": {
              "metadata": "{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}"
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class UpdateUserExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new UserUpdateRequestBody(); // UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata) (optional)
    
                try
                {
                    // Update user
                    UserResponseBody response = client.users.UpdateUser(userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.UpdateUser: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.UpdateUserOpts{
        Body: optional.NewInterface(atrium.UserUpdateRequestBody{}), // UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata)
      }
    
      response, _, err := client.Users.UpdateUser(ctx, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            UserUpdateRequestBody body = new UserUpdateRequestBody(); // UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata)
    
            try {
                UserResponseBody response = client.users.updateUser(userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#updateUser");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.UserUpdateRequestBody(); // UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata) (optional)
    
    var response = client.users.updateUser(userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\UserUpdateRequestBody(); // \atrium\model\UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata)
    
    try {
        $result = $client->users->updateUser($user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->updateUser: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.UserUpdateRequestBody() # UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata) (optional)
    
    try:
        # Update user
        response = client.users.update_user(user_guid, body=body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->update_user: %s\n" % e)
    
    # 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 = {
      body: Atrium::UserUpdateRequestBody.new # UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata)
    }
    
    begin
      #Update user
      response = client.users.update_user(user_guid, opts)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->update_user: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "user": {
        "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
        "identifier": "unique_id",
        "is_disabled": false,
        "metadata": "{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}"
      }
    }
    
    class UserResponseBody {
      User:
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    {
      User:
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    class UserResponseBody {
      user:
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    UserResponseBody {
      user:
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    atrium/model/UserResponseBody Object (
      [user] =>
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )
    )
    
    {
      'user':
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    #<MX::UserResponseBody
      @user=
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >
    >
    

    Use this endpoint to update the attributes of a specific user. Atrium will respond with the updated user object.

    Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill.

    To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.

    Parameters

    Field Data Type Description Required?
    identifier String A unique, enforced identifier for the user, defined by you. No
    is_disabled Boolean True if you want the user disabled, false otherwise. No
    metadata String Additional information you can store about this user. MX recommends using JSON-structured data. No

    Delete user

    Endpoint: DELETE /users/{user_guid}

    Example request

    $ curl -i -X DELETE 'https://vestibule.mx.com/users/{user_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class DeleteUserExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Delete user
                    client.users.DeleteUser(userGuid);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.DeleteUser: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Users.DeleteUser(ctx, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                client.users.deleteUser(userGuid);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#deleteUser");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.users.deleteUser(userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $client->users->deleteUser($user_guid);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->deleteUser: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Delete user
        client.users.delete_user(user_guid)
    except ApiException as e:
        print("Exception when calling UsersApi->delete_user: %s\n" % e)
    
    # 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`.
    
    begin
      #Delete user
      client.users.delete_user(user_guid)
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->delete_user: #{e}"
    end
    

    Example response

    Status: 204 No Content
    

    Calling this endpoint will permanently delete a user from Atrium. If successful, the API will respond with Status: 204 No Content.

    List users

    Endpoint: GET /users

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListUsersExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List users
                    UsersResponseBody response = client.users.ListUsers(page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.ListUsers: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      opts := &atrium.ListUsersOpts{
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Users.ListUsers(ctx, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                UsersResponseBody response = client.users.listUsers(page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#listUsers");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.users.listUsers(page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->users->listUsers($page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->listUsers: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List users
        response = client.users.list_users(page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->list_users: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    opts = {
      page: 1, # Integer | Specify current page.
      records_per_page: 12, # Integer | Specify records per page.
    }
    
    begin
      #List users
      response = client.users.list_users(opts)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->list_users: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "users": [
        {
          "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
          "identifier": "unique_id",
          "is_disabled": false,
          "metadata": "{\"first_name\": \"Steven\"}"
        },
        {
          "guid": "USR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "identifier": "unique_id",
          "is_disabled": false,
          "metadata": "{\"first_name\": \"Barb\"}"
        }
      ]
    }
    
    class UsersResponseBody {
      Users: [
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Users: [
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class UsersResponseBody {
      users: [
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    UsersResponseBody {
      users: [
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/UsersResponseBody Object (
      [users] => Array (
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'users': [
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::UsersResponseBody
      @users= [
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    Use this endpoint to list every user you've created in Atrium.

    Institutions

    An institution represents a financial institution like Chase, Wells Fargo, or Mountain America Credit Union.

    It's important to point out that many real-world financial institutions will actually have several different institution objects within Atrium. This is because, for example, the banking and mortgage divisions of Wells Fargo may use separate online systems for accessing customer data, both of which may be different from the credit card division's system, etc.

    Endpoint Method Description
    /institutions GET Returns a list of institutions that are available for connection.
    /institutions/{institution_code} GET Returns information about a particular institution.
    /institutions/{institution_code}/credentials GET Returns information on what kind of credentials are needed for a particular institution.

    Read institution

    GET /institutions/{institution_code}
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/institutions/chase' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadInstitutionExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var institutionCode = "example_institution_code";  // string | The institution_code of the institution.
    
                try
                {
                    // Read institution
                    InstitutionResponseBody response = client.institutions.ReadInstitution(institutionCode);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling InstitutionsApi.ReadInstitution: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      institutionCode := "example_institution_code" // string | The institution_code of the institution.
    
      response, _, err := client.Institutions.ReadInstitution(ctx, institutionCode)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class InstitutionsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String institutionCode = "example_institution_code"; // String | The institution_code of the institution.
    
            try {
                InstitutionResponseBody response = client.institutions.readInstitution(institutionCode);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling InstitutionsApi#readInstitution");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var institutionCode = "example_institution_code"; // string | The institution_code of the institution.
    
    var response = client.institutions.readInstitution(institutionCode);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $institution_code = "example_institution_code"; // string | The institution_code of the institution.
    
    try {
        $result = $client->institutions->readInstitution($institution_code);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling InstitutionsApi->readInstitution: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # str | The institution_code of the institution.
    
    try:
        # Read institution
        response = client.institutions.read_institution(institution_code)
        pprint(response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->read_institution: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # String | The institution_code of the institution.
    
    begin
      #Read institution
      response = client.institutions.read_institution(institution_code)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling InstitutionsApi->read_institution: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "institution": {
        "code": "chase",
        "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
        "name": "Chase Bank",
        "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
        "supports_account_identification": true,
        "supports_account_statement": true,
        "supports_account_verification": true,
        "supports_transaction_history": true,
        "url": "https://www.chase.com"
      }
    }
    
    class InstitutionResponseBody {
      Institution:
        class Institution {
          Code: chase
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: Chase Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountStatement: true
          SupportsAccountVerification: true
          SupportsTransactionHistory: true
          Url: https://www.chase.com
        }
    }
    
    {
      Institution:
        {
          Code: chase
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: Chase Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountStatement: true
          SupportsAccountVerification: true
          SupportsTransactionHistory: true
          Url: https://www.chase.com
        }
    }
    
    class InstitutionResponseBody {
      institution:
        class Institution {
          code: chase
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: Chase Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountStatement: true
          supportsAccountVerification: true
          supportsTransactionHistory: true
          url: https://www.chase.com
        }
    }
    
    InstitutionResponseBody {
      institution:
        Institution {
          code: chase
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: Chase Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountStatement: true
          supportsAccountVerification: true
          supportsTransactionHistory: true
          url: https://www.chase.com
        }
    }
    
    atrium/model/InstitutionResponseBody Object (
      [institution] =>
        atrium/model/Institution Object (
          [code] => chase
          [medium_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          [name] => Chase Bank
          [small_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          [supports_account_identification] => true
          [supports_account_statement] => true
          [supports_account_verification] => true
          [supports_transaction_history] => true
          [url] => https://www.chase.com
        )
    )
    
    {
      'institution':
        {
          'code': chase
          'medium_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          'name': Chase Bank
          'small_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          'supports_account_identification': true
          'supports_account_statement': true
          'supports_account_verification': true
          'supports_transaction_history': true
          'url': https://www.chase.com
        }
    }
    
    #<MX::InstitutionResponseBody
      @institution=
        #<MX::Institution
          @code= chase
          @medium_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          @name= Chase Bank
          @small_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          @supports_account_identification= true
          @supports_account_statement= true
          @supports_account_verification= true
          @supports_transaction_history= true
          @url= https://www.chase.com
        >
    >
    

    This endpoint allows you to see information for a specific institution.

    Field Data type Description
    code String A unique identifier for each institution, defined by MX.
    medium_logo_url String URL for a 100px X 100px logo for each institution. A generic logo is returned for institutions that don't have one.
    name String An easy-to-read name for an institution, e.g., "Chase Bank" or "Wells Fargo Bank."
    small_logo_url String URL for a 50px X 50px logo for each institution. A generic logo is returned for institutions that don't have one.
    supports_account_identification Boolean Indicates whether the institution supports account identification.
    supports_account_statement Boolean Indicates whether the institution provides access to account statements.
    supports_account_verification Boolean Indicates whether the institution supports account verification.
    supports_transaction_history Boolean Indicates whether the institution allows access to up to 24 months of transaction data.
    url String Website URL for a particular institution, e.g., www.chase.com.

    List institutions

    GET /institutions
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/institutions?name=chase' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListInstitutionsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var name = name_example;  // string | This will list only institutions in which the appended string appears. (optional)
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
                var supportsAccountIdentification = true;  // bool? | Filter only institutions which support account identification. (optional)
                var supportsAccountStatement = true;  // bool? | Filter only institutions which support account statements. (optional)
                var supportsAccountVerification = true;  // bool? | Filter only institutions which support account verification. (optional)
                var supportsTransactionHistory = true;  // bool? | Filter only institutions which support extended transaction history. (optional)
    
                try
                {
                    // List institutions
                    InstitutionsResponseBody response = client.institutions.ListInstitutions(name, page, recordsPerPage, supportsAccountIdentification, supportsAccountStatement, supportsAccountVerification, supportsTransactionHistory);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling InstitutionsApi.ListInstitutions: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      opts := &atrium.ListInstitutionsOpts{
        Name: optional.NewString(name_example), // string | This will list only institutions in which the appended string appears.
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
        SupportsAccountIdentification: optional.NewBool(true), // bool | Filter only institutions which support account identification.
        SupportsAccountStatement: optional.NewBool(true), // bool | Filter only institutions which support account statements.
        SupportsAccountVerification: optional.NewBool(true), // bool | Filter only institutions which support account verification.
        SupportsTransactionHistory: optional.NewBool(true), // bool | Filter only institutions which support extended transaction history.
      }
    
      response, _, err := client.Institutions.ListInstitutions(ctx, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class InstitutionsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String name = name_example; // String | This will list only institutions in which the appended string appears.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
            Boolean supportsAccountIdentification = true; // Boolean | Filter only institutions which support account identification.
            Boolean supportsAccountStatement = true; // Boolean | Filter only institutions which support account statements.
            Boolean supportsAccountVerification = true; // Boolean | Filter only institutions which support account verification.
            Boolean supportsTransactionHistory = true; // Boolean | Filter only institutions which support extended transaction history.
    
            try {
                InstitutionsResponseBody response = client.institutions.listInstitutions(name, page, recordsPerPage, supportsAccountIdentification, supportsAccountStatement, supportsAccountVerification, supportsTransactionHistory);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling InstitutionsApi#listInstitutions");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var name = name_example; // string | This will list only institutions in which the appended string appears. (optional)
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    var supportsAccountIdentification = true; // boolean | Filter only institutions which support account identification. (optional)
    var supportsAccountStatement = true; // boolean | Filter only institutions which support account statements. (optional)
    var supportsAccountVerification = true; // boolean | Filter only institutions which support account verification. (optional)
    var supportsTransactionHistory = true; // boolean | Filter only institutions which support extended transaction history. (optional)
    
    var response = client.institutions.listInstitutions(name, page, recordsPerPage, supportsAccountIdentification, supportsAccountStatement, supportsAccountVerification, supportsTransactionHistory);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $name = name_example; // string | This will list only institutions in which the appended string appears.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    $supports_account_identification = true; // bool | Filter only institutions which support account identification.
    $supports_account_statement = true; // bool | Filter only institutions which support account statements.
    $supports_account_verification = true; // bool | Filter only institutions which support account verification.
    $supports_transaction_history = true; // bool | Filter only institutions which support extended transaction history.
    
    try {
        $result = $client->institutions->listInstitutions($name, $page, $records_per_page, $supports_account_identification, $supports_account_statement, $supports_account_verification, $supports_transaction_history);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling InstitutionsApi->listInstitutions: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    name = name_example # str | This will list only institutions in which the appended string appears. (optional)
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    supports_account_identification = true # bool | Filter only institutions which support account identification. (optional)
    supports_account_statement = true # bool | Filter only institutions which support account statements. (optional)
    supports_account_verification = true # bool | Filter only institutions which support account verification. (optional)
    supports_transaction_history = true # bool | Filter only institutions which support extended transaction history. (optional)
    
    try:
        # List institutions
        response = client.institutions.list_institutions(name=name, page=page, records_per_page=records_per_page, supports_account_identification=supports_account_identification, supports_account_statement=supports_account_statement, supports_account_verification=supports_account_verification, supports_transaction_history=supports_transaction_history)
        pprint(response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->list_institutions: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    opts = {
      name: name_example, # String | This will list only institutions in which the appended string appears.
      page: 1, # Integer | Specify current page.
      records_per_page: 12, # Integer | Specify records per page.
      supports_account_identification: true, # BOOLEAN | Filter only institutions which support account identification.
      supports_account_statement: true, # BOOLEAN | Filter only institutions which support account statements.
      supports_account_verification: true, # BOOLEAN | Filter only institutions which support account verification.
      supports_transaction_history: true # BOOLEAN | Filter only institutions which support extended transaction history.
    }
    
    begin
      #List institutions
      response = client.institutions.list_institutions(opts)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling InstitutionsApi->list_institutions: #{e}"
    end
    

    Example response

    {
      "institutions": [
        {
          "code": "chase",
          "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
          "name": "Chase Bank",
          "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
          "supports_account_identification": true,
          "supports_account_statement": true,
          "supports_account_verification": true,
          "supports_transaction_history": true,
          "url": "https://www.chase.com"
        }
      ]
    }
    
    class InstitutionsResponseBody {
      Institutions: [
        class Institution {
          Code: chase
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: Chase Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountStatement: true
          SupportsAccountVerification: true
          SupportsTransactionHistory: true
          Url: https://www.chase.com
        }
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Institutions: [
        {
          Code: chase
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: Chase Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountStatement: true
          SupportsAccountVerification: true
          SupportsTransactionHistory: true
          Url: https://www.chase.com
        }
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class InstitutionsResponseBody {
      institutions: [
        class Institution {
          code: chase
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: Chase Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountStatement: true
          supportsAccountVerification: true
          supportsTransactionHistory: true
          url: https://www.chase.com
        }
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    InstitutionsResponseBody {
      institutions: [
        Institution {
          code: chase
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: Chase Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountStatement: true
          supportsAccountVerification: true
          supportsTransactionHistory: true
          url: https://www.chase.com
        }
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/InstitutionsResponseBody Object (
      [institutions] => Array (
        atrium/model/Institution Object (
          [code] => chase
          [medium_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          [name] => Chase Bank
          [small_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          [supports_account_identification] => true
          [supports_account_statement] => true
          [supports_account_verification] => true
          [supports_transaction_history] => true
          [url] => https://www.chase.com
        )
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'institutions': [
        {
          'code': chase
          'medium_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          'name': Chase Bank
          'small_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          'supports_account_identification': true
          'supports_account_statement': true
          'supports_account_verification': true
          'supports_transaction_history': true
          'url': https://www.chase.com
        }
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::InstitutionsResponseBody
      @institutions= [
        #<MX::Institution
          @code= chase
          @medium_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          @name= Chase Bank
          @small_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          @supports_account_identification= true
          @supports_account_statement= true
          @supports_account_verification= true
          @supports_transaction_history= true
          @url= https://www.chase.com
        >
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    This endpoint allows you to see what institutions are available for connection. Information returned will include the institution_code assigned to a particular institution, URLs for the financial institution's logo, and the URL for its website.

    This endpoint takes certain optional query string parameters to facilitate searching for specific institutions.

    Parameter Results
    name={string} Only institutions whose name contains the appended string will be returned.
    supports_account_identification=true Only institutions which support identity will be returned.
    supports_account_statement=true Only institutions which offer access to account statements will be returned.
    supports_account_verification=true Only institutions which support account verification will be returned.
    supports_transaction_history=true Only institutions which offer an extended transaction history will be returned.

    Read institution credentials

    GET /institutions/{institution_code}/credentials
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/institutions/chase/credentials' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadInstitutionCredentialsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var institutionCode = "example_institution_code";  // string | The institution_code of the institution.
    
                try
                {
                    // Read institution credentials
                    CredentialsResponseBody response = client.institutions.ReadInstitutionCredentials(institutionCode);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling InstitutionsApi.ReadInstitutionCredentials: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      institutionCode := "example_institution_code" // string | The institution_code of the institution.
    
      response, _, err := client.Institutions.ReadInstitutionCredentials(ctx, institutionCode)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class InstitutionsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String institutionCode = "example_institution_code"; // String | The institution_code of the institution.
    
            try {
                CredentialsResponseBody response = client.institutions.readInstitutionCredentials(institutionCode);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling InstitutionsApi#readInstitutionCredentials");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var institutionCode = "example_institution_code"; // string | The institution_code of the institution.
    
    var response = client.institutions.readInstitutionCredentials(institutionCode);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $institution_code = "example_institution_code"; // string | The institution_code of the institution.
    
    try {
        $result = $client->institutions->readInstitutionCredentials($institution_code);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling InstitutionsApi->readInstitutionCredentials: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # str | The institution_code of the institution.
    
    try:
        # Read institution credentials
        response = client.institutions.read_institution_credentials(institution_code)
        pprint(response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->read_institution_credentials: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # String | The institution_code of the institution.
    
    begin
      #Read institution credentials
      response = client.institutions.read_institution_credentials(institution_code)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling InstitutionsApi->read_institution_credentials: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
        "credentials": [
            {
                "field_name": "login_email",
                "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
                "label": "Email Address",
                "display_order": 0,
                "type": "LOGIN"
            },
            {
                "field_name": "login_password",
                "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
                "label": "PayPal password",
                "display_order": 1,
                "type": "PASSWORD"
            }
        ]
    }
    
    class CredentialsResponseBody {
      Credentials: [
        class CredentialResponse {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            class CredentialOption {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    {
      Credentials: [
        {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    class CredentialsResponseBody {
      credentials: [
        class CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            class CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    CredentialsResponseBody {
      credentials: [
        CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    atrium/model/CredentialsResponseBody Object (
      [credentials] => Array (
        atrium/model/CredentialResponse Object (
          [field_name] => LOGIN
          [guid] => CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          [label] => Username
          [options] => Array (
            atrium/model/CredentialOption Object (
              [label] => option_label
              [value] => option_value
            )      
          )
          [type] => LOGIN
        )  
      )
    )
    
    {
      'credentials': [
        {
          'field_name': LOGIN
          'guid': CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          'label': Username
          'options': [
            {
              'label': option_label
              'value': option_value
            }      
          ]
          'type': LOGIN
        }  
      ]
    }
    
    #<MX::CredentialsResponseBody
      @credentials= [
        #<MX::CredentialResponse
          @field_name= LOGIN
          @guid= CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          @label= Username
          @options= [
            #<MX::CredentialOption
              @label= option_label
              @value= option_value
            >      
          ]
          @type= LOGIN
        >  
      ]
    >
    

    Use this endpoint to see which credentials will be needed to create a member for a specific institution.

    Field Data type Description
    display_order Integer The order in which the credential should be displayed to the end user; lower numbers should be displayed first.
    field_name String Name of the credential field for the institution, e.g., "LOGIN"
    guid String A unique identifier for the credential. Defined by MX.
    label String A label for the credential, intended to be readable by the end user, e.g., "Username"
    type String A name for the type of field, e.g., "PASSWORD"
    options Array See explanation that immediately follows.

    For credentials with the type OPTIONS, the credentials object will contain a nested array called options. This array lists various choices available for credential prompts, and includes further attributes.

    Field Data type Description
    label String A label for the credential prompt.
    value String A response for the credential prompt.

    Members

    A member represents the relationship between a user and an institution, and creating one is how you connect one to the other. Thus, multiple members may be attached to a single user, e.g., one for their bank, another for their mortgage provider, another for their credit card provider, etc.

    Endpoint Method Description
    /users/{user_guid}/members POST Create a new member.
    /users/{user_guid}/members/{member_guid} GET Read information about a specific member.
    /users/{user_guid}/members/{member_guid} PUT Update a specific member.
    /users/{user_guid}/members GET List all members that belong to a user.
    /users/{user_guid}/members/{member_guid}/aggregate GET Aggregate a member.
    /users/{user_guid}/members/{member_guid}/status GET Read the aggregation status of a member.
    /users/{user_guid}/members/{member_guid}/challenges GET List the MFA challenges for a member.
    /users/{user_guid}/members/{member_guid}/credentials GET List the Non-MFA credentials for a member.
    /users/{user_guid}/members/{member_guid}/resume PUT This resumes aggregation for a member with status CHALLENGED by answering MFA challenges./users/{user_guid}/members/{member_guid}/accounts
    /users/{user_guid}/members/{member_guid}/transactions GET Returns a list of transactions associated with a specific member.
    users/{user_guid}/members/{member_guid}/statements GET Returns an array containing the account statements associated with the specified member.

    Create member

    POST /users/{user_guid}/members
    

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member": {
              "institution_code": "chase",
              "credentials": [
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "ExampleUsername"
                },
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "Pa$$vv@Rd"
                }
              ],
              "skip_aggregation": true
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
                try
                {
                    // Create member
                    MemberResponseBody response = client.members.CreateMember(userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.CreateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberCreateRequestBody{} // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
      response, _, err := client.Members.CreateMember(ctx, userGUID, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberCreateRequestBody body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
            try {
                MemberResponseBody response = client.members.createMember(userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#createMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    var response = client.members.createMember(userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberCreateRequestBody(); // \atrium\model\MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try {
        $result = $client->members->createMember($user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->createMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberCreateRequestBody() # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try:
        # Create member
        response = client.members.create_member(user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->create_member: %s\n" % e)
    
    # 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_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->create_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-10-13T17:57:36+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    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, with values provided by the end 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. You can prevent this automatic aggregation attempt by setting the optional skip_aggregation parameter to true in the request body.

    Parameter Data type Description Required?
    credentials Array The credentials endpoint for the requested institution will give you a list of all the credentials required to create a member for a given institution. Each required credential will need to be included within this array. Yes
    identifier String A unique enforced identifier for the member, defined by you. No
    institution_code String Unique code for the institution to which the member will connect. Yes
    metadata String Additional information you can store on this member. No
    skip_aggregation Boolean Setting this parameter to true will prevent the member from automatically aggregating when it is created. No

    Read member

    GET /users/{user_guid}/members/{member_guid}
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member
                    MemberResponseBody response = client.members.ReadMember(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMember(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberResponseBody response = client.members.readMember(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMember(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMember($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member
        response = client.members.read_member(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member: %s\n" % e)
    
    # 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
    

    Example response

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at": "2016-10-13T18:07:57+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": false,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "COMPLETED",
        "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"    
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Use this endpoint to read the attributes of a specific member.

    A member has the following attributes:

    Field Data type Description
    aggregated_at String The date and time the account was last aggregated.
    connection_status String The status of a member's aggregation. Read more about these statuses below.
    guid String A unique identifier for the member. Defined by MX.
    identifier String A unique, enforced identifier for the member. Defined by you.
    institution_code String Unique identifier for the institution. Defined by MX.
    is_being_aggregated Boolean This value is true if the member is being aggregated at the time of the request and false otherwise.
    metadata String Additional information you can store on this member.
    name String The name of the member. If omitted as a parameter when creating the member, the institution name within the MX platform will be used, e.g., "Chase Bank."
    status String The status of a member's aggregation. This field will soon be deprecated. Use connection_status above as more detailed indicator of a member's status.
    successfully_aggregated_at String The date and time the member was successfully aggregated.
    user_guid String A unique identifier for the user. Defined by MX.

    Update member

    PUT /users/{user_guid}/members/{member_guid}
    

    Example request

    $ curl -i -X PUT 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member":{
              "credentials":[
                {
                   "guid": "CRD-598ec8d4-6200-8cda-345d-3dbb5fc17716",
                   "value": "updated-username"
                },
                {
                   "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
                   "value": "updated-password"
                }
              ],
              "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-16\"}"
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class UpdateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberUpdateRequestBody(); // MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata) (optional)
    
                try
                {
                    // Update member
                    MemberResponseBody response = client.members.UpdateMember(memberGuid, userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.UpdateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.UpdateMemberOpts{
        Body: optional.NewInterface(atrium.MemberUpdateRequestBody{}), // MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata)
      }
    
      response, _, err := client.Members.UpdateMember(ctx, memberGUID, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberUpdateRequestBody body = new MemberUpdateRequestBody(); // MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata)
    
            try {
                MemberResponseBody response = client.members.updateMember(memberGuid, userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#updateMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberUpdateRequestBody(); // MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata) (optional)
    
    var response = client.members.updateMember(memberGuid, userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberUpdateRequestBody(); // \atrium\model\MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata)
    
    try {
        $result = $client->members->updateMember($member_guid, $user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->updateMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberUpdateRequestBody() # MemberUpdateRequestBody | Member object to be updated with optional parameters (credentials, identifier, metadata) (optional)
    
    try:
        # Update member
        response = client.members.update_member(member_guid, user_guid, body=body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->update_member: %s\n" % e)
    
    # 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
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-09-30T14:43:44-06:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": false,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-16\"}",
        "name": "Bank Name",
        "status": "INITIATED",
        "successfully_aggregated_at": "2016-09-30T14:38:59-06:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"    
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    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.

    Parameter Data type Description Required?
    credentials Array The credentials that you wish to update for this member. No
    identifier String A unique, enforced identifier for the member. Defined by you. No
    metadata String Additional information you can store on this member. Defined by you. No

    Delete member

    DELETE /users/{user_guid}/members/{member_guid}
    

    Example request

    $ curl -i -X DELETE 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class DeleteMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Delete member
                    client.members.DeleteMember(memberGuid, userGuid);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.DeleteMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.DeleteMember(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                client.members.deleteMember(memberGuid, userGuid);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#deleteMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.deleteMember(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $client->members->deleteMember($member_guid, $user_guid);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->deleteMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Delete member
        client.members.delete_member(member_guid, user_guid)
    except ApiException as e:
        print("Exception when calling MembersApi->delete_member: %s\n" % e)
    
    # 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
    

    Example response

    Status: 204 No Content
    

    Accessing this endpoint will permanently delete a member.

    List members

    GET /users/{user_guid}/members
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListMembersExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List members
                    MembersResponseBody response = client.members.ListMembers(userGuid, page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ListMembers: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.ListMembersOpts{
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Members.ListMembers(ctx, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                MembersResponseBody response = client.members.listMembers(userGuid, page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#listMembers");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.members.listMembers(userGuid, page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->members->listMembers($user_guid, $page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->listMembers: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List members
        response = client.members.list_members(user_guid, page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->list_members: %s\n" % e)
    
    # 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
    

    Example response

    Status 200 OK
    
    {
      "members": [
        {
          "aggregated_at": "2016-10-13T18:07:57+00:00",
          "connection_status": "CONNECTED",
          "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "identifier": "unique_id",
          "institution_code": "chase",
          "is_being_aggregated": true,
          "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
          "name": "Chase Bank",
          "status": "INITIATED",
          "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
          "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
        }
      ]
    }
    
    class MembersResponseBody {
      Members: [
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Members: [
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class MembersResponseBody {
      members: [
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    MembersResponseBody {
      members: [
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/MembersResponseBody Object (
      [members] => Array (
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'members': [
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::MembersResponseBody
      @members= [
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    This endpoint returns an array which contains information on every member associated with a specific user.

    Aggregate member

    POST /users/{user_guid}/members/{member_guid}/aggregate
    

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/aggregate' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class AggregateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Aggregate member
                    MemberResponseBody response = client.members.AggregateMember(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.AggregateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.AggregateMember(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberResponseBody response = client.members.aggregateMember(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#aggregateMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.aggregateMember(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->aggregateMember($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->aggregateMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Aggregate member
        response = client.members.aggregate_member(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->aggregate_member: %s\n" % e)
    
    # 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
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-10-13T18:07:57+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Calling this endpoint initiates an aggregation event for the member. This gathers the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

    Aggregate member account balances

    Endpoint:

    POST /users/{user_guid}/members/{member_guid}/balance
    

    Example request:

    curl -X POST \
      https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/balance \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class AggregateMemberBalancesExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Aggregate member account balances
                    MemberResponseBody response = client.members.AggregateMemberBalances(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.AggregateMemberBalances: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.AggregateMemberBalances(ctx, memberGUID, userGUID, )
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberResponseBody response = client.members.aggregateMemberBalances(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#aggregateMemberBalances");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.aggregateMemberBalances(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->aggregateMemberBalances($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->aggregateMemberBalances: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Aggregate member account balances
        response = client.members.aggregate_member_balances(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->aggregate_member_balances: %s\n" % e)
    
    # 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
    

    Example response:

    {
      "member": {
        "aggregated_at": "2019-10-07T16:25:27Z",
        "connection_status": "EXPIRED",
        "guid": "MBR-a4652b66-3ee5-cb9f-295a-72eddef61db5",
        "identifier": null,
        "institution_code": "mxbank",
        "is_being_aggregated": true,
        "metadata": null,
        "name": "MX Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": "2019-10-07T15:58:59Z",
        "user_guid": "USR-72aba5cc-8c74-b22c-227c-4b1c095fa12e"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    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.

    Read member connection status

    GET /users/{user_guid}/members/{member_guid}/status
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # 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
    

    Example response

    Status: 200 OK
    
    {
      "member": {
          "aggregated_at": "2019-06-08T17:21:05Z",
          "connection_status": "CONNECTED",
          "status": "COMPLETED",
          "successfully_aggregated_at": "2019-06-07T21:16:03Z",
          "guid": "MBR-a4652b66-3ee5-cb9f-295a-72eddef61db5",
          "has_processed_accounts": true,
          "has_processed_transactions": true,
          "is_being_aggregated": false
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => true
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': true
          'has_processed_transactions': false
          'is_being_aggregated': false
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= true
          @has_processed_transactions= false
          @is_being_aggregated= false
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Example response for status CHALLENGED

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at":"2016-10-13T18:24:37+00:00",
        "challenges": [
          {
            "field_name": null,
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "label": "What city were you born in?",
            "type": "TEXT"
          }
        ],
        "connection_status": "CHALLENGED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": false,
        "has_processed_transactions": false,
        "is_being_aggregated": true,
        "status": "CHALLENGED",
        "successfully_aggregated_at": "2016-10-13T18:08:04+00:00"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            class Challenge {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            class Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [challenges] => Array (
            atrium/model/Challenge Object (
              [field_name] => What city were you born in?
              [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              [label] => What city were you born in?
              [type] => TEXT
            )
          )
          [connection_status] => CHALLENGED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => false
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => CHALLENGED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'challenges': [
            {
              'field_name': What city were you born in?
              'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              'label': What city were you born in?
              'type': TEXT
            }
          ]
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': false
          'has_processed_transactions': false
          'is_being_aggregated': true
          'status': CHALLENGED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @challenges= [
            #<MX::Challenge
              @field_name= What city were you born in?
              @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              @label= What city were you born in?
              @type= TEXT
            >
          ]
          @connection_status= CHALLENGED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= false
          @has_processed_transactions= false
          @is_being_aggregated= true
          @status= CHALLENGED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    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.

    Member connection statuses should be used in conjunction with all the fields described below. For instance, when is_being_aggregated switches from true to false and the value of connection_status is CONNECTED, you can stop polling the status and list the member's transactions or list the transactions for a specific account.

    The response for this endpoint is not the same as the read member endpoint; this endpoint returns fields which are specifically focused on the state of the member's aggregation, as well as including MFA challenges when the connection_status is CHALLENGED.

    MX recommends a minimum polling interval of 3 seconds when using this endpoint.

    Read member connection status fields

    Field Data type Description
    aggregated_at String The date and time the account was last aggregated.
    challenges Array An array containing MFA challenges that have been issued. challenges will only be present when the connection_status is CHALLENGED.
    connection_status String The status of a member's aggregation. Read more about these statuses here.
    guid String A unique identifier for the member. Defined by MX.
    has_processed_accounts Boolean true when accounts have been processed for a member, false otherwise. Resets each time /aggregate is called.
    has_processed_transactions Boolean true when transactions have been processed a this member, false otherwise. Resets each time /aggregate is called.
    is_being_aggregated Boolean This value is true if the member is being aggregated at the time of the request and false otherwise.
    status String The status of a member's aggregation. This field will soon be deprecated. Use connection_status above as more detailed indicator of a member's status.
    successfully_aggregated_at String The date and time the member was successfully aggregated.

    Connection status definitions

    Connection status id (integer) Connection status (string) Definition Next steps End-user message
    null null The member exists but does not have credentials. None. None.
    0 CREATED The member is new and has not yet been aggregated. Aggregate the member once the end user logs in; poll for a status update. Connecting to {...} ...
    1 PREVENTED MX is preventing aggregation until the member’s credentials have been updated. Display end-user message; after end user has updated their credentials, aggregate again. The last 3 attempts to connect have failed. Please re-enter your credentials to continue importing data.
    2 DENIED The credentials provided for the member were invalid. Display end-user message; after end user has updated their credentials, aggregate again. The credentials entered do not match your credentials at this institution. Please re-enter your credentials to continue importing data.
    3 CHALLENGED The member has been challenged by multi-factor authentication. Display end-user message; follow MFA pathway; after the user answers MFA, poll for a status update. To authenticate your connection to {...}, please answer the following challenge(s).
    4 REJECTED An MFA challenge was answered incorrectly. Display end-user message; another challenge may follow or aggregation may need to be restarted. The answer or answers provided were incorrect. Please try again.
    5 LOCKED The financial institution is preventing authentication. The end user must contact the financial institution. Display end-user message. Your account is locked. Please log in to the appropriate website for {...} and follow the steps to resolve the issue.
    6 CONNECTED The member was successfully authenticated and data is now aggregating. Display the account as having been connected. Connected to [...] ...
    7 IMPEDED The end user’s attention is required at their online banking institution, e.g., there is a marketing message that must be viewed, terms and conditions that must be accepted, etc. Display end-user message. Your attention is needed at this institution's website. Please log in to the appropriate website for {...} and follow the steps to resolve the issue.
    8 RECONNECTED The member has been migrated to a new data source and aggregation is likely to trigger one-time password MFA. MX will not perform background aggregation in order to avoid unnecessarily disruptive texts, emails, etc. The member must be re-aggregated in the foreground with the end user present. Aggregate the member once the end user logs in; poll for a status update. Reconnecting to {...} ...
    9 DEGRADED Aggregation has failed at least three times within a short period of time. Display end-user message. We are upgrading this connection. Please try again later.
    10 DISCONNECTED Aggregation has failed at least three times and has not succeeded for at least two weeks. Display end-user message. It looks like your data from {...} cannot be imported. We are working to resolve the issue.
    11 DISCONTINUED The connection to this financial institution is no longer available. Display end-user message. Connections to this institution are no longer supported. You may create a manual account and use manual transactions to track data for this account.
    12 CLOSED The end user, MX, the client, or a partner has marked the member as closed. Display end-user message. This connection has been closed. You may track this account manually. If reopened, you may connect the institution again.
    13 DELAYED Aggregating the member has taken longer than expected and it has not yet been connected. Display end-user message; poll for a status update. Importing your data from {...} may take a while. Please check back later.
    14 FAILED Aggregation failed without being connected. Display end-user message; try aggregating again later. There was a problem validating your credentials with {...}. Please try again later.
    15 UPDATED The member has been updated — i.e., credentials have been updated — but it has not yet been connected. Aggregate the member once the end user logs in; poll for a status update. Connecting to {...} ...
    16 DISABLED Aggregation has been momentarily paused, but the member is still connected. Display end-user message. Importing data from this institution has been disabled. Please contact us if you believe it has been disabled in error.
    17 IMPORTED MX does not have credentials and will not try to aggregate the member until the end user provides credentials. Display end-user message; re-aggregate after the end user updates credentials. You must re-authenticate before your data can be imported. Please enter your credentials for {...}.
    18 RESUMED The answer to an MFA challenge was received, but it is not yet clear whether it was correct. Poll for a status update. Connecting to {...} ...
    19 EXPIRED The MFA answer was not provided within the time allotted by the financial institution. Display end-user message; re-aggregate the member if the end user initiates it. The answer or answers were not provided in time. Please try again.
    20 IMPAIRED The member is missing some or all credentials needed in order to connect. Display end-user message; re-aggregate after the end user updates credentials. You must re-authenticate before your data can be imported. Please enter your credentials for {...}.

    Status definitions (soon to be deprecated)

    status Description Next steps
    INITIATED Aggregation has started.
    REQUESTED Request to get the data has started.
    CHALLENGED MFA challenged returned. Resume member with updated credentials.
    RECEIVED Received response back from the request.
    TRANSFERRED Start saving the data into the MX Platform.
    PROCESSED Data has been processed into the MX Platform.
    COMPLETED Aggregation is complete. List member accounts and transactions.
    PREVENTED Aggregation was prevented due to too many login attempts. List member credentials, update member.
    DENIED Authentication failed due to invalid credentials or incorrect MFA answer. List member credentials, update member. If MFA was answered incorrectly, restart aggregation.
    HALTED An exception occurred that was unrelated to authentication. Retry aggregation tomorrow. If the member hits the HALTED status for 3 or more days, leave the member in its current state and contact support by submitting a ticket here.

    List member MFA challenges

    GET /users/{user_guid}/members/member_guid}/challenges
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/challenges' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListMemberMFAChallengesExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // List member MFA challenges
                    ChallengesResponseBody response = client.members.ListMemberMFAChallenges(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ListMemberMFAChallenges: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ListMemberMFAChallenges(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                ChallengesResponseBody response = client.members.listMemberMFAChallenges(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#listMemberMFAChallenges");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.listMemberMFAChallenges(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->listMemberMFAChallenges($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->listMemberMFAChallenges: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # List member MFA challenges
        response = client.members.list_member_mfa_challenges(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->list_member_mfa_challenges: %s\n" % e)
    
    # 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
    

    Example response for credential type TEXT

    Status: 200 OK
    
    {
      "challenges": [
        {
          "field_name": "What city were you born in?",
          "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
          "label": "What city were you born in?",
          "type": "TEXT"
        }
      ]
    }
    
    class ChallengesResponseBody {
      Challenges: [
        class Challenge {
          FieldName: What city were you born in?
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: What city were you born in?
          Type: TEXT
        }  
      ]
    }
    
    {
      Challenges: [
        {
          FieldName: What city were you born in?
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: What city were you born in?
          Type: TEXT
        }  
      ]
    }
    
    class ChallengesResponseBody {
      challenges: [
        class Challenge {
          fieldName: What city were you born in?
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: What city were you born in?
          type: TEXT
        }  
      ]
    }
    
    ChallengesResponseBody {
      challenges: [
        Challenge {
          fieldName: What city were you born in?
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: What city were you born in?
          type: TEXT
        }  
      ]
    }
    
    atrium/model/ChallengesResponseBody Object (
      [challenges] => Array (
        atrium/model/Challenge Object (
          [field_name] => What city were you born in?
          [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          [label] => What city were you born in?
          [type] => TEXT
        )  
      )
    )
    
    {
      'challenges': [
        {
          'field_name': What city were you born in?
          'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          'label': What city were you born in?
          'type': TEXT
        }  
      ]
    }
    
    #<MX::ChallengesResponseBody
      @challenges= [
        #<MX::Challenge
          @field_name= What city were you born in?
          @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          @label= What city were you born in?
          @type= TEXT
        >  
      ]
    >
    

    Example response for credential type IMAGE_DATA

    Status: 200 OK
    
    {
      "challenges": [
        {
          "field_name": "Who is this guy?",
          "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
          "label": "Who is this guy?",
          "type": "IMAGE_DATA",
          "image_data": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."
        }
      ]
    }
    
    class ChallengesResponseBody {
      Challenges: [
        class Challenge {
          FieldName: Who is this guy?
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          Label: Who is this guy?
          Type: IMAGE_DATA
        }  
      ]
    }
    
    {
      Challenges: [
        {
          FieldName: Who is this guy?
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          Label: Who is this guy?
          Type: IMAGE_DATA
        }  
      ]
    }
    
    class ChallengesResponseBody {
      challenges: [
        class Challenge {
          fieldName: Who is this guy?
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          label: Who is this guy?
          type: IMAGE_DATA
        }  
      ]
    }
    
    ChallengesResponseBody {
      challenges: [
        Challenge {
          fieldName: Who is this guy?
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          label: Who is this guy?
          type: IMAGE_DATA
        }  
      ]
    }
    
    atrium/model/ChallengesResponseBody Object (
      [challenges] => Array (
        atrium/model/Challenge Object (
          [field_name] => Who is this guy?
          [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          [label] => Who is this guy?
          [type] => IMAGE_DATA
        )  
      )
    )
    
    {
      'challenges': [
        {
          'field_name': Who is this guy?
          'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          'label': Who is this guy?
          'type': IMAGE_DATA
        }  
      ]
    }
    
    #<MX::ChallengesResponseBody
      @challenges= [
        #<MX::Challenge
          @field_name= Who is this guy?
          @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
          @label= Who is this guy?
          @type= IMAGE_DATA
        >  
      ]
    >
    

    Example response for credential type OPTIONS

    Status: 200 OK
    
    {
      "challenges": [
        {
          "field_name": "One time passcode",
          "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
          "label": "Where should we send your one time passcode?",
          "type": "OPTIONS",
          "options": [
            {
              "label": "user_email@provider.org",
              "value": "0"
            },
            {
              "label": "(XXX) XXX-1234",
                "value": "1"
            },
            {
              "label": "(XXX) XXX-2345",
              "value": "2"
            }
          ]
        }
      ]
    }
    
    class ChallengesResponseBody {
      Challenges: [
        class Challenge {
          FieldName: One time passcode
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: Where should we send your one time passcode?
          Options: [
            class ChallengeOption {
              Label: user_email@provider.org
              Value: 0
            }
            class ChallengeOption {
              Label: (XXX) XXX-1234
              Value: 1
            }   
            class ChallengeOption {
              Label: (XXX) XXX-2345
              Value: 2
            }         
          ]
          Type: OPTIONS
        }  
      ]
    }
    
    {
      Challenges: [
        {
          FieldName: One time passcode
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: Where should we send your one time passcode?
          Options: [
            {
              Label: user_email@provider.org
              Value: 0
            }  
            {
              Label: (XXX) XXX-1234
              Value: 1
            }   
            {
              Label: (XXX) XXX-2345
              Value: 2
            }       
          ]
          Type: OPTIONS
        }  
      ]
    }
    
    class ChallengesResponseBody {
      challenges: [
        class Challenge {
          fieldName: One time passcode
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: Where should we send your one time passcode?
          options: [
            class ChallengeOption {
              label: user_email@provider.org
              value: 0
            }      
            class ChallengeOption {
              label: (XXX) XXX-1234
              value: 1
            }    
            class ChallengeOption {
              label: (XXX) XXX-2345
              value: 2
            }    
          ]
          type: OPTIONS
        }  
      ]
    }
    
    ChallengesResponseBody {
      challenges: [
        Challenge {
          fieldName: One time passcode
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: Where should we send your one time passcode?
          options: [
            ChallengeOption {
              label: user_email@provider.org
              value: 0
            }      
            ChallengeOption {
              label: (XXX) XXX-1234
              value: 1
            }
            ChallengeOption {
              label: (XXX) XXX-2345
              value: 2
            }
          ]
          type: OPTIONS
        }  
      ]
    }
    
    atrium/model/ChallengesResponseBody Object (
      [challenges] => Array (
        atrium/model/Challenge Object (
          [field_name] => One time passcode
          [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          [label] => Where should we send your one time passcode?
          [options] => Array (
            atrium/model/ChallengeOption Object (
              [label] => user_email@provider.org
              [value] => 0
            )      
            atrium/model/ChallengeOption Object (
              [label] => (XXX) XXX-1234
              [value] => 1
            )   
            atrium/model/ChallengeOption Object (
              [label] => (XXX) XXX-2345
              [value] => 2
            )   
          )
          [type] => OPTIONS
        )  
      )
    )
    
    {
      'challenges': [
        {
          'field_name': One time passcode
          'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          'label': Where should we send your one time passcode?
          'options': [
            {
              'label': user_email@provider.org
              'value': 0
            }      
            {
              'label': (XXX) XXX-1234
              'value': 1
            }   
            {
              'label': (XXX) XXX-2345
              'value': 2
            }   
          ]
          'type': OPTIONS
        }  
      ]
    }
    
    #<MX::ChallengesResponseBody
      @challenges= [
        #<MX::Challenge
          @field_name= One time passcode
          @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          @label= Where should we send your one time passcode?
          @options= [
            #<MX::ChallengeOption
              @label= user_email@provider.org
              @value= 0
            >      
            #<MX::ChallengeOption
              @label= (XXX) XXX-1234
              @value= 1
            >     
            #<MX::ChallengeOption
              @label= (XXX) XXX-2345
              @value= 2
            >     
          ]
          @type= OPTIONS
        >  
      ]
    >
    

    Example response for credential type IMAGE_OPTIONS

    Status: 200 OK
    
    {
      "challenges": [
        {
          "field_name": "Choose your image",
          "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
          "label": "Which is your image?",
          "type": "IMAGE_OPTIONS",
          "options": [
            {
              "label": "IMAGE_1",
              "image_data": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."
            },
            {
              "label": "IMAGE_2",
              "image_data": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."
            },
            {
              "label": "IMAGE_3",
              "image_data": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."
            },
            {
              "label": "IMAGE_4",
              "image_data": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."
            }
          ]
        }
      ]
    }
    
    class ChallengesResponseBody {
      Challenges: [
        class Challenge {
          FieldName: Choose your image
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: Which is your image?
          Options: [
            class ChallengeOption {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_1
            }   
            class ChallengeOption {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_2
            }    
            class ChallengeOption {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_3
            }    
            class ChallengeOption {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_4
            }       
          ]
          Type: IMAGE_OPTIONS
        }  
      ]
    }
    
    {
      Challenges: [
        {
          FieldName: Choose your image
          Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          Label: Which is your image?
          Options: [
            {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_1
            }   
            {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_2
            }   
            {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_3
            }   
            {
              ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              Label: IMAGE_4
            }      
          ]
          Type: IMAGE_OPTIONS
        }  
      ]
    }
    
    class ChallengesResponseBody {
      challenges: [
        class Challenge {
          fieldName: Choose your image
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: Which is your image?
          options: [
            class ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_1
            }      
            class ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_2
            }      
            class ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_3
            }      
            class ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_4
            }      
          ]
          type: IMAGE_OPTIONS
        }  
      ]
    }
    
    ChallengesResponseBody {
      challenges: [
        Challenge {
          fieldName: Choose your image
          guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          label: Which is your image?
          options: [
            ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_1
            }      
            ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_2
            }     
            ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_3
            }     
            ChallengeOption {
              imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              label: IMAGE_4
            }     
          ]
          type: IMAGE_OPTIONS
        }  
      ]
    }
    
    atrium/model/ChallengesResponseBody Object (
      [challenges] => Array (
        atrium/model/Challenge Object (
          [field_name] => Choose your image
          [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          [label] => Which is your image?
          [options] => Array (
            atrium/model/ChallengeOption Object (
              [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              [label] => IMAGE_1
            )      
            atrium/model/ChallengeOption Object (
              [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              [label] => IMAGE_2
            )    
            atrium/model/ChallengeOption Object (
              [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              [label] => IMAGE_3
            )    
            atrium/model/ChallengeOption Object (
              [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              [label] => IMAGE_4
            )    
          )
          [type] => IMAGE_OPTIONS
        )  
      )
    )
    
    {
      'challenges': [
        {
          'field_name': Choose your image
          'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          'label': Which is your image?
          'options': [
            {
              'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              'label': IMAGE_1
            }      
            {
              'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              'label': IMAGE_2
            }     
            {
              'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              'label': IMAGE_3
            }     
            {
              'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              'label': IMAGE_4
            }
          ]
          'type': IMAGE_OPTIONS
        }  
      ]
    }
    
    #<MX::ChallengesResponseBody
      @challenges= [
        #<MX::Challenge
          @field_name= Choose your image
          @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          @label= Which is your image?
          @options= [
            #<MX::ChallengeOption
              @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              @label= IMAGE_1
            >      
            #<MX::ChallengeOption
              @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              @label= IMAGE_2
            >      
            #<MX::ChallengeOption
              @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              @label= IMAGE_3
            >      
            #<MX::ChallengeOption
              @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
              @label= IMAGE_4
            >      
          ]
          @type= IMAGE_OPTIONS
        >  
      ]
    >
    

    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.

    Field Name Data type Description
    field_name string A non-unique identifier for the question.
    guid String A unique identifier for the credential, defined by MX.
    label String A readable question that is presented to the user.
    type String The type of credential. Supported types include TEXT, OPTIONS, TOKEN, IMAGE_DATA, IMAGE_OPTIONS.
    image_data String This field contains image data encoded as a base64 string. It will only be present when the credential type is IMAGE_DATA.
    options Array For credential types OPTIONS or IMAGE_OPTIONS, this field represents an array of choices. It will only be present when the credential type is OPTIONS or IMAGE_OPTIONS.

    Resume aggregation from MFA

    PUT /users/{user_guid}/members/{member_guid}/resume
    

    Example request

    $ curl -i -X PUT 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/resume' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member":{
              "challenges":[
                {
                   "guid": "institution-credential-guid",
                   "value": "user-entered-value"
                },
                {
                  "guid": "institution-credential-guid",
                   "value": "user-entered-value"
                }
              ]
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ResumeMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
                try
                {
                    // Resume aggregation from MFA
                    MemberResponseBody response = client.members.ResumeMember(memberGuid, userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ResumeMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberResumeRequestBody{} // MemberResumeRequestBody | Member object with MFA challenge answers
    
      response, _, err := client.Members.ResumeMember(ctx, memberGUID, userGUID, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberResumeRequestBody body = new MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
            try {
                MemberResponseBody response = client.members.resumeMember(memberGuid, userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#resumeMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
    var response = client.members.resumeMember(memberGuid, userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberResumeRequestBody(); // \atrium\model\MemberResumeRequestBody | Member object with MFA challenge answers
    
    try {
        $result = $client->members->resumeMember($member_guid, $user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->resumeMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberResumeRequestBody() # MemberResumeRequestBody | Member object with MFA challenge answers
    
    try:
        # Resume aggregation from MFA
        response = client.members.resume_member(member_guid, user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->resume_member: %s\n" % e)
    
    # 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_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->resume_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-09-30T14:31:45-06:00",
        "connection_status": "CHALLENGED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier":"unique_id",
        "institution_code": "chase",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Bank Name",
        "status": "CHALLENGED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

    List member credentials

    GET /users/{user_guid}/members/{member_guid}/credentials
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/credentials' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListMemberCredentialsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // List member credentials
                    CredentialsResponseBody response = client.members.ListMemberCredentials(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ListMemberCredentials: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ListMemberCredentials(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                CredentialsResponseBody response = client.members.listMemberCredentials(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#listMemberCredentials");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.listMemberCredentials(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->listMemberCredentials($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->listMemberCredentials: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # List member credentials
        response = client.members.list_member_credentials(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->list_member_credentials: %s\n" % e)
    
    # 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
    

    Example response

    Status 200 OK
    
    {
        "credentials": [
            {
                "field_name": "login_email",
                "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
                "label": "Email Address",
                "display_order": 0,
                "type": "LOGIN"
            },
            {
                "field_name": "login_password",
                "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
                "label": "PayPal password",
                "display_order": 1,
                "type": "PASSWORD"
            }
        ]
    }
    
    class CredentialsResponseBody {
      Credentials: [
        class CredentialResponse {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            class CredentialOption {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    {
      Credentials: [
        {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    class CredentialsResponseBody {
      credentials: [
        class CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            class CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    CredentialsResponseBody {
      credentials: [
        CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    atrium/model/CredentialsResponseBody Object (
      [credentials] => Array (
        atrium/model/CredentialResponse Object (
          [field_name] => LOGIN
          [guid] => CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          [label] => Username
          [options] => Array (
            atrium/model/CredentialOption Object (
              [label] => option_label
              [value] => option_value
            )      
          )
          [type] => LOGIN
        )  
      )
    )
    
    {
      'credentials': [
        {
          'field_name': LOGIN
          'guid': CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          'label': Username
          'options': [
            {
              'label': option_label
              'value': option_value
            }      
          ]
          'type': LOGIN
        }  
      ]
    }
    
    #<MX::CredentialsResponseBody
      @credentials= [
        #<MX::CredentialResponse
          @field_name= LOGIN
          @guid= CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          @label= Username
          @options= [
            #<MX::CredentialOption
              @label= option_label
              @value= option_value
            >      
          ]
          @type= LOGIN
        >  
      ]
    >
    

    This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.

    Field Data type Description
    display_order Integer The order in which the credential should be displayed to the end user; lower numbers should be displayed first.
    field_name String Name of the credential field for the institution, e.g., "LOGIN".
    guid String A unique identifier for the credential. Defined by MX.
    label String A label for the credential, intended to be readable by the end user, e.g., Username.
    type String A name for the type of field, e.g., PASSWORD.
    options Array See explanation that immediately follows.

    For credentials with the type OPTIONS, the credentials object will contain a nested array called options. This array lists various choices available for credential prompts, and includes further attributes.

    Field Data type Description
    label String A label for the credential prompt.
    value String A response for the credential prompt.

    List member accounts

    GET /users/{user_guid}/members/{member_guid}/accounts
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/accounts' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListMemberAccountsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List member accounts
                    AccountsResponseBody response = client.members.ListMemberAccounts(memberGuid, userGuid, page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ListMemberAccounts: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.ListMemberAccountsOpts{
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Members.ListMemberAccounts(ctx, memberGUID, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                AccountsResponseBody response = client.members.listMemberAccounts(memberGuid, userGuid, page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#listMemberAccounts");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.members.listMemberAccounts(memberGuid, userGuid, page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->members->listMemberAccounts($member_guid, $user_guid, $page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->listMemberAccounts: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List member accounts
        response = client.members.list_member_accounts(member_guid, user_guid, page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->list_member_accounts: %s\n" % e)
    
    # 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
    

    Example Response

    Status: 200 OK
    
    {
      "accounts": [
        {
          "apr": 1.0,
          "apy": 1.0,
          "available_balance": 1000.0,
          "available_credit": 100,
          "balance": 1000.0,
          "created_at": "2016-10-13T17:57:37+00:00",
          "credit_limit": 100,
          "currency_code": "USD",
          "day_payment_is_due": 20,
          "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
          "institution_code": "chase",
          "interest_rate": null,
          "is_closed": false,
          "last_payment": null,
          "last_payment_at": null,
          "matures_on": null,
          "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "minimum_balance": null,
          "minimum_payment": null,
          "name": "Test Account 2",
          "original_balance": null,
          "payment_due_at": null,
          "payoff_balance": null,
          "started_on": null,
          "subtype": null,
          "total_account_value": null,
          "type": "SAVINGS",
          "updated_at": "2016-10-13T18:08:00+00:00",
          "user_guid":  "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
        }
      ]
    }
    
    class AccountsResponseBody {
      Accounts: [
        class Account {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Accounts: [
        {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class AccountsResponseBody {
      accounts: [
        class Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    AccountsResponseBody {
      accounts: [
        Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/AccountsResponseBody Object (
      [accounts] => Array (
        atrium/model/Account Object (
          [apr] => 1.0
          [apy] => 1.0
          [available_balance] => 1000.0
          [available_credit] => 1000.0
          [balance] => 1000.0
          [cash_balance] => 1000.0
          [cash_surrender_value] => 1000.0
          [created_at] => 2016-10-13T17:57:37+00:00
          [credit_limit] => 100.0
          [currency_code] => USD
          [day_payment_is_due] => 20
          [death_benefit] => 1000.0
          [guid] => ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          [holdings_value] => 1000.0
          [institution_code] => chase
          [interest_rate] =>
          [is_closed] => false
          [last_payment] =>
          [loan_amount] => 1000.0
          [matures_on] =>
          [member_guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [minimum_balance] =>
          [minimum_payment] =>
          [name] => Test account 2
          [original_balance] =>
          [payment_due_at] =>
          [payoff_balance] =>
          [started_on] =>
          [subtype] =>
          [total_account_value] =>
          [type] => SAVINGS
          [updated_at] => 2016-10-13T18:08:00+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'accounts': [
        {
          'apr': 1.0
          'apy': 1.0
          'available_balance': 1000.0
          'available_credit': 1000.0
          'balance': 1000.0
          'cash_balance': 1000.0
          'cash_surrender_value': 1000.0
          'created_at': 2016-10-13T17:57:37+00:00
          'credit_limit': 100.0
          'currency_code': USD
          'day_payment_is_due': 20
          'death_benefit': 1000.0
          'guid': ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          'holdings_value': 1000.0
          'institution_code': chase
          'interest_rate':
          'is_closed': false
          'last_payment':
          'loan_amount': 1000.0
          'matures_on':
          'member_guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'minimum_balance':
          'minimum_payment':
          'name': Test account 2
          'original_balance':
          'payment_due_at':
          'payoff_balance':
          'started_on':
          'subtype':
          'total_account_value':
          'type': SAVINGS
          'updated_at': 2016-10-13T18:08:00+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::AccountsResponseBody
      @accounts= [
        #<MX::Account
          @apr= 1.0
          @apy= 1.0
          @available_balance= 1000.0
          @available_credit= 1000.0
          @balance= 1000.0
          @cash_balance= 1000.0
          @cash_surrender_value= 1000.0
          @created_at= 2016-10-13T17:57:37+00:00
          @credit_limit= 100.0
          @currency_code= USD
          @day_payment_is_due= 20
          @death_benefit= 1000.0
          @guid= ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          @holdings_value= 1000.0
          @institution_code= chase
          @interest_rate=
          @is_closed= false
          @last_payment=
          @loan_amount= 1000.0
          @matures_on=
          @member_guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @minimum_balance=
          @minimum_payment=
          @name= Test account 2
          @original_balance=
          @payment_due_at=
          @payoff_balance=
          @started_on=
          @subtype=
          @total_account_value=
          @type= SAVINGS
          @updated_at= 2016-10-13T18:08:00+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    This endpoint returns an array with information about every account associated with a particular member.

    List member transactions

    GET /users/{user_guid}/members/{member_guid}/transactions
    

    Example of a URL with query parameters

    GET https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/transactions?from_date=2016-09-20&to_date=2016-10-20
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/transactions' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListMemberTransactionsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var fromDate = "2016-09-20";  // string | Filter transactions from this date. (optional)
                var toDate = "2016-10-20";  // string | Filter transactions to this date. (optional)
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List member transactions
                    TransactionsResponseBody response = client.members.ListMemberTransactions(memberGuid, userGuid, fromDate, toDate, page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ListMemberTransactions: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.ListMemberTransactionsOpts{
        FromDate: optional.NewString("2016-09-20"), // string | Filter transactions from this date.
        ToDate: optional.NewString("2016-10-20"), // string | Filter transactions to this date.
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Members.ListMemberTransactions(ctx, memberGUID, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            String fromDate = "2016-09-20"; // String | Filter transactions from this date.
            String toDate = "2016-10-20"; // String | Filter transactions to this date.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                TransactionsResponseBody response = client.members.listMemberTransactions(memberGuid, userGuid, fromDate, toDate, page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#listMemberTransactions");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var fromDate = "2016-09-20"; // string | Filter transactions from this date. (optional)
    var toDate = "2016-10-20"; // string | Filter transactions to this date. (optional)
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.members.listMemberTransactions(memberGuid, userGuid, fromDate, toDate, page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $from_date = "2016-09-20"; // string | Filter transactions from this date.
    $to_date = "2016-10-20"; // string | Filter transactions to this date.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->members->listMemberTransactions($member_guid, $user_guid, $from_date, $to_date, $page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->listMemberTransactions: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    from_date = "2016-09-20" # str | Filter transactions from this date. (optional)
    to_date = "2016-10-20" # str | Filter transactions to this date. (optional)
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List member transactions
        response = client.members.list_member_transactions(member_guid, user_guid, from_date=from_date, to_date=to_date, page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->list_member_transactions: %s\n" % e)
    
    # 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
    

    Example response

    Status: 200 OK
    
    {
      "transactions": [
        {
          "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
          "amount": 61.11,
          "category": "Groceries",
          "check_number": 15234,
          "check_number_string": "00015234",
          "created_at": "2016-10-06T09:43:42+00:00",
          "currency_code": "USD",
          "date": "2013-09-23",
          "description": "Whole Foods",
          "guid": "TRN-265abee9-889b-af6a-c69b-25157db2bdd9",
          "is_bill_pay": false,
          "is_direct_deposit": false,
          "is_expense": true,
          "is_fee": false,
          "is_income": false,
          "is_international": false,
          "is_overdraft_fee": false,
          "is_payroll_advance": false,
          "latitude": -43.2075,
          "longitude": 139.691706,
          "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "memo": null,
          "merchant_category_code": 5411,
          "original_description": "WHOLEFDS TSQ 102",
          "posted_at": "2016-10-07T06:00:00+00:00",
          "status": "POSTED",
          "top_level_category": "Food & Dining",
          "transacted_at": "2016-10-06T13:00:00+00:00",
          "type": "DEBIT",
          "updated_at": "2016-10-07T05:49:12+00:00",
          "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
        }
      ]
    }
    
    class TransactionsResponseBody {
      Transactions: [
        class Transaction {
          AccountGuid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          Amount: 61.11
          Category: Groceries
          CheckNumber: 15234
          CheckNumberString: 00015234
          CreatedAt: 2016-10-06T09:43:42+00:00
          CurrencyCode: USD
          Date: 2013-09-23
          Description: Whole foods
          Guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          IsBillPay: false
          IsDirectDeposit: false
          IsExpense: true
          IsFee: false
          IsIncome: false
          IsInternational: false
          IsOverdraftFee: false
          IsPayrollAdvance: false
          Latitude: -43.2075
          Longitude: 139.691706
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Memo:
          MerchantCategoryCode: 5411
          OriginalDescription: WHOLEFDS TSQ 102
          PostedAt: 2016-10-07T06:00:00+00:00
          Status: POSTED
          TopLevelCategory: Food & Dining
          TransactedAt: 2016-10-06T13:00:00+00:00
          Type: DEBIT
          UpdatedAt: 2016-10-07T05:49:12+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Transactions: [
        {
          AccountGuid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          Amount: 61.11
          Category: Groceries
          CheckNumber: 15234
          CheckNumberString: 00015234
          CreatedAt: 2016-10-06T09:43:42+00:00
          CurrencyCode: USD
          Date: 2013-09-23
          Description: Whole foods
          Guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          IsBillPay: false
          IsDirectDeposit: false
          IsExpense: true
          IsFee: false
          IsIncome: false
          IsInternational: false
          IsOverdraftFee: false
          IsPayrollAdvance: false
          Latitude: -43.2075
          Longitude: 139.691706
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Memo:
          MerchantCategoryCode: 5411
          OriginalDescription: WHOLEFDS TSQ 102
          PostedAt: 2016-10-07T06:00:00+00:00
          Status: POSTED
          TopLevelCategory: Food & Dining
          TransactedAt: 2016-10-06T13:00:00+00:00
          Type: DEBIT
          UpdatedAt: 2016-10-07T05:49:12+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class TransactionsResponseBody {
      transactions: [
        class Transaction {
          accountGuid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          amount: 61.11
          category: Groceries
          checkNumber: 15234
          checkNumberString: 00015234
          createdAt: 2016-10-06T09:43:42+00:00
          currencyCode: USD
          date: 2013-09-23
          description: Whole foods
          guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          isBillPay: false
          isDirectDeposit: false
          isExpense: true
          isFee: false
          isIncome: false
          isInternational: false
          isOverdraftFee: false
          isPayrollAdvance: false
          latitude: -43.2075
          longitude: 139.691706
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          memo:
          merchantCategoryCode: 5411
          originalDescription: WHOLEFDS TSQ 102
          postedAt: 2016-10-07T06:00:00+00:00
          status: POSTED
          topLevelCategory: Food & Dining
          transactedAt: 2016-10-06T13:00:00+00:00
          type: DEBIT
          updatedAt: 2016-10-07T05:49:12+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    TransactionsResponseBody {
      transactions: [
        Transaction {
          accountGuid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          amount: 61.11
          category: Groceries
          checkNumber: 15234
          checkNumberString: 00015234
          createdAt: 2016-10-06T09:43:42+00:00
          currencyCode: USD
          date: 2013-09-23
          description: Whole foods
          guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          isBillPay: false
          isDirectDeposit: false
          isExpense: true
          isFee: false
          isIncome: false
          isInternational: false
          isOverdraftFee: false
          isPayrollAdvance: false
          latitude: -43.2075
          longitude: 139.691706
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          memo:
          merchantCategoryCode: 5411
          originalDescription: WHOLEFDS TSQ 102
          postedAt: 2016-10-07T06:00:00+00:00
          status: POSTED
          topLevelCategory: Food & Dining
          transactedAt: 2016-10-06T13:00:00+00:00
          type: DEBIT
          updatedAt: 2016-10-07T05:49:12+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/TransactionsResponseBody Object (
      [transactions] => Array (
        atrium/model/Transaction Object (
          [account_guid] => ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          [amount] => 61.11
          [category] => Groceries
          [check_number] => 15234
          [check_number_string] => 00015234
          [created_at] => 2016-10-06T09:43:42+00:00
          [currency_code] => USD
          [date] => 2013-09-23
          [description] => Whole foods
          [guid] => TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          [is_bill_pay] => false
          [is_direct_deposit] => false
          [is_expense] => true
          [is_fee] => false
          [is_income] => false
          [is_international] => false
          [is_overdraft_fee] => false
          [is_payroll_advance] => false
          [latitude] => -43.2075
          [longitude] => 139.691706
          [member_guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [memo] =>
          [merchant_category_code] => 5411
          [original_description] => WHOLEFDS TSQ 102
          [posted_at] => 2016-10-07T06:00:00+00:00
          [status] => POSTED
          [top_level_category] => Food & Dining
          [transacted_at] => 2016-10-06T13:00:00+00:00
          [type] => DEBIT
          [updated_at] => 2016-10-07T05:49:12+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'transactions': [
        {
          'account_guid': ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          'amount': 61.11
          'category': Groceries
          'check_number': 15234
          'check_number_string': 00015234
          'created_at': 2016-10-06T09:43:42+00:00
          'currency_code': USD
          'date': 2013-09-23
          'description': Whole foods
          'guid': TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          'is_bill_pay': false
          'is_direct_deposit': false
          'is_expense': true
          'is_fee': false
          'is_income': false
          'is_international': false
          'is_overdraft_fee': false
          'is_payroll_advance': false
          'latitude': -43.2075
          'longitude': 139.691706
          'member_guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'memo':
          'merchant_category_code': 5411
          'original_description': WHOLEFDS TSQ 102
          'posted_at': 2016-10-07T06:00:00+00:00
          'status': POSTED
          'top_level_category': Food & Dining
          'transacted_at': 2016-10-06T13:00:00+00:00
          'type': DEBIT
          'updated_at': 2016-10-07T05:49:12+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::TransactionsResponseBody
      @transactions= [
        #<MX::Transaction
          @account_guid= ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          @amount= 61.11
          @category= Groceries
          @check_number= 15234
          @check_number_string= 00015234
          @created_at= 2016-10-06T09:43:42+00:00
          @currency_code= USD
          @date= 2013-09-23
          @description= Whole foods
          @guid= TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          @is_bill_pay= false
          @is_direct_deposit= false
          @is_expense= true
          @is_fee= false
          @is_income= false
          @is_international= false
          @is_overdraft_fee= false
          @is_payroll_advance= false
          @latitude= -43.2075
          @longitude= 139.691706
          @member_guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @memo=
          @merchant_category_code= 5411
          @original_description= WHOLEFDS TSQ 102
          @posted_at= 2016-10-07T06:00:00+00:00
          @status= POSTED
          @top_level_category= Food & Dining
          @transacted_at= 2016-10-06T13:00:00+00:00
          @type= DEBIT
          @updated_at= 2016-10-07T05:49:12+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    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.

    Accounts

    An account represents a financial account held by a financial institution, e.g., a user's checking or savings account. An account belongs to a member, which represents the user's overall relationship with a particular financial institution. A checking account may be just one part of a larger relationship that could also include a car loan and a savings account.

    Endpoint Method Description
    /users/{user_guid}/accounts GET Returns a list of all accounts that belong to a particular user.
    /users/{user_guid}/accounts/{account_guid} GET Returns information about a particular account.
    /users/{user_guid}/members/{member_guid}/accounts/{account_guid} GET Returns information about a particular account.
    /users/{user_guid}/accounts/{account_guid}/transactions GET Returns a list of transactions that belong to a particular account.

    Read an account

    Endpoint 1: GET /users/{user_guid}/accounts/{account_guid}

    Endpoint 2: GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadAccountExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var accountGuid = "ACT-123";  // string | The unique identifier for an `account`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read an account
                    AccountResponseBody response = client.accounts.ReadAccount(accountGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling AccountsApi.ReadAccount: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      accountGUID := "ACT-123" // string | The unique identifier for an `account`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Accounts.ReadAccount(ctx, accountGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class AccountsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String accountGuid = "ACT-123"; // String | The unique identifier for an `account`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                AccountResponseBody response = client.accounts.readAccount(accountGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccountsApi#readAccount");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var accountGuid = "ACT-123"; // string | The unique identifier for an `account`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.accounts.readAccount(accountGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $account_guid = "ACT-123"; // string | The unique identifier for an `account`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->accounts->readAccount($account_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccountsApi->readAccount: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    account_guid = "ACT-123" # str | The unique identifier for an `account`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read an account
        response = client.accounts.read_account(account_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling AccountsApi->read_account: %s\n" % e)
    
    # load the gem
    require '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`.
    
    begin
      #Read an account
      response = client.accounts.read_account(account_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling AccountsApi->read_account: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "account": {
        "apr": 1.0,
        "apy": 1.0,
        "available_balance": 1000.0,
        "available_credit": 100,
        "balance": 1000.0,
        "cash_balance": 1000.0,
        "cash_surrender_value": 1000.0,
        "created_at": "2016-10-13T17:57:37+00:00",
        "credit_limit": 100,
        "currency_code": "USD",
        "day_payment_is_due": 20,
        "death_benefit": 1000.0,
        "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
        "holdings_value": 1000.0,
        "institution_code": "chase",
        "interest_rate": null,
        "is_closed": false,
        "last_payment": null,
        "last_payment_at": null,
        "loan_amount": null,
        "matures_on": null,
        "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "minimum_balance": null,
        "minimum_payment": null,
        "name": "Test Account 2",
        "original_balance": null,
        "payment_due_at": null,
        "payoff_balance": null,
        "started_on": null,
        "subtype": null,
        "total_account_value": null,
        "type": "SAVINGS",
        "updated_at": "2016-10-13T18:08:00+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class AccountResponseBody {
      Account:
        class Account {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Account:
        {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class AccountResponseBody {
      account:
        class Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    AccountResponseBody {
      account:
        Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/AccountResponseBody Object (
      [account] =>
        atrium/model/Account Object (
          [apr] => 1.0
          [apy] => 1.0
          [available_balance] => 1000.0
          [available_credit] => 1000.0
          [balance] => 1000.0
          [cash_balance] => 1000.0
          [cash_surrender_value] => 1000.0
          [created_at] => 2016-10-13T17:57:37+00:00
          [credit_limit] => 100.0
          [currency_code] => USD
          [day_payment_is_due] => 20
          [death_benefit] => 1000.0
          [guid] => ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          [holdings_value] => 1000.0
          [institution_code] => chase
          [interest_rate] =>
          [is_closed] => false
          [last_payment] =>
          [loan_amount] => 1000.0
          [matures_on] =>
          [member_guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [minimum_balance] =>
          [minimum_payment] =>
          [name] => Test account 2
          [original_balance] =>
          [payment_due_at] =>
          [payoff_balance] =>
          [started_on] =>
          [subtype] =>
          [total_account_value] =>
          [type] => SAVINGS
          [updated_at] => 2016-10-13T18:08:00+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'account':
        {
          'apr': 1.0
          'apy': 1.0
          'available_balance': 1000.0
          'available_credit': 1000.0
          'balance': 1000.0
          'cash_balance': 1000.0
          'cash_surrender_value': 1000.0
          'created_at': 2016-10-13T17:57:37+00:00
          'credit_limit': 100.0
          'currency_code': USD
          'day_payment_is_due': 20
          'death_benefit': 1000.0
          'guid': ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          'holdings_value': 1000.0
          'institution_code': chase
          'interest_rate':
          'is_closed': false
          'last_payment':
          'loan_amount': 1000.0
          'matures_on':
          'member_guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'minimum_balance':
          'minimum_payment':
          'name': Test account 2
          'original_balance':
          'payment_due_at':
          'payoff_balance':
          'started_on':
          'subtype':
          'total_account_value':
          'type': SAVINGS
          'updated_at': 2016-10-13T18:08:00+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::AccountResponseBody
      @account=
        #<MX::Account
          @apr= 1.0
          @apy= 1.0
          @available_balance= 1000.0
          @available_credit= 1000.0
          @balance= 1000.0
          @cash_balance= 1000.0
          @cash_surrender_value= 1000.0
          @created_at= 2016-10-13T17:57:37+00:00
          @credit_limit= 100.0
          @currency_code= USD
          @day_payment_is_due= 20
          @death_benefit= 1000.0
          @guid= ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          @holdings_value= 1000.0
          @institution_code= chase
          @interest_rate=
          @is_closed= false
          @last_payment=
          @loan_amount= 1000.0
          @matures_on=
          @member_guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @minimum_balance=
          @minimum_payment=
          @name= Test account 2
          @original_balance=
          @payment_due_at=
          @payoff_balance=
          @started_on=
          @subtype=
          @total_account_value=
          @type= SAVINGS
          @updated_at= 2016-10-13T18:08:00+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.

    There are two endpoints for reading an account. Both will return the same information.

    It's important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts.

    An asset account, e.g., CHECKING, SAVINGS, or INVESTMENT, will have a positive balance unless it is in an overdraft condition, in which case the balance will be negative.

    On the other hand, a debt account, e.g., CREDIT CARD, LOAN, MORTGAGE, would have a positivebalance when the user owes money on the account. It would have a negative balance if the account has been overpaid.

    Field name Data type Description
    apr Decimal Annual Percentage Rate. Max length is 10,6.
    apy Decimal Annual Percentage Yield. Max length is 10,6.
    available_balance Decimal The balance currently available in an account. Max length is 14,2.
    available_credit Decimal The currently available credit balance of an account. This field is for accounts with types CREDIT CARD and LINE OF CREDIT.
    balance Decimal An account's current balance. Max length is 14,2.
    cash_balance Decimal The cash balance of the account. Max length is 14,2.
    cash_surrender_value Decimal The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs. Max length is 14,2.
    created_at String The date and time the account was created.
    credit_limit Decimal The credit limit for the account. Max length is 10,2.
    currency_code String The three-character ISO 4217 currency code, e.g. USD.
    day_payment_is_due Integer The day of the month the payment is due. Max length is 2. So, for example, the 14th is passed as 14).
    death_benefit Decimal Amount paid to the beneficiary of the account upon death of the account owner. Max length is 14,2.
    guid String Unique identifier for the account. Defined by MX.
    holdings_value Decimal The value of the holdings associated with the account.
    institution_code String Unique identifier for the financial institution which holds the account. Defined by MX.
    interest_rate Decimal Interest rate. Max length is 10,6.
    is_closed Boolean If an account is closed, this field will be true. Otherwise, this field will be false.
    last_payment Decimal The amount of the last payment made on a debt account, such as an account of type CREDIT CARD or MORTGAGE. Max length is 10,2.
    last_payment_at String The date and time the last payment toward a debt account was applied.
    loan_amount Decimal The amount of the loan. Max length is 14,2.
    matures_on String Date on which an account matures.
    member_guid String Unique identifier for the member to which this account belongs. Defined by MX.
    minimum_balance Decimal Minimum required balance for the account. This is normally a positive number. Max length is 14,2.
    minimum_payment Decimal The minimum payment required for an account. This can apply to any debt account. Max length is 10,2.
    name String This must be a human-readable name for the account. It will be visible to the user.
    original_balance Decimal The original balance on an account. This will be a positive value. Max length is 14,2.
    payment_due_at String The Date and time the next payment on a debt account is due.
    payoff_balance Decimal Payoff Balance (positive value normally). Can apply to any debt account. Max length is 14,2.
    started_on String The date on which a debt account was started.
    subtype String The account's subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY.
    total_account_value Decimal The total value of the account. Max length is 14,2.
    type String The main type of an account, e.g., INVESTMENT, PREPAID, or SAVINGS.
    updated_at String The date and time at which the account was last updated.
    user_guid String A unique identifier for the user to which the account belongs. Defined by MX.

    List accounts for a user

    Endpoint: GET /users/{user_guid}/accounts

    Example request:

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/accounts' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListUserAccountsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List accounts for a user
                    AccountsResponseBody response = client.accounts.ListUserAccounts(userGuid, page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling AccountsApi.ListUserAccounts: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.ListUserAccountsOpts{
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Accounts.ListUserAccounts(ctx, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class AccountsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                AccountsResponseBody response = client.accounts.listUserAccounts(userGuid, page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccountsApi#listUserAccounts");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.accounts.listUserAccounts(userGuid, page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->accounts->listUserAccounts($user_guid, $page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccountsApi->listUserAccounts: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List accounts for a user
        response = client.accounts.list_user_accounts(user_guid, page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling AccountsApi->list_user_accounts: %s\n" % e)
    
    # 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 accounts for a user
      response = client.accounts.list_user_accounts(user_guid, opts)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling AccountsApi->list_user_accounts: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "accounts": [
        {
          "apr": 1.0,
          "apy": 1.0,
          "available_balance": 1000.0,
          "available_credit": 100,
          "balance": 1000.0,
          "cash_balance": 1000.0,
          "cash_surrender_value": 1000.0,
          "created_at": "2016-10-13T17:57:37+00:00",
          "credit_limit": 100,
          "currency_code": "USD",
          "day_payment_is_due": 20,
          "death_benefit": 1000.0,
          "guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
          "holdings_value": 1000.0,
          "institution_code": "chase",
          "interest_rate": null,
          "is_closed": false,
          "last_payment": null,
          "last_payment_at": null,
          "loan_amount": null,
          "matures_on": null,
          "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "minimum_balance": null,
          "minimum_payment": null,
          "name": "Test Account 2",
          "original_balance": null,
          "payment_due_at": null,
          "payoff_balance": null,
          "started_on": null,
          "subtype": null,
          "total_account_value": null,
          "type": "SAVINGS",
          "updated_at": "2016-10-13T18:08:00+00:00",
          "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
        }
      ]
    }
    
    class AccountsResponseBody {
      Accounts: [
        class Account {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Accounts: [
        {
          Apr: 1.0
          Apy: 1.0
          AvailableBalance: 1000.0
          AvailableCredit: 1000.0
          Balance: 1000.0
          CashBalance: 1000.0
          CashSurrenderValue: 1000.0
          CreatedAt: 2016-10-13T17:57:37+00:00
          CreditLimit: 100.0
          CurrencyCode: USD
          DayPaymentIsDue: 20
          DeathBenefit: 1000.0
          Guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          HoldingsValue: 1000.0
          InstitutionCode: chase
          InterestRate:
          IsClosed: false
          LastPayment:
          LoanAmount: 1000.0
          MaturesOn:
          MemberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          MinimumBalance:
          MinimumPayment:
          Name: Test account 2
          OriginalBalance:
          PaymentDueAt:
          PayoffBalance:
          StartedOn:
          Subtype:
          TotalAccountValue:
          Type: SAVINGS
          UpdatedAt: 2016-10-13T18:08:00+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class AccountsResponseBody {
      accounts: [
        class Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    AccountsResponseBody {
      accounts: [
        Account {
          apr: 1.0
          apy: 1.0
          availableBalance: 1000.0
          availableCredit: 1000.0
          balance: 1000.0
          cashBalance: 1000.0
          cashSurrenderValue: 1000.0
          createdAt: 2016-10-13T17:57:37+00:00
          creditLimit: 100.0
          currencyCode: USD
          dayPaymentIsDue: 20
          deathBenefit: 1000.0
          guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          holdingsValue: 1000.0
          institutionCode: chase
          interestRate:
          isClosed: false
          lastPayment:
          loanAmount: 1000.0
          maturesOn:
          memberGuid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          minimumBalance:
          minimumPayment:
          name: Test account 2
          originalBalance:
          paymentDueAt:
          payoffBalance:
          startedOn:
          subtype:
          totalAccountValue:
          type: SAVINGS
          updatedAt: 2016-10-13T18:08:00+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/AccountsResponseBody Object (
      [accounts] => Array (
        atrium/model/Account Object (
          [apr] => 1.0
          [apy] => 1.0
          [available_balance] => 1000.0
          [available_credit] => 1000.0
          [balance] => 1000.0
          [cash_balance] => 1000.0
          [cash_surrender_value] => 1000.0
          [created_at] => 2016-10-13T17:57:37+00:00
          [credit_limit] => 100.0
          [currency_code] => USD
          [day_payment_is_due] => 20
          [death_benefit] => 1000.0
          [guid] => ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          [holdings_value] => 1000.0
          [institution_code] => chase
          [interest_rate] =>
          [is_closed] => false
          [last_payment] =>
          [loan_amount] => 1000.0
          [matures_on] =>
          [member_guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [minimum_balance] =>
          [minimum_payment] =>
          [name] => Test account 2
          [original_balance] =>
          [payment_due_at] =>
          [payoff_balance] =>
          [started_on] =>
          [subtype] =>
          [total_account_value] =>
          [type] => SAVINGS
          [updated_at] => 2016-10-13T18:08:00+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'accounts': [
        {
          'apr': 1.0
          'apy': 1.0
          'available_balance': 1000.0
          'available_credit': 1000.0
          'balance': 1000.0
          'cash_balance': 1000.0
          'cash_surrender_value': 1000.0
          'created_at': 2016-10-13T17:57:37+00:00
          'credit_limit': 100.0
          'currency_code': USD
          'day_payment_is_due': 20
          'death_benefit': 1000.0
          'guid': ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          'holdings_value': 1000.0
          'institution_code': chase
          'interest_rate':
          'is_closed': false
          'last_payment':
          'loan_amount': 1000.0
          'matures_on':
          'member_guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'minimum_balance':
          'minimum_payment':
          'name': Test account 2
          'original_balance':
          'payment_due_at':
          'payoff_balance':
          'started_on':
          'subtype':
          'total_account_value':
          'type': SAVINGS
          'updated_at': 2016-10-13T18:08:00+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::AccountsResponseBody
      @accounts= [
        #<MX::Account
          @apr= 1.0
          @apy= 1.0
          @available_balance= 1000.0
          @available_credit= 1000.0
          @balance= 1000.0
          @cash_balance= 1000.0
          @cash_surrender_value= 1000.0
          @created_at= 2016-10-13T17:57:37+00:00
          @credit_limit= 100.0
          @currency_code= USD
          @day_payment_is_due= 20
          @death_benefit= 1000.0
          @guid= ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          @holdings_value= 1000.0
          @institution_code= chase
          @interest_rate=
          @is_closed= false
          @last_payment=
          @loan_amount= 1000.0
          @matures_on=
          @member_guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @minimum_balance=
          @minimum_payment=
          @name= Test account 2
          @original_balance=
          @payment_due_at=
          @payoff_balance=
          @started_on=
          @subtype=
          @total_account_value=
          @type= SAVINGS
          @updated_at= 2016-10-13T18:08:00+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    Use this endpoint to view information about every account that belongs to a user. You'll need the user's GUID to access this list. The information will include the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the account balance, the date the account was started, etc.

    List account transactions

    Endpoint: GET /users/{user_guid}/accounts/{account_guid}/transactions

    Example URL with query parameters: https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}/transactions?from_date=2016-09-20&to_date=2016-10-20

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/accounts/{account_guid}/transactions' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListAccountTransactionsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var accountGuid = "ACT-123";  // string | The unique identifier for an `account`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var fromDate = "2016-09-20";  // string | Filter transactions from this date. (optional)
                var toDate = "2016-10-20";  // string | Filter transactions to this date. (optional)
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List account transactions
                    TransactionsResponseBody response = client.accounts.ListAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling AccountsApi.ListAccountTransactions: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      accountGUID := "ACT-123" // string | The unique identifier for an `account`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      opts := &atrium.ListAccountTransactionsOpts{
        FromDate: optional.NewString("2016-09-20"), // string | Filter transactions from this date.
        ToDate: optional.NewString("2016-10-20"), // string | Filter transactions to this date.
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Accounts.ListAccountTransactions(ctx, accountGUID, userGUID, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class AccountsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String accountGuid = "ACT-123"; // String | The unique identifier for an `account`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            String fromDate = "2016-09-20"; // String | Filter transactions from this date.
            String toDate = "2016-10-20"; // String | Filter transactions to this date.
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                TransactionsResponseBody response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccountsApi#listAccountTransactions");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var accountGuid = "ACT-123"; // string | The unique identifier for an `account`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var fromDate = "2016-09-20"; // string | Filter transactions from this date. (optional)
    var toDate = "2016-10-20"; // string | Filter transactions to this date. (optional)
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $account_guid = "ACT-123"; // string | The unique identifier for an `account`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $from_date = "2016-09-20"; // string | Filter transactions from this date.
    $to_date = "2016-10-20"; // string | Filter transactions to this date.
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->accounts->listAccountTransactions($account_guid, $user_guid, $from_date, $to_date, $page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccountsApi->listAccountTransactions: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    account_guid = "ACT-123" # str | The unique identifier for an `account`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    from_date = "2016-09-20" # str | Filter transactions from this date. (optional)
    to_date = "2016-10-20" # str | Filter transactions to this date. (optional)
    page =