Plaid.Sandbox.reset_item_login

You're seeing just the function reset_item_login, go back to Plaid.Sandbox module for more information.
Link to this function

reset_item_login(access_token, config)

View Source

Specs

reset_item_login(String.t(), Plaid.config()) ::
  {:ok, Plaid.Sandbox.ResetItemLoginResponse.t()} | {:error, Plaid.Error.t()}

Force an item into a "login required" state.

Does a POST /sandbox/item/reset_login call which forces an item into the ITEM_LOGIN_REQUIRED state to simulate and item whose login is no longer valid.

Params:

  • access_token - The access token associated with the Item to reset the login for.

Examples

Sandbox.reset_item_login("access-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Sandbox.ResetItemLoginResponse{}}