plaid / plaid-ruby

Ruby bindings for Plaid

Home Page:https://plaid.com/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Institutions endpoint returns error when requesting include_institution_data flag

connor-odoherty opened this issue · comments

When attempting to to use the institutions endpoint to grab optional metadata like so:

client.institutions.get count: 1,
                                     offset: 1,
                                     country_codes: ['US'], 
                                     options: { products: ['transactions'],
                                                      include_optional_metadata: true }

the API responds with an error:

Error Type      : INVALID_REQUEST
Error Code      : INVALID_FIELD
Error Message   : This endpoint does not support include_optional_metadata.

According to the documentation here and the tests defined here, this should be a valid request.

Is there an undocumented restriction on that flag? I am in the sandbox env, is this only available in development and production?

commented

@connor-odoherty I apologize that this issue slipped through the cracks and that it took us such a long time to get back to you. I looked into it and it turns out that using this flag may require your account to be specially enabled for it by your Plaid account manager. I will make sure that our documentation is updated to reflect this fact.