defmodule Stripe.PaymentMethod do
use Stripe.Entity
@moduledoc "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)."
(
defstruct [
:zip,
:swish,
:us_bank_account,
:allow_redisplay,
:payco,
:afterpay_clearpay,
:sepa_debit,
:cashapp,
:radar_options,
:kakao_pay,
:livemode,
:customer,
:samsung_pay,
:type,
:promptpay,
:wechat_pay,
:alma,
:paynow,
:oxxo,
:created,
:fpx,
:custom,
:paypal,
:p24,
:blik,
:konbini,
:kr_card,
:link,
:acss_debit,
:id,
:crypto,
:naver_pay,
:twint,
:mb_way,
:card,
:klarna,
:revolut_pay,
:multibanco,
:giropay,
:object,
:pix,
:ideal,
:billie,
:eps,
:grabpay,
:nz_bank_account,
:pay_by_bank,
:mobilepay,
:billing_details,
:affirm,
:bacs_debit,
:interac_present,
:bancontact,
:card_present,
:metadata,
:amazon_pay,
:au_becs_debit,
:alipay,
:boleto,
:satispay,
:customer_balance,
:sofort
]
@typedoc "The `payment_method` type.\n\n * `acss_debit` \n * `affirm` \n * `afterpay_clearpay` \n * `alipay` \n * `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”.\n * `alma` \n * `amazon_pay` \n * `au_becs_debit` \n * `bacs_debit` \n * `bancontact` \n * `billie` \n * `billing_details` \n * `blik` \n * `boleto` \n * `card` \n * `card_present` \n * `cashapp` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `crypto` \n * `custom` \n * `customer` The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.\n * `customer_balance` \n * `eps` \n * `fpx` \n * `giropay` \n * `grabpay` \n * `id` Unique identifier for the object.\n * `ideal` \n * `interac_present` \n * `kakao_pay` \n * `klarna` \n * `konbini` \n * `kr_card` \n * `link` \n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `mb_way` \n * `metadata` Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n * `mobilepay` \n * `multibanco` \n * `naver_pay` \n * `nz_bank_account` \n * `object` String representing the object's type. Objects of the same type share the same value.\n * `oxxo` \n * `p24` \n * `pay_by_bank` \n * `payco` \n * `paynow` \n * `paypal` \n * `pix` \n * `promptpay` \n * `radar_options` \n * `revolut_pay` \n * `samsung_pay` \n * `satispay` \n * `sepa_debit` \n * `sofort` \n * `swish` \n * `twint` \n * `type` The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.\n * `us_bank_account` \n * `wechat_pay` \n * `zip` \n"
@type t :: %__MODULE__{
acss_debit: term,
affirm: term,
afterpay_clearpay: term,
alipay: term,
allow_redisplay: binary,
alma: term,
amazon_pay: term,
au_becs_debit: term,
bacs_debit: term,
bancontact: term,
billie: term,
billing_details: term,
blik: term,
boleto: term,
card: term,
card_present: term,
cashapp: term,
created: integer,
crypto: term,
custom: term,
customer: (binary | Stripe.Customer.t()) | nil,
customer_balance: term,
eps: term,
fpx: term,
giropay: term,
grabpay: term,
id: binary,
ideal: term,
interac_present: term,
kakao_pay: term,
klarna: term,
konbini: term,
kr_card: term,
link: term,
livemode: boolean,
mb_way: term,
metadata: term | nil,
mobilepay: term,
multibanco: term,
naver_pay: term,
nz_bank_account: term,
object: binary,
oxxo: term,
p24: term,
pay_by_bank: term,
payco: term,
paynow: term,
paypal: term,
pix: term,
promptpay: term,
radar_options: term,
revolut_pay: term,
samsung_pay: term,
satispay: term,
sepa_debit: term,
sofort: term,
swish: term,
twint: term,
type: binary,
us_bank_account: term,
wechat_pay: term,
zip: term
}
)
(
@typedoc "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method."
@type acss_debit :: %{
optional(:account_number) => binary,
optional(:institution_number) => binary,
optional(:transit_number) => binary
}
)
(
@typedoc nil
@type address :: %{
optional(:city) => binary,
optional(:country) => binary,
optional(:line1) => binary,
optional(:line2) => binary,
optional(:postal_code) => binary,
optional(:state) => binary
}
)
(
@typedoc "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account."
@type au_becs_debit :: %{optional(:account_number) => binary, optional(:bsb_number) => binary}
)
(
@typedoc "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account."
@type bacs_debit :: %{optional(:account_number) => binary, optional(:sort_code) => binary}
)
(
@typedoc "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods."
@type billing_details :: %{
optional(:address) => address | binary,
optional(:email) => binary | binary,
optional(:name) => binary | binary,
optional(:phone) => binary | binary,
optional(:tax_id) => binary
}
)
(
@typedoc "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method."
@type boleto :: %{optional(:tax_id) => binary}
)
(
@typedoc nil
@type card :: %{
optional(:cvc) => binary,
optional(:exp_month) => integer,
optional(:exp_year) => integer,
optional(:networks) => networks,
optional(:number) => binary
}
)
(
@typedoc "If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method."
@type custom :: %{optional(:type) => binary}
)
(
@typedoc "Customer's date of birth"
@type dob :: %{
optional(:day) => integer,
optional(:month) => integer,
optional(:year) => integer
}
)
(
@typedoc "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method."
@type eps :: %{
optional(:bank) =>
:arzte_und_apotheker_bank
| :austrian_anadi_bank_ag
| :bank_austria
| :bankhaus_carl_spangler
| :bankhaus_schelhammer_und_schattera_ag
| :bawag_psk_ag
| :bks_bank_ag
| :brull_kallmus_bank_ag
| :btv_vier_lander_bank
| :capital_bank_grawe_gruppe_ag
| :deutsche_bank_ag
| :dolomitenbank
| :easybank_ag
| :erste_bank_und_sparkassen
| :hypo_alpeadriabank_international_ag
| :hypo_bank_burgenland_aktiengesellschaft
| :hypo_noe_lb_fur_niederosterreich_u_wien
| :hypo_oberosterreich_salzburg_steiermark
| :hypo_tirol_bank_ag
| :hypo_vorarlberg_bank_ag
| :marchfelder_bank
| :oberbank_ag
| :raiffeisen_bankengruppe_osterreich
| :schoellerbank_ag
| :sparda_bank_wien
| :volksbank_gruppe
| :volkskreditbank_ag
| :vr_bank_braunau
}
)
(
@typedoc "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method."
@type fpx :: %{
optional(:account_holder_type) => :company | :individual,
optional(:bank) =>
:affin_bank
| :agrobank
| :alliance_bank
| :ambank
| :bank_islam
| :bank_muamalat
| :bank_of_china
| :bank_rakyat
| :bsn
| :cimb
| :deutsche_bank
| :hong_leong_bank
| :hsbc
| :kfh
| :maybank2e
| :maybank2u
| :ocbc
| :pb_enterprise
| :public_bank
| :rhb
| :standard_chartered
| :uob
}
)
(
@typedoc "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method."
@type ideal :: %{
optional(:bank) =>
:abn_amro
| :asn_bank
| :bunq
| :buut
| :finom
| :handelsbanken
| :ing
| :knab
| :moneyou
| :n26
| :nn
| :rabobank
| :regiobank
| :revolut
| :sns_bank
| :triodos_bank
| :van_lanschot
| :yoursafe
}
)
(
@typedoc "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method."
@type klarna :: %{optional(:dob) => dob}
)
(
@typedoc "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method."
@type naver_pay :: %{optional(:funding) => :card | :points}
)
(
@typedoc "Contains information about card networks used to process the payment."
@type networks :: %{optional(:preferred) => :cartes_bancaires | :mastercard | :visa}
)
(
@typedoc "If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method."
@type nz_bank_account :: %{
optional(:account_holder_name) => binary,
optional(:account_number) => binary,
optional(:bank_code) => binary,
optional(:branch_code) => binary,
optional(:reference) => binary,
optional(:suffix) => binary
}
)
(
@typedoc "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method."
@type p24 :: %{
optional(:bank) =>
:alior_bank
| :bank_millennium
| :bank_nowy_bfg_sa
| :bank_pekao_sa
| :banki_spbdzielcze
| :blik
| :bnp_paribas
| :boz
| :citi_handlowy
| :credit_agricole
| :envelobank
| :etransfer_pocztowy24
| :getin_bank
| :ideabank
| :ing
| :inteligo
| :mbank_mtransfer
| :nest_przelew
| :noble_pay
| :pbac_z_ipko
| :plus_bank
| :santander_przelew24
| :tmobile_usbugi_bankowe
| :toyota_bank
| :velobank
| :volkswagen_bank
}
)
(
@typedoc "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information."
@type radar_options :: %{optional(:session) => binary}
)
(
@typedoc "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account."
@type sepa_debit :: %{optional(:iban) => binary}
)
(
@typedoc "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method."
@type sofort :: %{optional(:country) => :AT | :BE | :DE | :ES | :IT | :NL}
)
(
@typedoc "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method."
@type us_bank_account :: %{
optional(:account_holder_type) => :company | :individual,
optional(:account_number) => binary,
optional(:account_type) => :checking | :savings,
optional(:financial_connections_account) => binary,
optional(:routing_number) => binary
}
)
(
nil
@doc "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_methods`\n"
(
@spec list(
params :: %{
optional(:customer) => binary,
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary,
optional(:type) =>
:acss_debit
| :affirm
| :afterpay_clearpay
| :alipay
| :alma
| :amazon_pay
| :au_becs_debit
| :bacs_debit
| :bancontact
| :billie
| :blik
| :boleto
| :card
| :cashapp
| :crypto
| :custom
| :customer_balance
| :eps
| :fpx
| :giropay
| :grabpay
| :ideal
| :kakao_pay
| :klarna
| :konbini
| :kr_card
| :link
| :mb_way
| :mobilepay
| :multibanco
| :naver_pay
| :nz_bank_account
| :oxxo
| :p24
| :pay_by_bank
| :payco
| :paynow
| :paypal
| :pix
| :promptpay
| :revolut_pay
| :samsung_pay
| :satispay
| :sepa_debit
| :sofort
| :swish
| :twint
| :us_bank_account
| :wechat_pay
| :zip
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.PaymentMethod.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_methods", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods
\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/payment_methods/{payment_method}`\n"
(
@spec retrieve(
payment_method :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def retrieve(payment_method, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/payment_methods/{payment_method}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "payment_method",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "payment_method",
properties: [],
title: nil,
type: "string"
}
}
],
[payment_method]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
\n\nInstead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods`\n"
(
@spec create(
params :: %{
optional(:sofort) => sofort,
optional(:customer_balance) => map(),
optional(:satispay) => map(),
optional(:boleto) => boleto,
optional(:alipay) => map(),
optional(:au_becs_debit) => au_becs_debit,
optional(:amazon_pay) => map(),
optional(:metadata) => %{optional(binary) => binary},
optional(:bancontact) => map(),
optional(:interac_present) => map(),
optional(:bacs_debit) => bacs_debit,
optional(:affirm) => map(),
optional(:billing_details) => billing_details,
optional(:mobilepay) => map(),
optional(:pay_by_bank) => map(),
optional(:nz_bank_account) => nz_bank_account,
optional(:grabpay) => map(),
optional(:eps) => eps,
optional(:billie) => map(),
optional(:ideal) => ideal,
optional(:pix) => map(),
optional(:giropay) => map(),
optional(:multibanco) => map(),
optional(:revolut_pay) => map(),
optional(:klarna) => klarna,
optional(:card) => card | card,
optional(:mb_way) => map(),
optional(:twint) => map(),
optional(:naver_pay) => naver_pay,
optional(:crypto) => map(),
optional(:acss_debit) => acss_debit,
optional(:link) => map(),
optional(:kr_card) => map(),
optional(:konbini) => map(),
optional(:blik) => map(),
optional(:p24) => p24,
optional(:paypal) => map(),
optional(:custom) => custom,
optional(:fpx) => fpx,
optional(:payment_method) => binary,
optional(:oxxo) => map(),
optional(:paynow) => map(),
optional(:alma) => map(),
optional(:wechat_pay) => map(),
optional(:promptpay) => map(),
optional(:type) =>
:acss_debit
| :affirm
| :afterpay_clearpay
| :alipay
| :alma
| :amazon_pay
| :au_becs_debit
| :bacs_debit
| :bancontact
| :billie
| :blik
| :boleto
| :card
| :cashapp
| :crypto
| :custom
| :customer_balance
| :eps
| :fpx
| :giropay
| :grabpay
| :ideal
| :kakao_pay
| :klarna
| :konbini
| :kr_card
| :link
| :mb_way
| :mobilepay
| :multibanco
| :naver_pay
| :nz_bank_account
| :oxxo
| :p24
| :pay_by_bank
| :payco
| :paynow
| :paypal
| :pix
| :promptpay
| :revolut_pay
| :samsung_pay
| :satispay
| :sepa_debit
| :sofort
| :swish
| :twint
| :us_bank_account
| :wechat_pay
| :zip,
optional(:samsung_pay) => map(),
optional(:customer) => binary,
optional(:kakao_pay) => map(),
optional(:expand) => list(binary),
optional(:radar_options) => radar_options,
optional(:cashapp) => map(),
optional(:sepa_debit) => sepa_debit,
optional(:afterpay_clearpay) => map(),
optional(:payco) => map(),
optional(:allow_redisplay) => :always | :limited | :unspecified,
optional(:us_bank_account) => us_bank_account,
optional(:swish) => map(),
optional(:zip) => map()
},
opts :: Keyword.t()
) ::
{:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def create(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/payment_methods", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods/{payment_method}`\n"
(
@spec update(
payment_method :: binary(),
params :: %{
optional(:allow_redisplay) => :always | :limited | :unspecified,
optional(:billing_details) => billing_details,
optional(:card) => card,
optional(:expand) => list(binary),
optional(:metadata) => %{optional(binary) => binary} | binary,
optional(:us_bank_account) => us_bank_account
},
opts :: Keyword.t()
) ::
{:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def update(payment_method, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/payment_methods/{payment_method}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "payment_method",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "payment_method",
properties: [],
title: nil,
type: "string"
}
}
],
[payment_method]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "Attaches a PaymentMethod object to a Customer.
\n\nTo attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach\nendpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for\nfuture use, which makes later declines and payment friction more likely.\nSee Optimizing cards for future payments for more information about setting up\nfuture payments.
\n\nTo use this PaymentMethod as the default for invoice or subscription payments,\nset invoice_settings.default_payment_method,\non the Customer to the PaymentMethod’s ID.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods/{payment_method}/attach`\n"
(
@spec attach(
payment_method :: binary(),
params :: %{optional(:customer) => binary, optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def attach(payment_method, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/payment_methods/{payment_method}/attach",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "payment_method",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "payment_method",
properties: [],
title: nil,
type: "string"
}
}
],
[payment_method]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/payment_methods/{payment_method}/detach`\n"
(
@spec detach(
payment_method :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.PaymentMethod.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
def detach(payment_method, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/payment_methods/{payment_method}/detach",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "payment_method",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "payment_method",
properties: [],
title: nil,
type: "string"
}
}
],
[payment_method]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:post)
|> Stripe.Request.make_request()
end
)
)
end