Institutions supported by Plaid: list, fetch one by id, and search by name. Country codes are ISO-3166-1 alpha-2 ("US", "CA", "GB", ...).

Functions

get-institution

fn (institution-id: Str, country-codes: Vec<Str>): Map
fn (institution-id: Str, country-codes: Vec<Str>, options: Map?): Map
fn (institution-id: Str, country-codes: Vec<Str>, options: Map?, opts: Map): Map

POST /institutions/get_by_id: one institution (ins_...). Options: include_optional_metadata, include_status (per-product health), include_auth_metadata. Returns {institution}.

Example

out ::plaid::institutions/get-institution("ins_109508", ["US"], {include_status: true})
out.institution.name

get-institutions

fn (count: Int, offset: Int, country-codes: Vec<Str>): Map
fn (count: Int, offset: Int, country-codes: Vec<Str>, options: Map?): Map
fn (count: Int, offset: Int, country-codes: Vec<Str>, options: Map?, opts: Map): Map

POST /institutions/get: a page of institutions. count is 1-500, offset starts at 0. Options (Plaid's options object): products, routing_numbers, oauth, include_optional_metadata (logo, colour, URL), include_auth_metadata. Returns {institutions, total}.

Example

page ::plaid::institutions/get-institutions(100, 0, ["US"], {include_optional_metadata: true})
map(page.institutions, %.name)

search-institutions

fn (query: Str, products: Vec<Str>?, country-codes: Vec<Str>): Map
fn (query: Str, products: Vec<Str>?, country-codes: Vec<Str>, options: Map?): Map
fn (query: Str, products: Vec<Str>?, country-codes: Vec<Str>, options: Map?, opts: Map): Map

POST /institutions/search: institutions whose name matches query. products filters to institutions supporting all of them (null for any). Options: oauth, include_optional_metadata, include_auth_metadata. Returns {institutions}.

Example

hits ::plaid::institutions/search-institutions("chase", ["transactions"], ["US"])