plaid v1.8.0 Plaid.Item View Source
Functions for Plaid item
endpoint.
Link to this section Summary
Functions
Creates a processor token used to create an authenticated funding source with Dwolla.
Creates a public token. To be used to put Plaid Link into update mode.
Creates a stripe bank account token used to create an authenticated funding source with Stripe.
Deletes an Item.
Exchanges a public token for an access token and item id.
Gets an Item.
Invalidates access token and returns a new one.
Updates a V1 access token to V2.
Updates an Item's webhook.
Link to this section Types
Link to this section Functions
create_processor_token(params, config \\ %{})
View Sourcecreate_processor_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Creates a processor token used to create an authenticated funding source with Dwolla.
Parameters
%{access_token: "access-env-identifier", account_id: "plaid-account-id"}
Response
{:ok, %{processor_token: "some-token", request_id: "k522f2"}}
create_public_token(params, config \\ %{})
View Sourcecreate_public_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Creates a public token. To be used to put Plaid Link into update mode.
Parameters
%{access_token: "access-env-identifier"}
Response
{:ok, %{public_token: "access-env-identifier", expiration: 3600, request_id: "kg414f"}}
create_stripe_bank_account_token(params, config \\ %{})
View Sourcecreate_stripe_bank_account_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Creates a stripe bank account token used to create an authenticated funding source with Stripe.
Parameters
%{access_token: "access-env-identifier", account_id: "plaid-account-id"}
Response
{:ok, %{stripe_bank_account_token: "btok_Kb62HbBqrrvdf8pBsAdt", request_id: "[Unique request ID]"}}
delete(params, config \\ %{})
View Sourcedelete(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Deletes an Item.
Parameters
%{access_token: "access-env-identifier"}
exchange_public_token(params, config \\ %{})
View Sourceexchange_public_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Exchanges a public token for an access token and item id.
Parameters
%{public_token: "public-env-identifier"}
Response
{:ok, %{access_token: "access-env-identifier", item_id: "some-id", request_id: "f24wfg"}}
get(params, config \\ %{})
View Sourceget(params(), config() | nil) :: {:ok, Plaid.Item.t()} | {:error, Plaid.Error.t()}
Gets an Item.
Parameters
%{access_token: "access-env-identifier"}
rotate_access_token(params, config \\ %{})
View Sourcerotate_access_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Invalidates access token and returns a new one.
Parameters
%{access_token: "access-env-identifier"}
Response
{:ok, %{new_access_token: "access-env-identifier", request_id: "gag8fs"}}
update_version_access_token(params, config \\ %{})
View Sourceupdate_version_access_token(params(), config() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}
Updates a V1 access token to V2.
Parameters
%{access_token_v1: "test_wells"}
Response
{:ok, %{access_token: "access-env-identifier", item_id: "some-id", request_id: "f24wfg"}}
update_webhook(params, config \\ %{})
View Sourceupdate_webhook(params(), config() | nil) :: {:ok, Plaid.Item.t()} | {:error, Plaid.Error.t()}
Updates an Item's webhook.
Parameters
%{access_token: "access-env-identifier", webhook: "http://mywebsite/api"}