Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 4.71 KB

InstitutionsApi.md

File metadata and controls

128 lines (92 loc) · 4.71 KB

Atrium::InstitutionsApi

Method HTTP request Description
list_institutions GET /institutions List institutions
read_institution GET /institutions/{institution_code} Read institution
read_institution_credentials GET /institutions/{institution_code}/credentials Read institution credentials

list_institutions

InstitutionsResponseBody list_institutions(opts)

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.

Example

# 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

Parameters

Name Type Description Notes
name String This will list only institutions in which the appended string appears. [optional]
page Integer Specify current page. [optional]
records_per_page Integer Specify records per page. [optional]
supports_account_identification BOOLEAN Filter only institutions which support account identification. [optional]
supports_account_statement BOOLEAN Filter only institutions which support account statements. [optional]
supports_account_verification BOOLEAN Filter only institutions which support account verification. [optional]
supports_transaction_history BOOLEAN Filter only institutions which support extended transaction history. [optional]

Return type

InstitutionsResponseBody

read_institution

InstitutionResponseBody read_institution(institution_code)

Read institution

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

Example

# 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

Parameters

Name Type Description Notes
institution_code String The institution_code of the institution.

Return type

InstitutionResponseBody

read_institution_credentials

CredentialsResponseBody read_institution_credentials(institution_code)

Read institution credentials

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

Example

# 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

Parameters

Name Type Description Notes
institution_code String The institution_code of the institution.

Return type

CredentialsResponseBody