Plaid.Item (elixir_plaid v0.1.0) View Source
Plaid Item API calls and schema.
Link to this section Summary
Link to this section Types
Specs
Link to this section Functions
Specs
get(String.t(), Plaid.config()) :: {:ok, Plaid.Item.GetResponse.t()} | {:error, Plaid.Error.t()}
Get information about an item.
Does a POST /item/get
call which returns information about an item and
its status.
Params
access_token
- The access token associated with the item.
Examples
Item.get("access-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Item.GetResponse{}}
Specs
remove(String.t(), Plaid.config()) :: {:ok, Plaid.SimpleResponse.t()} | {:error, Plaid.Error.t()}
Removes an item.
Does a POST /item/remove
call to remove an item.
Params
access_token
- The access token associated with the item.
Examples
Item.remove("access-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Plaid.SimpleResponse{}}
Specs
update_webhook(String.t(), String.t(), Plaid.config()) :: {:ok, Plaid.Item.UpdateWebhookResponse.t()} | {:error, Plaid.Error.t()}
Update a webhook for an access_token.
Does a POST /item/webhook/update
call which is used to update webhook
for a particular access_token.
Params
access_token
- The access token associated with the item.webhook
- The new webhook URL.
Examples
Item.update_webhook(
"access-prod-123xxx",
"https://plaid.com/fake/webhook",
client_id: "123",
secret: "abc"
)
{:ok, %Plaid.UpdateWebhookResponse{}}