View Source Stripe.Card (stripity_stripe v3.2.0)
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
Functions
Delete a specified source for a given customer.
Update a specified source for a given customer.
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 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, 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, object: binary(), status: binary() | nil, tokenization_method: binary() | nil }
The card
type.
account
The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.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
Ifaddress_line1
was provided, results of the check:pass
,fail
,unavailable
, orunchecked
.address_line2
Address line 2 (Apartment/Suite/Unit/Building).address_state
State/County/Province/Region.address_zip
ZIP or postal code.address_zip_check
Ifaddress_zip
was provided, results of the check:pass
,fail
,unavailable
, orunchecked
.available_payout_methods
A set of available payout methods for this card. Only values from this set should be passed as themethod
when creating a payout.brand
Card brand. Can beAmerican Express
,Diners Club
,Discover
,Eftpos Australia
,JCB
,MasterCard
,UnionPay
,Visa
, orUnknown
.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. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.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
, orunchecked
. 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.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 becredit
,debit
,prepaid
, orunknown
.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.object
String representing the object's type. Objects of the same type share the same value.status
For external accounts that are cards, possible values arenew
anderrored
. If a payout fails, the status is set toerrored
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 beandroid_pay
(includes Google Pay),apple_pay
,masterpass
,visa_checkout
, or null.
Functions
@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}
@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, t() | Stripe.BankAccount.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}