Packages

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

Current section

Files

Jump to
tiger_stripe lib stripe params payment_method_create_params.ex
Raw

lib/stripe/params/payment_method_create_params.ex

# File generated from our OpenAPI spec
defmodule Stripe.Params.PaymentMethodCreateParams do
@moduledoc "Parameters for payment method create."
@typedoc """
* `acss_debit` - If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
* `affirm` - If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
* `afterpay_clearpay` - If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
* `alipay` - If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
* `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`. Possible values: `always`, `limited`, `unspecified`.
* `alma` - If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
* `amazon_pay` - If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
* `au_becs_debit` - If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
* `bacs_debit` - If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
* `bancontact` - If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
* `billie` - If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
* `billing_details` - Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
* `bizum` - If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method.
* `blik` - If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
* `boleto` - If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
* `card` - If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.
* `cashapp` - If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
* `crypto` - If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
* `custom` - If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method.
* `customer` - The `Customer` to whom the original PaymentMethod is attached. Max length: 5000.
* `customer_balance` - If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
* `eps` - If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
* `expand` - Specifies which fields in the response should be expanded.
* `fpx` - If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
* `giropay` - If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
* `grabpay` - If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
* `ideal` - If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
* `interac_present` - If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
* `kakao_pay` - If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
* `klarna` - If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
* `konbini` - If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
* `kr_card` - If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
* `link` - If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK).
* `mb_way` - If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
* `mobilepay` - If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
* `multibanco` - If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
* `naver_pay` - If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
* `nz_bank_account` - If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
* `oxxo` - If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
* `p24` - If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
* `pay_by_bank` - If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
* `payco` - If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
* `payment_method` - The PaymentMethod to share. Max length: 5000.
* `paynow` - If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
* `paypal` - If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
* `payto` - If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
* `pix` - If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
* `promptpay` - If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
* `radar_options` - Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
* `revolut_pay` - If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
* `samsung_pay` - If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
* `satispay` - If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
* `scalapay` - If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method.
* `sepa_debit` - If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
* `sofort` - If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
* `sunbit` - If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method.
* `swish` - If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
* `twint` - If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
* `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. Possible values: `acss_debit`, `affirm`, `afterpay_clearpay`, `alipay`, `alma`, `amazon_pay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `billie`, `bizum`, `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`, `payto`, `pix`, `promptpay`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sepa_debit`, `sofort`, `sunbit`, `swish`, `twint`, `upi`, `us_bank_account`, `wechat_pay`, `zip`.
* `upi` - If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.
* `us_bank_account` - If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
* `wechat_pay` - If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
* `zip` - If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
"""
@type t :: %__MODULE__{}
defstruct [
:acss_debit,
:affirm,
:afterpay_clearpay,
:alipay,
:allow_redisplay,
:alma,
:amazon_pay,
:au_becs_debit,
:bacs_debit,
:bancontact,
:billie,
:billing_details,
:bizum,
:blik,
:boleto,
:card,
:cashapp,
:crypto,
:custom,
:customer,
:customer_balance,
:eps,
:expand,
:fpx,
:giropay,
:grabpay,
:ideal,
:interac_present,
:kakao_pay,
:klarna,
:konbini,
:kr_card,
:link,
:mb_way,
:metadata,
:mobilepay,
:multibanco,
:naver_pay,
:nz_bank_account,
:oxxo,
:p24,
:pay_by_bank,
:payco,
:payment_method,
:paynow,
:paypal,
:payto,
:pix,
:promptpay,
:radar_options,
:revolut_pay,
:samsung_pay,
:satispay,
:scalapay,
:sepa_debit,
:sofort,
:sunbit,
:swish,
:twint,
:type,
:upi,
:us_bank_account,
:wechat_pay,
:zip
]
end