Specs

create_stripe_bank_account_token(String.t(), String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.CreateStripeBankAccountTokenResponse.t()}
  | {:error, Plaid.Error.t()}

Creates a stripe bank account token from an access_token.

Does a POST /processor/stripe/bank_account_token/create call which generates a stripe bank account token for a given account ID.

Params:

• access_token - access_token to create a processor token for.
• account_id - ID of the account to create a processor token for.

examples

Examples

Processor.create_stripe_bank_account_token("access-prod-123xxx", "blejdkalk3kdlsl", client_id: "123", secret: "abc")
{:ok, %Processor.CreateStripeBankAccountTokenResponse{}}

Specs

create_token(String.t(), String.t(), String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.CreateTokenResponse.t()} | {:error, Plaid.Error.t()}

Creates a processor token from an access_token.

Does a POST /processor/token/create call which generates any non-stripe processor token for a given account ID.

Params:

• access_token - access_token to create a processor token for.
• account_id - ID of the account to create a processor token for.
• processor - name of the processor to create a token for.

examples

Examples

Processor.create_token("access-prod-123xxx", "blejdkalk3kdlsl", "galileo", client_id: "123", secret: "abc")
{:ok, %Processor.CreateTokenResponse{}}

Specs

get_auth(String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.GetAuthResponse.t()} | {:error, Plaid.Error.t()}

Get the bank account info given a processor_token.

Does a POST /processor/auth/get call which returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's associated with a given processor_token.

Params:

• processor_token - The processor token obtained from the Plaid integration partner.

examples

Examples

Processor.get_auth("processor-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Processor.GetAuthResponse{}}

Specs

get_balance(String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.GetBalanceResponse.t()} | {:error, Plaid.Error.t()}

Get real-time balance for each of an Item's accounts.

Does a POST /processor/balance/get call which returns the balance for each of a Item's accounts.

While other endpoints may return a balance object, only /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.

Params:

• processor_token - The processor token obtained from the Plaid integration partner.

examples

Examples

Processor.get_balance("processor-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Processor.GetBalanceResponse{}}

Specs

get_identity(String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.GetIdentityResponse.t()} | {:error, Plaid.Error.t()}

Get account holder information on file with the financial institution.

Does a POST /processor/identity/get call which allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

Params:

• processor_token - The processor token obtained from the Plaid integration partner.

examples

Examples

Processor.get_identity("processor-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Processor.GetIdentityResponse{}}