View Source Stripe.Card (stripity_stripe v3.3.1)

You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

Related guide: Card payments with Sources

Summary

Types

One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.

Documents that may be submitted to satisfy various informational requests.

t()

The card type.

Functions

Delete a specified external account for a given account.

Updates the metadata, account holder name, account holder type of a bank account belonging toa connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

Types

Link to this type

bank_account_ownership_verification()

View Source
@type bank_account_ownership_verification() :: %{optional(:files) => [binary()]}

One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.

@type documents() :: %{
  optional(:bank_account_ownership_verification) =>
    bank_account_ownership_verification()
}

Documents that may be submitted to satisfy various informational requests.

@type t() :: %Stripe.Card{
  account: (binary() | Stripe.Account.t()) | nil,
  address_city: binary() | nil,
  address_country: binary() | nil,
  address_line1: binary() | nil,
  address_line1_check: binary() | nil,
  address_line2: binary() | nil,
  address_state: binary() | nil,
  address_zip: binary() | nil,
  address_zip_check: binary() | nil,
  allow_redisplay: binary() | nil,
  available_payout_methods: term() | nil,
  brand: binary(),
  country: binary() | nil,
  currency: binary() | nil,
  customer: (binary() | Stripe.Customer.t() | Stripe.DeletedCustomer.t()) | nil,
  cvc_check: binary() | nil,
  default_for_currency: boolean() | nil,
  description: binary(),
  dynamic_last4: binary() | nil,
  exp_month: integer(),
  exp_year: integer(),
  fingerprint: binary() | nil,
  funding: binary(),
  id: binary(),
  iin: binary(),
  issuer: binary(),
  last4: binary(),
  metadata: term() | nil,
  name: binary() | nil,
  networks: term(),
  object: binary(),
  regulated_status: binary() | nil,
  status: binary() | nil,
  tokenization_method: binary() | nil
}

The card type.

  • account
  • address_city City/District/Suburb/Town/Village.
  • address_country Billing address country, if provided when creating card.
  • address_line1 Address line 1 (Street address/PO Box/Company name).
  • address_line1_check If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
  • address_line2 Address line 2 (Apartment/Suite/Unit/Building).
  • address_state State/County/Province/Region.
  • address_zip ZIP or postal code.
  • address_zip_check If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
  • allow_redisplay This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
  • available_payout_methods A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
  • brand Card brand. Can be American Express, Cartes Bancaires, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.
  • country Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
  • currency Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an External Account where controller.is_controller is true.
  • customer The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
  • cvc_check If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.
  • default_for_currency Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is application, which includes Custom accounts.
  • description A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
  • dynamic_last4 (For tokenized numbers only.) The last four digits of the device account number.
  • exp_month Two-digit number representing the card's expiration month.
  • exp_year Four-digit number representing the card's expiration year.
  • fingerprint Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.

  • funding Card funding type. Can be credit, debit, prepaid, or unknown.
  • id Unique identifier for the object.
  • iin Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
  • issuer The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
  • last4 The last four digits of the card.
  • 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.
  • name Cardholder name.
  • networks
  • object String representing the object's type. Objects of the same type share the same value.
  • regulated_status Status of a card based on the card issuer.
  • status For external accounts that are cards, possible values are new and errored. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated.
  • tokenization_method If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

Functions

Link to this function

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

View Source
@spec delete(account :: binary(), id :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedExternalAccount.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Delete a specified external account for a given account.

Details

  • Method: delete
  • Path: /v1/accounts/{account}/external_accounts/{id}
Link to this function

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

View Source
@spec update(
  account :: binary(),
  id :: binary(),
  params :: %{
    optional(:account_holder_name) => binary(),
    optional(:account_holder_type) => :company | :individual,
    optional(:account_type) => :checking | :futsu | :savings | :toza,
    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(:default_for_currency) => boolean(),
    optional(:documents) => documents(),
    optional(:exp_month) => binary(),
    optional(:exp_year) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:name) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.ExternalAccount.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Updates the metadata, account holder name, account holder type of a bank account belonging toa connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

You can re-enable a disabled bank account by performing an update call without providing anyarguments or changes.

#### Details * Method: `post` * Path: `/v1/accounts/{account}/external_accounts/{id}`