View Source Stripe.BankAccount (stripity_stripe v3.1.1)

These bank accounts are payment methods on Customer objects.

On the other hand External Accounts are transfer destinations on Account objects for Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

Related guide: Bank debits and transfers

Link to this section Summary

Types

Owner's address.

t()

The bank_account type.

Functions

Delete a specified source for a given customer.

Update a specified source for a given customer.

Verify a specified bank account for a given customer.

Link to this section Types

@type address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

Owner's address.

@type owner() :: %{
  optional(:address) => address(),
  optional(:email) => binary(),
  optional(:name) => binary(),
  optional(:phone) => binary()
}
@type t() :: %Stripe.BankAccount{
  account: (binary() | Stripe.Account.t()) | nil,
  account_holder_name: binary() | nil,
  account_holder_type: binary() | nil,
  account_type: binary() | nil,
  available_payout_methods: term() | nil,
  bank_name: binary() | nil,
  country: binary(),
  currency: binary(),
  customer: (binary() | Stripe.Customer.t() | Stripe.DeletedCustomer.t()) | nil,
  default_for_currency: boolean() | nil,
  fingerprint: binary() | nil,
  future_requirements: term() | nil,
  id: binary(),
  last4: binary(),
  metadata: term() | nil,
  object: binary(),
  requirements: term() | nil,
  routing_number: binary() | nil,
  status: binary()
}

The bank_account type.

  • account The ID of the account that the bank account is associated with.
  • account_holder_name The name of the person or business that owns the bank account.
  • account_holder_type The type of entity that holds the account. This can be either individual or company.
  • account_type The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.
  • available_payout_methods A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.
  • bank_name Name of the bank associated with the routing number (e.g., WELLS FARGO).
  • country Two-letter ISO code representing the country the bank account is located in.
  • currency Three-letter ISO code for the currency paid out to the bank account.
  • customer The ID of the customer that the bank account is associated with.
  • default_for_currency Whether this bank account is the default external account for its currency.
  • fingerprint Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
  • future_requirements Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.
  • id Unique identifier for the object.
  • last4 The last four digits of the bank account number.
  • metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  • object String representing the object's type. Objects of the same type share the same value.
  • requirements Information about the requirements for the bank account, including what information needs to be collected.
  • routing_number The routing transit number for the bank account.
  • status For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a payout sent to this bank account fails, we'll set the status to errored and will not continue to send scheduled payouts until the bank details are updated.

For external accounts, possible values are new, errored and verification_failed. If a payouts fails, the status is set to errored and scheduled payouts are stopped until account details are updated. In India, if we can't verify the owner of the bank account, we'll set the status to verification_failed. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.

Link to this section Functions

Link to this function

delete(customer, id, params \\ %{}, opts \\ [])

View Source
@spec delete(
  customer :: binary(),
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) ::
  {:ok, Stripe.PaymentSource.t() | Stripe.DeletedPaymentSource.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Delete a specified source for a given customer.

Details

  • Method: delete
  • Path: /v1/customers/{customer}/sources/{id}
Link to this function

update(customer, id, params \\ %{}, opts \\ [])

View Source
@spec update(
  customer :: binary(),
  id :: binary(),
  params :: %{
    optional(:account_holder_name) => binary(),
    optional(:account_holder_type) => :company | :individual,
    optional(:address_city) => binary(),
    optional(:address_country) => binary(),
    optional(:address_line1) => binary(),
    optional(:address_line2) => binary(),
    optional(:address_state) => binary(),
    optional(:address_zip) => binary(),
    optional(:exp_month) => binary(),
    optional(:exp_year) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:name) => binary(),
    optional(:owner) => owner()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.Card.t() | t() | Stripe.Source.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Update a specified source for a given customer.

Details

  • Method: post
  • Path: /v1/customers/{customer}/sources/{id}
Link to this function

verify(customer, id, params \\ %{}, opts \\ [])

View Source
@spec verify(
  customer :: binary(),
  id :: binary(),
  params :: %{
    optional(:amounts) => [integer()],
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Verify a specified bank account for a given customer.

Details

  • Method: post
  • Path: /v1/customers/{customer}/sources/{id}/verify