Class: Atrium::InstitutionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/api/institutions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstitutionsApi

Returns a new instance of InstitutionsApi.



15
16
17
 
# File 'lib/atrium-ruby/api/institutions_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/atrium-ruby/api/institutions_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#list_institutions(opts = {}) ⇒ InstitutionsResponseBody

List institutions 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 an optional query string, name=string. This will list only institutions in which the appended string appears.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    This will list only institutions in which the appended string appears.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

  • :supports_account_identification (BOOLEAN) —

    Filter only institutions which support account identification.

  • :supports_account_statement (BOOLEAN) —

    Filter only institutions which support account statements.

  • :supports_account_verification (BOOLEAN) —

    Filter only institutions which support account verification.

  • :supports_transaction_history (BOOLEAN) —

    Filter only institutions which support extended transaction history.

Returns:



29
30
31
32
 
# File 'lib/atrium-ruby/api/institutions_api.rb', line 29

def list_institutions(opts = {})
  data, _status_code, _headers = list_institutions_with_http_info(opts)
  data
end

#read_institution(institution_code, opts = {}) ⇒ InstitutionResponseBody

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

Parameters:

  • institution_code —

    The institution_code of the institution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/atrium-ruby/api/institutions_api.rb', line 39

def read_institution(institution_code, opts = {})
  data, _status_code, _headers = read_institution_with_http_info(institution_code, opts)
  data
end

#read_institution_credentials(institution_code, opts = {}) ⇒ CredentialsResponseBody

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

Parameters:

  • institution_code —

    The institution_code of the institution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



49
50
51
52
 
# File 'lib/atrium-ruby/api/institutions_api.rb', line 49

def read_institution_credentials(institution_code, opts = {})
  data, _status_code, _headers = read_institution_credentials_with_http_info(institution_code, opts)
  data
end