stripity_stripe

stripity_stripe v2.7.0 Stripe.BankAccount View Source

Work with Stripe bank account objects.

Stripe API reference: https://stripe.com/docs/api#bank_accounts

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a bank account.

delete(id, params, opts \\ [])

Delete a bank account.

list(params, opts \\ [])

List all bank accounts.

retrieve(id, params, opts \\ [])

Retrieve a bank account.

update(id, params, opts \\ [])

Update a bank account.

verify(id, params, opts \\ [])

Verify a bank account.

Link to this section Types

Link to this type

t() View Source 
t() :: %Stripe.BankAccount{
  account: Stripe.id() | Stripe.Account.t() | nil,
  account_holder_name: String.t() | nil,
  account_holder_type: String.t() | nil,
  bank_name: String.t() | nil,
  country: String.t(),
  currency: String.t(),
  customer: Stripe.id() | Stripe.Customer.t() | nil,
  default_for_currency: boolean() | nil,
  deleted: boolean() | nil,
  fingerprint: String.t() | nil,
  id: Stripe.id(),
  last4: String.t(),
  metadata: Stripe.Types.metadata() | nil,
  object: String.t(),
  routing_number: String.t() | nil,
  status: String.t()
}

Link to this section Functions

Link to this function

create(params, opts \\ []) View Source 
create(params, Keyword.t()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       :source => Stripe.id() | Stripe.Source.t(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Create a bank account.

Link to this function

delete(id, params, opts \\ []) View Source 
delete(Stripe.id() | t(), map(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Delete a bank account.

Link to this function

list(params, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all bank accounts.

Link to this function

retrieve(id, params, opts \\ []) View Source 
retrieve(Stripe.id() | t(), map(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a bank account.

Link to this function

update(id, params, opts \\ []) View Source 
update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       optional(:metadata) => Stripe.Types.metadata(),
       optional(:account_holder_name) => String.t(),
       optional(:account_holder_type) => String.t()
     }

Update a bank account.

Link to this function

verify(id, params, opts \\ []) View Source 
verify(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       optional(:amounts) => [integer()],
       optional(:verification_method) => String.t()
     }

Verify a bank account.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog