stripe-ruby/lib/stripe/resources/payment_intent.rb
2025-05-20 18:14:52 +00:00

13870 lines
767 KiB
Ruby
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# File generated from our OpenAPI spec
# frozen_string_literal: true
module Stripe
# A PaymentIntent guides you through the process of collecting a payment from your customer.
# We recommend that you create exactly one PaymentIntent for each order or
# customer session in your system. You can reference the PaymentIntent later to
# see the history of payment attempts for a particular session.
#
# A PaymentIntent transitions through
# [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
# throughout its lifetime as it interfaces with Stripe.js to perform
# authentication flows and ultimately creates at most one successful charge.
#
# Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
class PaymentIntent < APIResource
extend Stripe::APIOperations::Create
extend Stripe::APIOperations::List
extend Stripe::APIOperations::NestedResource
extend Stripe::APIOperations::Search
include Stripe::APIOperations::Save
OBJECT_NAME = "payment_intent"
def self.object_name
"payment_intent"
end
nested_resource_class_methods :amount_details_line_item, operations: %i[list]
class AmountDetails < Stripe::StripeObject
class Shipping < Stripe::StripeObject
# Portion of the amount that is for shipping.
attr_reader :amount
# The postal code that represents the shipping source.
attr_reader :from_postal_code
# The postal code that represents the shipping destination.
attr_reader :to_postal_code
end
class Tax < Stripe::StripeObject
# Total portion of the amount that is for tax.
attr_reader :total_tax_amount
end
class Tip < Stripe::StripeObject
# Portion of the amount that corresponds to a tip.
attr_reader :amount
end
# The amount an item was discounted for.
attr_reader :discount_amount
# A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
attr_reader :line_items
# Attribute for field shipping
attr_reader :shipping
# Attribute for field tax
attr_reader :tax
# Attribute for field tip
attr_reader :tip
end
class AutomaticPaymentMethods < Stripe::StripeObject
# Controls whether this PaymentIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
attr_reader :allow_redirects
# Automatically calculates compatible payment methods
attr_reader :enabled
end
class Hooks < Stripe::StripeObject
class Inputs < Stripe::StripeObject
class Tax < Stripe::StripeObject
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_reader :calculation
end
# Attribute for field tax
attr_reader :tax
end
# Attribute for field inputs
attr_reader :inputs
end
class LastPaymentError < Stripe::StripeObject
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
attr_reader :advice_code
# For card errors, the ID of the failed charge.
attr_reader :charge
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
attr_reader :code
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
attr_reader :decline_code
# A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
attr_reader :doc_url
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
attr_reader :message
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
attr_reader :network_advice_code
# For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
attr_reader :network_decline_code
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
attr_reader :param
# A PaymentIntent guides you through the process of collecting a payment from your customer.
# We recommend that you create exactly one PaymentIntent for each order or
# customer session in your system. You can reference the PaymentIntent later to
# see the history of payment attempts for a particular session.
#
# A PaymentIntent transitions through
# [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
# throughout its lifetime as it interfaces with Stripe.js to perform
# authentication flows and ultimately creates at most one successful charge.
#
# Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
attr_reader :payment_intent
# PaymentMethod objects represent your customer's payment instruments.
# You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
# Customer objects to store instrument details for future payments.
#
# Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
attr_reader :payment_method
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
attr_reader :payment_method_type
# A URL to the request log entry in your dashboard.
attr_reader :request_log_url
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
# For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
# Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
#
# Create a SetupIntent when you're ready to collect your customer's payment credentials.
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
# The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
# you through the setup process.
#
# Successful SetupIntents result in payment credentials that are optimized for future payments.
# For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
# If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
# it automatically attaches the resulting payment method to that Customer after successful setup.
# We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
# PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
#
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
#
# Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
attr_reader :setup_intent
# Attribute for field source
attr_reader :source
# The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
attr_reader :type
end
class NextAction < Stripe::StripeObject
class AlipayHandleRedirect < Stripe::StripeObject
# The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.
attr_reader :native_data
# The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.
attr_reader :native_url
# If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
attr_reader :return_url
# The URL you must redirect your customer to in order to authenticate the payment.
attr_reader :url
end
class BoletoDisplayDetails < Stripe::StripeObject
# The timestamp after which the boleto expires.
attr_reader :expires_at
# The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.
attr_reader :hosted_voucher_url
# The boleto number.
attr_reader :number
# The URL to the downloadable boleto voucher PDF.
attr_reader :pdf
end
class CardAwaitNotification < Stripe::StripeObject
# The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.
attr_reader :charge_attempt_at
# For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.
attr_reader :customer_approval_required
end
class CashappHandleRedirectOrDisplayQrCode < Stripe::StripeObject
class QrCode < Stripe::StripeObject
# The date (unix timestamp) when the QR code expires.
attr_reader :expires_at
# The image_url_png string used to render QR code
attr_reader :image_url_png
# The image_url_svg string used to render QR code
attr_reader :image_url_svg
end
# The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
attr_reader :hosted_instructions_url
# The url for mobile redirect based auth
attr_reader :mobile_auth_url
# Attribute for field qr_code
attr_reader :qr_code
end
class DisplayBankTransferInstructions < Stripe::StripeObject
class FinancialAddress < Stripe::StripeObject
class Aba < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The account holder name
attr_reader :account_holder_name
# The ABA account number
attr_reader :account_number
# The account type
attr_reader :account_type
# Attribute for field bank_address
attr_reader :bank_address
# The bank name
attr_reader :bank_name
# The ABA routing number
attr_reader :routing_number
end
class Iban < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The name of the person or business that owns the bank account
attr_reader :account_holder_name
# Attribute for field bank_address
attr_reader :bank_address
# The BIC/SWIFT code of the account.
attr_reader :bic
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# The IBAN of the account.
attr_reader :iban
end
class SortCode < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The name of the person or business that owns the bank account
attr_reader :account_holder_name
# The account number
attr_reader :account_number
# Attribute for field bank_address
attr_reader :bank_address
# The six-digit sort code
attr_reader :sort_code
end
class Spei < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The account holder name
attr_reader :account_holder_name
# Attribute for field bank_address
attr_reader :bank_address
# The three-digit bank code
attr_reader :bank_code
# The short banking institution name
attr_reader :bank_name
# The CLABE number
attr_reader :clabe
end
class Swift < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The account holder name
attr_reader :account_holder_name
# The account number
attr_reader :account_number
# The account type
attr_reader :account_type
# Attribute for field bank_address
attr_reader :bank_address
# The bank name
attr_reader :bank_name
# The SWIFT code
attr_reader :swift_code
end
class Zengin < Stripe::StripeObject
class AccountHolderAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class BankAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field account_holder_address
attr_reader :account_holder_address
# The account holder name
attr_reader :account_holder_name
# The account number
attr_reader :account_number
# The bank account type. In Japan, this can only be `futsu` or `toza`.
attr_reader :account_type
# Attribute for field bank_address
attr_reader :bank_address
# The bank code of the account
attr_reader :bank_code
# The bank name of the account
attr_reader :bank_name
# The branch code of the account
attr_reader :branch_code
# The branch name of the account
attr_reader :branch_name
end
# ABA Records contain U.S. bank account details per the ABA format.
attr_reader :aba
# Iban Records contain E.U. bank account details per the SEPA format.
attr_reader :iban
# Sort Code Records contain U.K. bank account details per the sort code format.
attr_reader :sort_code
# SPEI Records contain Mexico bank account details per the SPEI format.
attr_reader :spei
# The payment networks supported by this FinancialAddress
attr_reader :supported_networks
# SWIFT Records contain U.S. bank account details per the SWIFT format.
attr_reader :swift
# The type of financial address
attr_reader :type
# Zengin Records contain Japan bank account details per the Zengin format.
attr_reader :zengin
end
# The remaining amount that needs to be transferred to complete the payment.
attr_reader :amount_remaining
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_reader :currency
# A list of financial addresses that can be used to fund the customer balance
attr_reader :financial_addresses
# A link to a hosted page that guides your customer through completing the transfer.
attr_reader :hosted_instructions_url
# A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.
attr_reader :reference
# Type of bank transfer
attr_reader :type
end
class KonbiniDisplayDetails < Stripe::StripeObject
class Stores < Stripe::StripeObject
class Familymart < Stripe::StripeObject
# The confirmation number.
attr_reader :confirmation_number
# The payment code.
attr_reader :payment_code
end
class Lawson < Stripe::StripeObject
# The confirmation number.
attr_reader :confirmation_number
# The payment code.
attr_reader :payment_code
end
class Ministop < Stripe::StripeObject
# The confirmation number.
attr_reader :confirmation_number
# The payment code.
attr_reader :payment_code
end
class Seicomart < Stripe::StripeObject
# The confirmation number.
attr_reader :confirmation_number
# The payment code.
attr_reader :payment_code
end
# FamilyMart instruction details.
attr_reader :familymart
# Lawson instruction details.
attr_reader :lawson
# Ministop instruction details.
attr_reader :ministop
# Seicomart instruction details.
attr_reader :seicomart
end
# The timestamp at which the pending Konbini payment expires.
attr_reader :expires_at
# The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.
attr_reader :hosted_voucher_url
# Attribute for field stores
attr_reader :stores
end
class MultibancoDisplayDetails < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
attr_reader :entity
# The timestamp at which the Multibanco voucher expires.
attr_reader :expires_at
# The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.
attr_reader :hosted_voucher_url
# Reference number associated with this Multibanco payment.
attr_reader :reference
end
class OxxoDisplayDetails < Stripe::StripeObject
# The timestamp after which the OXXO voucher expires.
attr_reader :expires_after
# The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.
attr_reader :hosted_voucher_url
# OXXO reference number.
attr_reader :number
end
class PaynowDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
attr_reader :data
# The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.
attr_reader :hosted_instructions_url
# The image_url_png string used to render QR code
attr_reader :image_url_png
# The image_url_svg string used to render QR code
attr_reader :image_url_svg
end
class PixDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
attr_reader :data
# The date (unix timestamp) when the PIX expires.
attr_reader :expires_at
# The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
attr_reader :hosted_instructions_url
# The image_url_png string used to render png QR code
attr_reader :image_url_png
# The image_url_svg string used to render svg QR code
attr_reader :image_url_svg
end
class PromptpayDisplayQrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
attr_reader :data
# The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.
attr_reader :hosted_instructions_url
# The PNG path used to render the QR code, can be used as the source in an HTML img tag
attr_reader :image_url_png
# The SVG path used to render the QR code, can be used as the source in an HTML img tag
attr_reader :image_url_svg
end
class RedirectToUrl < Stripe::StripeObject
# If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
attr_reader :return_url
# The URL you must redirect your customer to in order to authenticate the payment.
attr_reader :url
end
class SwishHandleRedirectOrDisplayQrCode < Stripe::StripeObject
class QrCode < Stripe::StripeObject
# The raw data string used to generate QR code, it should be used together with QR code library.
attr_reader :data
# The image_url_png string used to render QR code
attr_reader :image_url_png
# The image_url_svg string used to render QR code
attr_reader :image_url_svg
end
# The URL to the hosted Swish instructions page, which allows customers to view the QR code.
attr_reader :hosted_instructions_url
# The url for mobile redirect based auth (for internal use only and not typically available in standard API requests).
attr_reader :mobile_auth_url
# Attribute for field qr_code
attr_reader :qr_code
end
class VerifyWithMicrodeposits < Stripe::StripeObject
# The timestamp when the microdeposits are expected to land.
attr_reader :arrival_date
# The URL for the hosted verification page, which allows customers to verify their bank account.
attr_reader :hosted_verification_url
# The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
attr_reader :microdeposit_type
end
class WechatPayDisplayQrCode < Stripe::StripeObject
# The data being used to generate QR code
attr_reader :data
# The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.
attr_reader :hosted_instructions_url
# The base64 image data for a pre-generated QR code
attr_reader :image_data_url
# The image_url_png string used to render QR code
attr_reader :image_url_png
# The image_url_svg string used to render QR code
attr_reader :image_url_svg
end
class WechatPayRedirectToAndroidApp < Stripe::StripeObject
# app_id is the APP ID registered on WeChat open platform
attr_reader :app_id
# nonce_str is a random string
attr_reader :nonce_str
# package is static value
attr_reader :package
# an unique merchant ID assigned by WeChat Pay
attr_reader :partner_id
# an unique trading ID assigned by WeChat Pay
attr_reader :prepay_id
# A signature
attr_reader :sign
# Specifies the current time in epoch format
attr_reader :timestamp
end
class WechatPayRedirectToIosApp < Stripe::StripeObject
# An universal link that redirect to WeChat Pay app
attr_reader :native_url
end
# Attribute for field alipay_handle_redirect
attr_reader :alipay_handle_redirect
# Attribute for field boleto_display_details
attr_reader :boleto_display_details
# Attribute for field card_await_notification
attr_reader :card_await_notification
# Attribute for field cashapp_handle_redirect_or_display_qr_code
attr_reader :cashapp_handle_redirect_or_display_qr_code
# Attribute for field display_bank_transfer_instructions
attr_reader :display_bank_transfer_instructions
# Attribute for field konbini_display_details
attr_reader :konbini_display_details
# Attribute for field multibanco_display_details
attr_reader :multibanco_display_details
# Attribute for field oxxo_display_details
attr_reader :oxxo_display_details
# Attribute for field paynow_display_qr_code
attr_reader :paynow_display_qr_code
# Attribute for field pix_display_qr_code
attr_reader :pix_display_qr_code
# Attribute for field promptpay_display_qr_code
attr_reader :promptpay_display_qr_code
# Attribute for field redirect_to_url
attr_reader :redirect_to_url
# Attribute for field swish_handle_redirect_or_display_qr_code
attr_reader :swish_handle_redirect_or_display_qr_code
# Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.
attr_reader :type
# When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
attr_reader :use_stripe_sdk
# Attribute for field verify_with_microdeposits
attr_reader :verify_with_microdeposits
# Attribute for field wechat_pay_display_qr_code
attr_reader :wechat_pay_display_qr_code
# Attribute for field wechat_pay_redirect_to_android_app
attr_reader :wechat_pay_redirect_to_android_app
# Attribute for field wechat_pay_redirect_to_ios_app
attr_reader :wechat_pay_redirect_to_ios_app
end
class PaymentDetails < Stripe::StripeObject
class CarRental < Stripe::StripeObject
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
attr_reader :name
end
class Delivery < Stripe::StripeObject
class Recipient < Stripe::StripeObject
# The email of the recipient the ticket is delivered to.
attr_reader :email
# The name of the recipient the ticket is delivered to.
attr_reader :name
# The phone number of the recipient the ticket is delivered to.
attr_reader :phone
end
# The delivery method for the payment
attr_reader :mode
# Attribute for field recipient
attr_reader :recipient
end
class Distance < Stripe::StripeObject
# Distance traveled.
attr_reader :amount
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`
attr_reader :unit
end
class Driver < Stripe::StripeObject
# Driver's identification number.
attr_reader :driver_identification_number
# Driver's tax number.
attr_reader :driver_tax_number
# Full name of the driver on the reservation.
attr_reader :name
end
class PickupAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class ReturnAddress < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field affiliate
attr_reader :affiliate
# The booking number associated with the car rental.
attr_reader :booking_number
# Class code of the car.
attr_reader :car_class_code
# Make of the car.
attr_reader :car_make
# Model of the car.
attr_reader :car_model
# The name of the rental car company.
attr_reader :company
# The customer service phone number of the car rental company.
attr_reader :customer_service_phone_number
# Number of days the car is being rented.
attr_reader :days_rented
# Attribute for field delivery
attr_reader :delivery
# Attribute for field distance
attr_reader :distance
# The details of the drivers associated with the trip.
attr_reader :drivers
# List of additional charges being billed.
attr_reader :extra_charges
# Indicates if the customer did not keep nor cancel their booking.
attr_reader :no_show
# Attribute for field pickup_address
attr_reader :pickup_address
# Car pick-up time. Measured in seconds since the Unix epoch.
attr_reader :pickup_at
# Name of the pickup location.
attr_reader :pickup_location_name
# Rental rate.
attr_reader :rate_amount
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
attr_reader :rate_interval
# The full name of the person or entity renting the car.
attr_reader :renter_name
# Attribute for field return_address
attr_reader :return_address
# Car return time. Measured in seconds since the Unix epoch.
attr_reader :return_at
# Name of the return location.
attr_reader :return_location_name
# Indicates whether the goods or services are tax-exempt or tax is not collected.
attr_reader :tax_exempt
# The vehicle identification number of the car.
attr_reader :vehicle_identification_number
end
class EventDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
attr_reader :name
end
class Delivery < Stripe::StripeObject
class Recipient < Stripe::StripeObject
# The email of the recipient the ticket is delivered to.
attr_reader :email
# The name of the recipient the ticket is delivered to.
attr_reader :name
# The phone number of the recipient the ticket is delivered to.
attr_reader :phone
end
# The delivery method for the payment
attr_reader :mode
# Attribute for field recipient
attr_reader :recipient
end
# Indicates if the tickets are digitally checked when entering the venue.
attr_reader :access_controlled_venue
# Attribute for field address
attr_reader :address
# Attribute for field affiliate
attr_reader :affiliate
# The name of the company
attr_reader :company
# Attribute for field delivery
attr_reader :delivery
# Event end time. Measured in seconds since the Unix epoch.
attr_reader :ends_at
# Type of the event entertainment (concert, sports event etc)
attr_reader :genre
# The name of the event.
attr_reader :name
# Event start time. Measured in seconds since the Unix epoch.
attr_reader :starts_at
end
class Subscription < Stripe::StripeObject
class Affiliate < Stripe::StripeObject
# The name of the affiliate that originated the purchase.
attr_reader :name
end
class BillingInterval < Stripe::StripeObject
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_reader :count
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_reader :interval
end
# Attribute for field affiliate
attr_reader :affiliate
# Info whether the subscription will be auto renewed upon expiry.
attr_reader :auto_renewal
# Attribute for field billing_interval
attr_reader :billing_interval
# Subscription end time. Measured in seconds since the Unix epoch.
attr_reader :ends_at
# Name of the product on subscription. e.g. Apple Music Subscription.
attr_reader :name
# Subscription start time. Measured in seconds since the Unix epoch.
attr_reader :starts_at
end
# Attribute for field car_rental
attr_reader :car_rental
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
attr_reader :customer_reference
# Attribute for field event_details
attr_reader :event_details
# A unique value assigned by the business to identify the transaction.
attr_reader :order_reference
# Attribute for field subscription
attr_reader :subscription
end
class PaymentMethodConfigurationDetails < Stripe::StripeObject
# ID of the payment method configuration used.
attr_reader :id
# ID of the parent payment method configuration used.
attr_reader :parent
end
class PaymentMethodOptions < Stripe::StripeObject
class AcssDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# A URL for custom mandate text
attr_reader :custom_mandate_url
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
attr_reader :interval_description
# Payment schedule for the mandate.
attr_reader :payment_schedule
# Transaction type of the mandate.
attr_reader :transaction_type
end
# Attribute for field mandate_options
attr_reader :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
# Bank account verification method.
attr_reader :verification_method
end
class Affirm < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Preferred language of the Affirm authorization page that the customer is redirected to.
attr_reader :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class AfterpayClearpay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
attr_reader :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Alipay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Alma < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
end
class AmazonPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class AuBecsDebit < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
end
class BacsDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
attr_reader :reference_prefix
end
# Attribute for field mandate_options
attr_reader :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
end
class Bancontact < Stripe::StripeObject
# Preferred language of the Bancontact authorization page that the customer is redirected to.
attr_reader :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Billie < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
end
class Blik < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Boleto < Stripe::StripeObject
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
attr_reader :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Card < Stripe::StripeObject
class Installments < Stripe::StripeObject
class AvailablePlan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
attr_reader :count
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
attr_reader :interval
# Type of installment plan, one of `fixed_count`.
attr_reader :type
end
class Plan < Stripe::StripeObject
# For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
attr_reader :count
# For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
# One of `month`.
attr_reader :interval
# Type of installment plan, one of `fixed_count`.
attr_reader :type
end
# Installment plans that may be selected for this PaymentIntent.
attr_reader :available_plans
# Whether Installments are enabled for this PaymentIntent.
attr_reader :enabled
# Installment plan selected for this PaymentIntent.
attr_reader :plan
end
class MandateOptions < Stripe::StripeObject
# Amount to be charged for future payments.
attr_reader :amount
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
attr_reader :amount_type
# A description of the mandate or subscription that is meant to be displayed to the customer.
attr_reader :description
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
attr_reader :end_date
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
attr_reader :interval
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
attr_reader :interval_count
# Unique identifier for the mandate or subscription.
attr_reader :reference
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
attr_reader :start_date
# Specifies the type of mandates supported. Possible values are `india`.
attr_reader :supported_types
end
class StatementDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field address
attr_reader :address
# Phone number
attr_reader :phone
end
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Installment details for this payment (Mexico only).
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
attr_reader :installments
# Configuration options for setting up an eMandate for cards issued in India.
attr_reader :mandate_options
# Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.
attr_reader :network
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
attr_reader :request_decremental_authorization
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
attr_reader :request_extended_authorization
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
attr_reader :request_incremental_authorization
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
attr_reader :request_multicapture
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
attr_reader :request_overcapture
# Request partial authorization on this PaymentIntent.
attr_reader :request_partial_authorization
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
attr_reader :request_three_d_secure
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
attr_reader :require_cvc_recollection
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor thats set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
attr_reader :statement_descriptor_suffix_kana
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor thats set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
attr_reader :statement_descriptor_suffix_kanji
# Attribute for field statement_details
attr_reader :statement_details
end
class CardPresent < Stripe::StripeObject
class Routing < Stripe::StripeObject
# Requested routing priority
attr_reader :requested_priority
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
attr_reader :request_extended_authorization
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
attr_reader :request_incremental_authorization_support
# Attribute for field routing
attr_reader :routing
end
class Cashapp < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class CustomerBalance < Stripe::StripeObject
class BankTransfer < Stripe::StripeObject
class EuBankTransfer < Stripe::StripeObject
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
attr_reader :country
end
# Attribute for field eu_bank_transfer
attr_reader :eu_bank_transfer
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
attr_reader :requested_address_types
# The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
attr_reader :type
end
# Attribute for field bank_transfer
attr_reader :bank_transfer
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
attr_reader :funding_type
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Eps < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Fpx < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Giropay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Gopay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Grabpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class IdBankTransfer < Stripe::StripeObject
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now till 2678400 seconds (31 days) from now.
attr_reader :expires_after
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
attr_reader :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Ideal < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class InteracPresent < Stripe::StripeObject; end
class KakaoPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Klarna < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Preferred locale of the Klarna checkout page that the customer is redirected to.
attr_reader :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Konbini < Stripe::StripeObject
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.
attr_reader :confirmation_number
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
attr_reader :expires_after_days
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
attr_reader :expires_at
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
attr_reader :product_description
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class KrCard < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Link < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# [Deprecated] This is a legacy parameter that no longer has any function.
attr_reader :persistent_token
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class MbWay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Mobilepay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Multibanco < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class NaverPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class NzBankAccount < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
end
class Oxxo < Stripe::StripeObject
# The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
attr_reader :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class P24 < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
end
class Paynow < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Paypal < Stripe::StripeObject
class LineItem < Stripe::StripeObject
class Tax < Stripe::StripeObject
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
attr_reader :amount
# The tax behavior for the line item.
attr_reader :behavior
end
# Type of the line item.
attr_reader :category
# Description of the line item.
attr_reader :description
# Descriptive name of the line item.
attr_reader :name
# Quantity of the line item. Cannot be a negative number.
attr_reader :quantity
# Client facing stock keeping unit, article number or similar.
attr_reader :sku
# The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).
attr_reader :sold_by
# Attribute for field tax
attr_reader :tax
# Price for a single unit of the line item in minor units. Cannot be a negative number.
attr_reader :unit_amount
end
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# The line items purchased by the customer.
attr_reader :line_items
# Preferred locale of the PayPal checkout page that the customer is redirected to.
attr_reader :preferred_locale
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_reader :reference
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_reader :reference_id
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
attr_reader :subsellers
end
class Payto < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Amount that will be collected. It is required when `amount_type` is `fixed`.
attr_reader :amount
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
attr_reader :amount_type
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
attr_reader :end_date
# The periodicity at which payments will be collected.
attr_reader :payment_schedule
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
attr_reader :payments_per_period
# The purpose for which payments are made. Defaults to retail.
attr_reader :purpose
end
# Attribute for field mandate_options
attr_reader :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Pix < Stripe::StripeObject
# The number of seconds (between 10 and 1209600) after which Pix payment will expire.
attr_reader :expires_after_seconds
# The timestamp at which the Pix expires.
attr_reader :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Promptpay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Qris < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class SamsungPay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
end
class Satispay < Stripe::StripeObject
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
end
class SepaDebit < Stripe::StripeObject
class MandateOptions < Stripe::StripeObject
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
attr_reader :reference_prefix
end
# Attribute for field mandate_options
attr_reader :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
end
class Shopeepay < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Sofort < Stripe::StripeObject
# Preferred language of the SOFORT authorization page that the customer is redirected to.
attr_reader :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class StripeBalance < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Swish < Stripe::StripeObject
# A reference for this payment to be displayed in the Swish app.
attr_reader :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Twint < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class UsBankAccount < Stripe::StripeObject
class FinancialConnections < Stripe::StripeObject
class Filters < Stripe::StripeObject
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
attr_reader :account_subcategories
# The institution to use to filter for possible accounts to link.
attr_reader :institution
end
class ManualEntry < Stripe::StripeObject
# Settings for configuring manual entry of account details.
attr_reader :mode
end
# Attribute for field filters
attr_reader :filters
# Attribute for field manual_entry
attr_reader :manual_entry
# The list of permissions to request. The `payment_method` permission must be included.
attr_reader :permissions
# Data features requested to be retrieved upon account creation.
attr_reader :prefetch
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
attr_reader :return_url
end
class MandateOptions < Stripe::StripeObject
# Mandate collection method
attr_reader :collection_method
end
# Attribute for field financial_connections
attr_reader :financial_connections
# Attribute for field mandate_options
attr_reader :mandate_options
# Preferred transaction settlement speed
attr_reader :preferred_settlement_speed
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_reader :target_date
# Bank account verification method.
attr_reader :verification_method
end
class WechatPay < Stripe::StripeObject
# The app ID registered with WeChat Pay. Only required when client is ios or android.
attr_reader :app_id
# The client type that the end customer will pay from
attr_reader :client
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
class Zip < Stripe::StripeObject
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
end
# Attribute for field acss_debit
attr_reader :acss_debit
# Attribute for field affirm
attr_reader :affirm
# Attribute for field afterpay_clearpay
attr_reader :afterpay_clearpay
# Attribute for field alipay
attr_reader :alipay
# Attribute for field alma
attr_reader :alma
# Attribute for field amazon_pay
attr_reader :amazon_pay
# Attribute for field au_becs_debit
attr_reader :au_becs_debit
# Attribute for field bacs_debit
attr_reader :bacs_debit
# Attribute for field bancontact
attr_reader :bancontact
# Attribute for field billie
attr_reader :billie
# Attribute for field blik
attr_reader :blik
# Attribute for field boleto
attr_reader :boleto
# Attribute for field card
attr_reader :card
# Attribute for field card_present
attr_reader :card_present
# Attribute for field cashapp
attr_reader :cashapp
# Attribute for field customer_balance
attr_reader :customer_balance
# Attribute for field eps
attr_reader :eps
# Attribute for field fpx
attr_reader :fpx
# Attribute for field giropay
attr_reader :giropay
# Attribute for field gopay
attr_reader :gopay
# Attribute for field grabpay
attr_reader :grabpay
# Attribute for field id_bank_transfer
attr_reader :id_bank_transfer
# Attribute for field ideal
attr_reader :ideal
# Attribute for field interac_present
attr_reader :interac_present
# Attribute for field kakao_pay
attr_reader :kakao_pay
# Attribute for field klarna
attr_reader :klarna
# Attribute for field konbini
attr_reader :konbini
# Attribute for field kr_card
attr_reader :kr_card
# Attribute for field link
attr_reader :link
# Attribute for field mb_way
attr_reader :mb_way
# Attribute for field mobilepay
attr_reader :mobilepay
# Attribute for field multibanco
attr_reader :multibanco
# Attribute for field naver_pay
attr_reader :naver_pay
# Attribute for field nz_bank_account
attr_reader :nz_bank_account
# Attribute for field oxxo
attr_reader :oxxo
# Attribute for field p24
attr_reader :p24
# Attribute for field pay_by_bank
attr_reader :pay_by_bank
# Attribute for field payco
attr_reader :payco
# Attribute for field paynow
attr_reader :paynow
# Attribute for field paypal
attr_reader :paypal
# Attribute for field payto
attr_reader :payto
# Attribute for field pix
attr_reader :pix
# Attribute for field promptpay
attr_reader :promptpay
# Attribute for field qris
attr_reader :qris
# Attribute for field rechnung
attr_reader :rechnung
# Attribute for field revolut_pay
attr_reader :revolut_pay
# Attribute for field samsung_pay
attr_reader :samsung_pay
# Attribute for field satispay
attr_reader :satispay
# Attribute for field sepa_debit
attr_reader :sepa_debit
# Attribute for field shopeepay
attr_reader :shopeepay
# Attribute for field sofort
attr_reader :sofort
# Attribute for field stripe_balance
attr_reader :stripe_balance
# Attribute for field swish
attr_reader :swish
# Attribute for field twint
attr_reader :twint
# Attribute for field us_bank_account
attr_reader :us_bank_account
# Attribute for field wechat_pay
attr_reader :wechat_pay
# Attribute for field zip
attr_reader :zip
end
class PresentmentDetails < Stripe::StripeObject
# Amount intended to be collected by this payment, denominated in presentment_currency.
attr_reader :presentment_amount
# Currency presented to the customer during payment.
attr_reader :presentment_currency
end
class Processing < Stripe::StripeObject
class Card < Stripe::StripeObject
class CustomerNotification < Stripe::StripeObject
# Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.
attr_reader :approval_requested
# If customer approval is required, they need to provide approval before this time.
attr_reader :completes_at
end
# Attribute for field customer_notification
attr_reader :customer_notification
end
# Attribute for field card
attr_reader :card
# Type of the payment method for which payment is in `processing` state, one of `card`.
attr_reader :type
end
class Shipping < Stripe::StripeObject
class Address < Stripe::StripeObject
# City, district, suburb, town, or village.
attr_reader :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_reader :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_reader :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_reader :line2
# ZIP or postal code.
attr_reader :postal_code
# State, county, province, or region.
attr_reader :state
end
# Attribute for field address
attr_reader :address
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
attr_reader :carrier
# Recipient name.
attr_reader :name
# Recipient phone (including extension).
attr_reader :phone
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
attr_reader :tracking_number
end
class TransferData < Stripe::StripeObject
# The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.
# The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer
# representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).
attr_reader :amount
# The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.
attr_reader :destination
end
class ListParams < Stripe::RequestParams
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
attr_accessor :gt
# Minimum value to filter by (inclusive)
attr_accessor :gte
# Maximum value to filter by (exclusive)
attr_accessor :lt
# Maximum value to filter by (inclusive)
attr_accessor :lte
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
@gt = gt
@gte = gte
@lt = lt
@lte = lte
end
end
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
attr_accessor :created
# Only return PaymentIntents for the customer that this customer ID specifies.
attr_accessor :customer
# Only return PaymentIntents for the account that this ID specifies.
attr_accessor :customer_account
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
attr_accessor :ending_before
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
attr_accessor :limit
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
attr_accessor :starting_after
def initialize(
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
starting_after: nil
)
@created = created
@customer = customer
@customer_account = customer_account
@ending_before = ending_before
@expand = expand
@limit = limit
@starting_after = starting_after
end
end
class CreateParams < Stripe::RequestParams
class AutomaticPaymentMethods < Stripe::RequestParams
# Controls whether this PaymentIntent will accept redirect-based payment methods.
#
# Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
attr_accessor :allow_redirects
# Whether this feature is enabled.
attr_accessor :enabled
def initialize(allow_redirects: nil, enabled: nil)
@allow_redirects = allow_redirects
@enabled = enabled
end
end
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
attr_accessor :ip_address
# The user agent of the browser from which the Mandate was accepted by the customer.
attr_accessor :user_agent
def initialize(ip_address: nil, user_agent: nil)
@ip_address = ip_address
@user_agent = user_agent
end
end
# The time at which the customer accepted the Mandate.
attr_accessor :accepted_at
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
attr_accessor :offline
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
attr_accessor :online
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
attr_accessor :type
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil)
@accepted_at = accepted_at
@offline = offline
@online = online
@type = type
end
end
# This hash contains details about the customer acceptance of the Mandate.
attr_accessor :customer_acceptance
def initialize(customer_acceptance: nil)
@customer_acceptance = customer_acceptance
end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Distance < Stripe::RequestParams
# Distance traveled.
attr_accessor :amount
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
attr_accessor :unit
def initialize(amount: nil, unit: nil)
@amount = amount
@unit = unit
end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
attr_accessor :driver_identification_number
# Driver's tax number.
attr_accessor :driver_tax_number
# Full name of the person or entity on the car reservation.
attr_accessor :name
def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
@driver_identification_number = driver_identification_number
@driver_tax_number = driver_tax_number
@name = name
end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the car rental.
attr_accessor :booking_number
# Class code of the car.
attr_accessor :car_class_code
# Make of the car.
attr_accessor :car_make
# Model of the car.
attr_accessor :car_model
# The name of the rental car company.
attr_accessor :company
# The customer service phone number of the car rental company.
attr_accessor :customer_service_phone_number
# Number of days the car is being rented.
attr_accessor :days_rented
# Delivery details for this purchase.
attr_accessor :delivery
# The details of the distance traveled during the rental period.
attr_accessor :distance
# The details of the passengers in the travel reservation
attr_accessor :drivers
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates if the customer did not keep nor cancel their booking.
attr_accessor :no_show
# Car pick-up address.
attr_accessor :pickup_address
# Car pick-up time. Measured in seconds since the Unix epoch.
attr_accessor :pickup_at
# Name of the pickup location.
attr_accessor :pickup_location_name
# Rental rate.
attr_accessor :rate_amount
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
attr_accessor :rate_interval
# The name of the person or entity renting the car.
attr_accessor :renter_name
# Car return address.
attr_accessor :return_address
# Car return time. Measured in seconds since the Unix epoch.
attr_accessor :return_at
# Name of the return location.
attr_accessor :return_location_name
# Indicates whether the goods or services are tax-exempt or tax is not collected.
attr_accessor :tax_exempt
# The vehicle identification number.
attr_accessor :vehicle_identification_number
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
)
@affiliate = affiliate
@booking_number = booking_number
@car_class_code = car_class_code
@car_make = car_make
@car_model = car_model
@company = company
@customer_service_phone_number = customer_service_phone_number
@days_rented = days_rented
@delivery = delivery
@distance = distance
@drivers = drivers
@extra_charges = extra_charges
@no_show = no_show
@pickup_address = pickup_address
@pickup_at = pickup_at
@pickup_location_name = pickup_location_name
@rate_amount = rate_amount
@rate_interval = rate_interval
@renter_name = renter_name
@return_address = return_address
@return_at = return_at
@return_location_name = return_location_name
@tax_exempt = tax_exempt
@vehicle_identification_number = vehicle_identification_number
end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
# Indicates if the tickets are digitally checked when entering the venue.
attr_accessor :access_controlled_venue
# The event location's address.
attr_accessor :address
# Affiliate details for this purchase.
attr_accessor :affiliate
# The name of the company
attr_accessor :company
# Delivery details for this purchase.
attr_accessor :delivery
# Event end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Type of the event entertainment (concert, sports event etc)
attr_accessor :genre
# The name of the event.
attr_accessor :name
# Event start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
)
@access_controlled_venue = access_controlled_venue
@address = address
@affiliate = affiliate
@company = company
@delivery = delivery
@ends_at = ends_at
@genre = genre
@name = name
@starts_at = starts_at
end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
attr_accessor :amount
# The International Air Transport Association (IATA) airport code for the arrival airport.
attr_accessor :arrival_airport
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :arrives_at
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
attr_accessor :carrier
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :departs_at
# The International Air Transport Association (IATA) airport code for the departure airport.
attr_accessor :departure_airport
# The flight number associated with the segment
attr_accessor :flight_number
# The fare class for the segment.
attr_accessor :service_class
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
)
@amount = amount
@arrival_airport = arrival_airport
@arrives_at = arrives_at
@carrier = carrier
@departs_at = departs_at
@departure_airport = departure_airport
@flight_number = flight_number
@service_class = service_class
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
attr_accessor :agency_number
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
attr_accessor :carrier
# Delivery details for this purchase.
attr_accessor :delivery
# The name of the person or entity on the reservation.
attr_accessor :passenger_name
# The details of the passengers in the travel reservation.
attr_accessor :passengers
# The individual flight segments associated with the trip.
attr_accessor :segments
# The ticket number associated with the travel reservation.
attr_accessor :ticket_number
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
)
@affiliate = affiliate
@agency_number = agency_number
@carrier = carrier
@delivery = delivery
@passenger_name = passenger_name
@passengers = passengers
@segments = segments
@ticket_number = ticket_number
end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
# The lodging location's address.
attr_accessor :address
# The number of adults on the booking
attr_accessor :adults
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the lodging reservation.
attr_accessor :booking_number
# The lodging category
attr_accessor :category
# Lodging check-in time. Measured in seconds since the Unix epoch.
attr_accessor :checkin_at
# Lodging check-out time. Measured in seconds since the Unix epoch.
attr_accessor :checkout_at
# The customer service phone number of the lodging company.
attr_accessor :customer_service_phone_number
# The daily lodging room rate.
attr_accessor :daily_room_rate_amount
# Delivery details for this purchase.
attr_accessor :delivery
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates whether the lodging location is compliant with the Fire Safety Act.
attr_accessor :fire_safety_act_compliance
# The name of the lodging location.
attr_accessor :name
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
attr_accessor :no_show
# The number of rooms on the booking
attr_accessor :number_of_rooms
# The details of the passengers in the travel reservation
attr_accessor :passengers
# The phone number of the lodging location.
attr_accessor :property_phone_number
# The room class for this purchase.
attr_accessor :room_class
# The number of room nights
attr_accessor :room_nights
# The total tax amount associating with the room reservation.
attr_accessor :total_room_tax_amount
# The total tax amount
attr_accessor :total_tax_amount
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
)
@address = address
@adults = adults
@affiliate = affiliate
@booking_number = booking_number
@category = category
@checkin_at = checkin_at
@checkout_at = checkout_at
@customer_service_phone_number = customer_service_phone_number
@daily_room_rate_amount = daily_room_rate_amount
@delivery = delivery
@extra_charges = extra_charges
@fire_safety_act_compliance = fire_safety_act_compliance
@name = name
@no_show = no_show
@number_of_rooms = number_of_rooms
@passengers = passengers
@property_phone_number = property_phone_number
@room_class = room_class
@room_nights = room_nights
@total_room_tax_amount = total_room_tax_amount
@total_tax_amount = total_tax_amount
end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :count
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
def initialize(count: nil, interval: nil)
@count = count
@interval = interval
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# Info whether the subscription will be auto renewed upon expiry.
attr_accessor :auto_renewal
# Subscription billing details for this purchase.
attr_accessor :billing_interval
# Subscription end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Name of the product on subscription. e.g. Apple Music Subscription
attr_accessor :name
# Subscription start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
)
@affiliate = affiliate
@auto_renewal = auto_renewal
@billing_interval = billing_interval
@ends_at = ends_at
@name = name
@starts_at = starts_at
end
end
# Car rental details for this PaymentIntent.
attr_accessor :car_rental
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
attr_accessor :customer_reference
# Event details for this PaymentIntent
attr_accessor :event_details
# Flight reservation details for this PaymentIntent
attr_accessor :flight
# Lodging reservation details for this PaymentIntent
attr_accessor :lodging
# A unique value assigned by the business to identify the transaction.
attr_accessor :order_reference
# Subscription details for this PaymentIntent
attr_accessor :subscription
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
)
@car_rental = car_rental
@customer_reference = customer_reference
@event_details = event_details
@flight = flight
@lodging = lodging
@order_reference = order_reference
@subscription = subscription
end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
attr_accessor :account_number
# Institution number of the customer's bank.
attr_accessor :institution_number
# Transit number of the customer's bank.
attr_accessor :transit_number
def initialize(account_number: nil, institution_number: nil, transit_number: nil)
@account_number = account_number
@institution_number = institution_number
@transit_number = transit_number
end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
def initialize(account_number: nil, bsb_number: nil)
@account_number = account_number
@bsb_number = bsb_number
end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
attr_accessor :account_number
# Sort code of the bank account. (e.g., `10-20-30`)
attr_accessor :sort_code
def initialize(account_number: nil, sort_code: nil)
@account_number = account_number
@sort_code = sort_code
end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Billing address.
attr_accessor :address
# Email address.
attr_accessor :email
# Full name.
attr_accessor :name
# Billing phone number (including extension).
attr_accessor :phone
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
attr_accessor :tax_id
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil)
@address = address
@email = email
@name = name
@phone = phone
@tax_id = tax_id
end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
attr_accessor :tax_id
def initialize(tax_id: nil)
@tax_id = tax_id
end
end
class Cashapp < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
attr_accessor :account_holder_type
# The customer's bank.
attr_accessor :bank
def initialize(account_holder_type: nil, bank: nil)
@account_holder_type = account_holder_type
@bank = bank
end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
attr_accessor :funding
def initialize(funding: nil)
@funding = funding
end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethods billing details.
attr_accessor :account_holder_name
# The account number for the bank account.
attr_accessor :account_number
# The numeric code for the bank account's bank.
attr_accessor :bank_code
# The numeric code for the bank account's bank branch.
attr_accessor :branch_code
# Attribute for param field reference
attr_accessor :reference
# The suffix of the bank account number.
attr_accessor :suffix
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
)
@account_holder_name = account_holder_name
@account_number = account_number
@bank_code = bank_code
@branch_code = branch_code
@reference = reference
@suffix = suffix
end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
# The PayID alias for the bank account.
attr_accessor :pay_id
def initialize(account_number: nil, bsb_number: nil, pay_id: nil)
@account_number = account_number
@bsb_number = bsb_number
@pay_id = pay_id
end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
attr_accessor :session
def initialize(session: nil)
@session = session
end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
attr_accessor :iban
def initialize(iban: nil)
@iban = iban
end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
attr_accessor :account
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
attr_accessor :source_type
def initialize(account: nil, source_type: nil)
@account = account
@source_type = source_type
end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
attr_accessor :account_holder_type
# Account number of the bank account.
attr_accessor :account_number
# Account type: checkings or savings. Defaults to checking if omitted.
attr_accessor :account_type
# The ID of a Financial Connections Account to use as a payment method.
attr_accessor :financial_connections_account
# Routing number of the bank account.
attr_accessor :routing_number
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
)
@account_holder_type = account_holder_type
@account_number = account_number
@account_type = account_type
@financial_connections_account = financial_connections_account
@routing_number = routing_number
end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
attr_accessor :affirm
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
attr_accessor :afterpay_clearpay
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
attr_accessor :alipay
# 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`.
attr_accessor :allow_redisplay
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
attr_accessor :alma
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
attr_accessor :amazon_pay
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
attr_accessor :billie
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
attr_accessor :billing_details
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
attr_accessor :boleto
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
attr_accessor :cashapp
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
attr_accessor :customer_balance
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
attr_accessor :eps
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
attr_accessor :giropay
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
attr_accessor :grabpay
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
attr_accessor :id_bank_transfer
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
attr_accessor :ideal
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
attr_accessor :kr_card
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
attr_accessor :link
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
attr_accessor :mb_way
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
attr_accessor :naver_pay
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
attr_accessor :nz_bank_account
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
attr_accessor :qris
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
attr_accessor :radar_options
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
attr_accessor :sepa_debit
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
attr_accessor :sofort
# This hash contains details about the Stripe balance payment method.
attr_accessor :stripe_balance
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
attr_accessor :swish
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
attr_accessor :twint
# 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.
attr_accessor :type
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
attr_accessor :us_bank_account
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@allow_redisplay = allow_redisplay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@billing_details = billing_details
@blik = blik
@boleto = boleto
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@metadata = metadata
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@radar_options = radar_options
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@type = type
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
attr_accessor :custom_mandate_url
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
attr_accessor :interval_description
# Payment schedule for the mandate.
attr_accessor :payment_schedule
# Transaction type of the mandate.
attr_accessor :transaction_type
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
)
@custom_mandate_url = custom_mandate_url
@interval_description = interval_description
@payment_schedule = payment_schedule
@transaction_type = transaction_type
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Affirm authorization page that the customer is redirected to.
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil)
@capture_method = capture_method
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
attr_accessor :code
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(code: nil, setup_future_usage: nil)
@code = code
@setup_future_usage = setup_future_usage
end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
attr_accessor :count
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
attr_accessor :interval
# Type of installment plan, one of `fixed_count`.
attr_accessor :type
def initialize(count: nil, interval: nil, type: nil)
@count = count
@interval = interval
@type = type
end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
attr_accessor :enabled
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
attr_accessor :plan
def initialize(enabled: nil, plan: nil)
@enabled = enabled
@plan = plan
end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
attr_accessor :amount
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
attr_accessor :amount_type
# A description of the mandate or subscription that is meant to be displayed to the customer.
attr_accessor :description
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
attr_accessor :end_date
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
attr_accessor :interval
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
attr_accessor :interval_count
# Unique identifier for the mandate or subscription.
attr_accessor :reference
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
attr_accessor :start_date
# Specifies the type of mandates supported. Possible values are `india`.
attr_accessor :supported_types
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
)
@amount = amount
@amount_type = amount_type
@description = description
@end_date = end_date
@interval = interval
@interval_count = interval_count
@reference = reference
@start_date = start_date
@supported_types = supported_types
end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Please pass in an address that is within your Stripe user account country
attr_accessor :address
# Phone number (e.g., a toll-free number that customers can call)
attr_accessor :phone
def initialize(address: nil, phone: nil)
@address = address
@phone = phone
end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
attr_accessor :cb_avalgo
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
attr_accessor :cb_exemption
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
attr_accessor :cb_score
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil)
@cb_avalgo = cb_avalgo
@cb_exemption = cb_exemption
@cb_score = cb_score
end
end
# Cartes Bancaires-specific 3DS fields.
attr_accessor :cartes_bancaires
def initialize(cartes_bancaires: nil)
@cartes_bancaires = cartes_bancaires
end
end
# The `transStatus` returned from the card Issuers ACS in the ARes.
attr_accessor :ares_trans_status
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
attr_accessor :cryptogram
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
attr_accessor :electronic_commerce_indicator
# The exemption requested via 3DS and accepted by the issuer at authentication time.
attr_accessor :exemption_indicator
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
attr_accessor :network_options
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
attr_accessor :requestor_challenge_indicator
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
attr_accessor :transaction_id
# The version of 3D Secure that was performed.
attr_accessor :version
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
)
@ares_trans_status = ares_trans_status
@cryptogram = cryptogram
@electronic_commerce_indicator = electronic_commerce_indicator
@exemption_indicator = exemption_indicator
@network_options = network_options
@requestor_challenge_indicator = requestor_challenge_indicator
@transaction_id = transaction_id
@version = version
end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
attr_accessor :cvc_token
# Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
attr_accessor :installments
# Configuration options for setting up an eMandate for cards issued in India.
attr_accessor :mandate_options
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
attr_accessor :moto
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
attr_accessor :network
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
attr_accessor :request_decremental_authorization
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
attr_accessor :request_extended_authorization
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
attr_accessor :request_incremental_authorization
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
attr_accessor :request_multicapture
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
attr_accessor :request_overcapture
# Request partial authorization on this PaymentIntent.
attr_accessor :request_partial_authorization
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
attr_accessor :request_three_d_secure
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
attr_accessor :require_cvc_recollection
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor thats set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
attr_accessor :statement_descriptor_suffix_kana
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor thats set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
attr_accessor :statement_descriptor_suffix_kanji
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
attr_accessor :statement_details
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
attr_accessor :three_d_secure
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
)
@capture_method = capture_method
@cvc_token = cvc_token
@installments = installments
@mandate_options = mandate_options
@moto = moto
@network = network
@request_decremental_authorization = request_decremental_authorization
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization = request_incremental_authorization
@request_multicapture = request_multicapture
@request_overcapture = request_overcapture
@request_partial_authorization = request_partial_authorization
@request_three_d_secure = request_three_d_secure
@require_cvc_recollection = require_cvc_recollection
@setup_future_usage = setup_future_usage
@statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
@statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
@statement_details = statement_details
@three_d_secure = three_d_secure
end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
attr_accessor :requested_priority
def initialize(requested_priority: nil)
@requested_priority = requested_priority
end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
attr_accessor :request_extended_authorization
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
attr_accessor :request_incremental_authorization_support
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
attr_accessor :routing
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
)
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization_support = request_incremental_authorization_support
@routing = routing
end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
# Configuration for the eu_bank_transfer funding type.
attr_accessor :eu_bank_transfer
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
attr_accessor :requested_address_types
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
attr_accessor :type
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
@eu_bank_transfer = eu_bank_transfer
@requested_address_types = requested_address_types
@type = type
end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
attr_accessor :bank_transfer
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
attr_accessor :funding_type
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil)
@bank_transfer = bank_transfer
@funding_type = funding_type
@setup_future_usage = setup_future_usage
end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
attr_accessor :expires_after
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil)
@expires_after = expires_after
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Klarna < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Klarna authorization page that the customer is redirected to
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
attr_accessor :confirmation_number
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
attr_accessor :expires_after_days
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
attr_accessor :expires_at
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
attr_accessor :product_description
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
)
@confirmation_number = confirmation_number
@expires_after_days = expires_after_days
@expires_at = expires_at
@product_description = product_description
@setup_future_usage = setup_future_usage
end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# [Deprecated] This is a legacy parameter that no longer has any function.
attr_accessor :persistent_token
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil)
@capture_method = capture_method
@persistent_token = persistent_token
@setup_future_usage = setup_future_usage
end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Confirm that the payer has accepted the P24 terms and conditions.
attr_accessor :tos_shown_and_accepted
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil)
@setup_future_usage = setup_future_usage
@tos_shown_and_accepted = tos_shown_and_accepted
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :amount
# The tax behavior for the line item.
attr_accessor :behavior
def initialize(amount: nil, behavior: nil)
@amount = amount
@behavior = behavior
end
end
# Type of the line item.
attr_accessor :category
# Description of the line item.
attr_accessor :description
# Descriptive name of the line item.
attr_accessor :name
# Quantity of the line item. Must be a positive number.
attr_accessor :quantity
# Client facing stock keeping unit, article number or similar.
attr_accessor :sku
# The Stripe account ID of the connected account that sells the item.
attr_accessor :sold_by
# The tax information for the line item.
attr_accessor :tax
# Price for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :unit_amount
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
)
@category = category
@description = description
@name = name
@quantity = quantity
@sku = sku
@sold_by = sold_by
@tax = tax
@unit_amount = unit_amount
end
end
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# The line items purchased by the customer.
attr_accessor :line_items
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
attr_accessor :preferred_locale
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference_id
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
attr_accessor :risk_correlation_id
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
attr_accessor :subsellers
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
)
@capture_method = capture_method
@line_items = line_items
@preferred_locale = preferred_locale
@reference = reference
@reference_id = reference_id
@risk_correlation_id = risk_correlation_id
@setup_future_usage = setup_future_usage
@subsellers = subsellers
end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
attr_accessor :amount
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
attr_accessor :amount_type
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
attr_accessor :end_date
# The periodicity at which payments will be collected.
attr_accessor :payment_schedule
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
attr_accessor :payments_per_period
# The purpose for which payments are made. Defaults to retail.
attr_accessor :purpose
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
)
@amount = amount
@amount_type = amount_type
@end_date = end_date
@payment_schedule = payment_schedule
@payments_per_period = payments_per_period
@purpose = purpose
end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(mandate_options: nil, setup_future_usage: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
end
end
class Pix < Stripe::RequestParams
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
attr_accessor :expires_after_seconds
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
@expires_after_seconds = expires_after_seconds
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(reference: nil, setup_future_usage: nil)
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
attr_accessor :account_subcategories
# ID of the institution to use to filter for selectable accounts.
attr_accessor :institution
def initialize(account_subcategories: nil, institution: nil)
@account_subcategories = account_subcategories
@institution = institution
end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
attr_accessor :mode
def initialize(mode: nil)
@mode = mode
end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
attr_accessor :filters
# Customize manual entry behavior
attr_accessor :manual_entry
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
attr_accessor :permissions
# List of data features that you would like to retrieve upon account creation.
attr_accessor :prefetch
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
attr_accessor :return_url
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
)
@filters = filters
@manual_entry = manual_entry
@permissions = permissions
@prefetch = prefetch
@return_url = return_url
end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
attr_accessor :collection_method
def initialize(collection_method: nil)
@collection_method = collection_method
end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
attr_accessor :requested
def initialize(requested: nil)
@requested = requested
end
end
# Additional fields for Financial Connections Session creation
attr_accessor :financial_connections
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Additional fields for network related functions
attr_accessor :networks
# Preferred transaction settlement speed
attr_accessor :preferred_settlement_speed
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@financial_connections = financial_connections
@mandate_options = mandate_options
@networks = networks
@preferred_settlement_speed = preferred_settlement_speed
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
attr_accessor :app_id
# The client type that the end customer will pay from
attr_accessor :client
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(app_id: nil, client: nil, setup_future_usage: nil)
@app_id = app_id
@client = client
@setup_future_usage = setup_future_usage
end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
attr_accessor :affirm
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
attr_accessor :afterpay_clearpay
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
attr_accessor :alipay
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
attr_accessor :alma
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
attr_accessor :amazon_pay
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
attr_accessor :billie
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
attr_accessor :boleto
# Configuration for any card payments attempted on this PaymentIntent.
attr_accessor :card
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :card_present
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
attr_accessor :cashapp
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
attr_accessor :customer_balance
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
attr_accessor :eps
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
attr_accessor :giropay
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
attr_accessor :grabpay
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
attr_accessor :id_bank_transfer
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
attr_accessor :ideal
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
attr_accessor :kr_card
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
attr_accessor :link
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
attr_accessor :mb_way
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
attr_accessor :naver_pay
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
attr_accessor :nz_bank_account
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
attr_accessor :qris
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
attr_accessor :sepa_debit
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
attr_accessor :sofort
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
attr_accessor :stripe_balance
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
attr_accessor :swish
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
attr_accessor :twint
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
attr_accessor :us_bank_account
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@blik = blik
@boleto = boleto
@card = card
@card_present = card_present
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
attr_accessor :session
def initialize(session: nil)
@session = session
end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Shipping address.
attr_accessor :address
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
attr_accessor :carrier
# Recipient name.
attr_accessor :name
# Recipient phone (including extension).
attr_accessor :phone
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
attr_accessor :tracking_number
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
@address = address
@carrier = carrier
@name = name
@phone = phone
@tracking_number = tracking_number
end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
# The amount is capped at the total transaction amount and if no amount is set,
# the full amount is transferred.
#
# If you intend to collect a fee and you need a more robust reporting experience, using
# [application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)
# might be a better fit for your integration.
attr_accessor :amount
# If specified, successful charges will be attributed to the destination
# account for tax reporting, and the funds from charges will be transferred
# to the destination account. The ID of the resulting transfer will be
# returned on the successful charge's `transfer` field.
attr_accessor :destination
def initialize(amount: nil, destination: nil)
@amount = amount
@destination = destination
end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
attr_accessor :amount
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
attr_accessor :automatic_payment_methods
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).
attr_accessor :confirm
# Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
attr_accessor :confirmation_method
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
attr_accessor :confirmation_token
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
attr_accessor :customer
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
attr_accessor :customer_account
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_accessor :description
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
attr_accessor :error_on_requires_action
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
attr_accessor :fx_quote
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
attr_accessor :mandate
# This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
attr_accessor :mandate_data
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
attr_accessor :off_session
# The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :on_behalf_of
# Provides industry-specific information about the charge.
attr_accessor :payment_details
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.
#
# If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.
# If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent.
# end
attr_accessor :payment_method
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
attr_accessor :payment_method_configuration
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
attr_accessor :payment_method_data
# Payment method-specific configuration for this PaymentIntent.
attr_accessor :payment_method_options
# The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
attr_accessor :payment_method_types
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
attr_accessor :radar_options
# Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).
attr_accessor :receipt_email
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
attr_accessor :return_url
# Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.
attr_accessor :secret_key_confirmation
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
# Shipping information for this PaymentIntent.
attr_accessor :shipping
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
attr_accessor :statement_descriptor
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
attr_accessor :statement_descriptor_suffix
# The parameters that you can use to automatically create a Transfer.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_data
# A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
attr_accessor :transfer_group
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
attr_accessor :use_stripe_sdk
def initialize(
amount: nil,
application_fee_amount: nil,
automatic_payment_methods: nil,
capture_method: nil,
confirm: nil,
confirmation_method: nil,
confirmation_token: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
error_on_requires_action: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
metadata: nil,
off_session: nil,
on_behalf_of: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
secret_key_confirmation: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil,
use_stripe_sdk: nil
)
@amount = amount
@application_fee_amount = application_fee_amount
@automatic_payment_methods = automatic_payment_methods
@capture_method = capture_method
@confirm = confirm
@confirmation_method = confirmation_method
@confirmation_token = confirmation_token
@currency = currency
@customer = customer
@customer_account = customer_account
@description = description
@error_on_requires_action = error_on_requires_action
@expand = expand
@fx_quote = fx_quote
@hooks = hooks
@mandate = mandate
@mandate_data = mandate_data
@metadata = metadata
@off_session = off_session
@on_behalf_of = on_behalf_of
@payment_details = payment_details
@payment_method = payment_method
@payment_method_configuration = payment_method_configuration
@payment_method_data = payment_method_data
@payment_method_options = payment_method_options
@payment_method_types = payment_method_types
@radar_options = radar_options
@receipt_email = receipt_email
@return_url = return_url
@secret_key_confirmation = secret_key_confirmation
@setup_future_usage = setup_future_usage
@shipping = shipping
@statement_descriptor = statement_descriptor
@statement_descriptor_suffix = statement_descriptor_suffix
@transfer_data = transfer_data
@transfer_group = transfer_group
@use_stripe_sdk = use_stripe_sdk
end
end
class UpdateParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
attr_accessor :ip_address
# The user agent of the browser from which the Mandate was accepted by the customer.
attr_accessor :user_agent
def initialize(ip_address: nil, user_agent: nil)
@ip_address = ip_address
@user_agent = user_agent
end
end
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
attr_accessor :online
# The type of customer acceptance information included with the Mandate.
attr_accessor :type
def initialize(online: nil, type: nil)
@online = online
@type = type
end
end
# This hash contains details about the customer acceptance of the Mandate.
attr_accessor :customer_acceptance
def initialize(customer_acceptance: nil)
@customer_acceptance = customer_acceptance
end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Distance < Stripe::RequestParams
# Distance traveled.
attr_accessor :amount
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
attr_accessor :unit
def initialize(amount: nil, unit: nil)
@amount = amount
@unit = unit
end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
attr_accessor :driver_identification_number
# Driver's tax number.
attr_accessor :driver_tax_number
# Full name of the person or entity on the car reservation.
attr_accessor :name
def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
@driver_identification_number = driver_identification_number
@driver_tax_number = driver_tax_number
@name = name
end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the car rental.
attr_accessor :booking_number
# Class code of the car.
attr_accessor :car_class_code
# Make of the car.
attr_accessor :car_make
# Model of the car.
attr_accessor :car_model
# The name of the rental car company.
attr_accessor :company
# The customer service phone number of the car rental company.
attr_accessor :customer_service_phone_number
# Number of days the car is being rented.
attr_accessor :days_rented
# Delivery details for this purchase.
attr_accessor :delivery
# The details of the distance traveled during the rental period.
attr_accessor :distance
# The details of the passengers in the travel reservation
attr_accessor :drivers
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates if the customer did not keep nor cancel their booking.
attr_accessor :no_show
# Car pick-up address.
attr_accessor :pickup_address
# Car pick-up time. Measured in seconds since the Unix epoch.
attr_accessor :pickup_at
# Name of the pickup location.
attr_accessor :pickup_location_name
# Rental rate.
attr_accessor :rate_amount
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
attr_accessor :rate_interval
# The name of the person or entity renting the car.
attr_accessor :renter_name
# Car return address.
attr_accessor :return_address
# Car return time. Measured in seconds since the Unix epoch.
attr_accessor :return_at
# Name of the return location.
attr_accessor :return_location_name
# Indicates whether the goods or services are tax-exempt or tax is not collected.
attr_accessor :tax_exempt
# The vehicle identification number.
attr_accessor :vehicle_identification_number
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
)
@affiliate = affiliate
@booking_number = booking_number
@car_class_code = car_class_code
@car_make = car_make
@car_model = car_model
@company = company
@customer_service_phone_number = customer_service_phone_number
@days_rented = days_rented
@delivery = delivery
@distance = distance
@drivers = drivers
@extra_charges = extra_charges
@no_show = no_show
@pickup_address = pickup_address
@pickup_at = pickup_at
@pickup_location_name = pickup_location_name
@rate_amount = rate_amount
@rate_interval = rate_interval
@renter_name = renter_name
@return_address = return_address
@return_at = return_at
@return_location_name = return_location_name
@tax_exempt = tax_exempt
@vehicle_identification_number = vehicle_identification_number
end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
# Indicates if the tickets are digitally checked when entering the venue.
attr_accessor :access_controlled_venue
# The event location's address.
attr_accessor :address
# Affiliate details for this purchase.
attr_accessor :affiliate
# The name of the company
attr_accessor :company
# Delivery details for this purchase.
attr_accessor :delivery
# Event end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Type of the event entertainment (concert, sports event etc)
attr_accessor :genre
# The name of the event.
attr_accessor :name
# Event start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
)
@access_controlled_venue = access_controlled_venue
@address = address
@affiliate = affiliate
@company = company
@delivery = delivery
@ends_at = ends_at
@genre = genre
@name = name
@starts_at = starts_at
end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
attr_accessor :amount
# The International Air Transport Association (IATA) airport code for the arrival airport.
attr_accessor :arrival_airport
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :arrives_at
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
attr_accessor :carrier
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :departs_at
# The International Air Transport Association (IATA) airport code for the departure airport.
attr_accessor :departure_airport
# The flight number associated with the segment
attr_accessor :flight_number
# The fare class for the segment.
attr_accessor :service_class
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
)
@amount = amount
@arrival_airport = arrival_airport
@arrives_at = arrives_at
@carrier = carrier
@departs_at = departs_at
@departure_airport = departure_airport
@flight_number = flight_number
@service_class = service_class
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
attr_accessor :agency_number
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
attr_accessor :carrier
# Delivery details for this purchase.
attr_accessor :delivery
# The name of the person or entity on the reservation.
attr_accessor :passenger_name
# The details of the passengers in the travel reservation.
attr_accessor :passengers
# The individual flight segments associated with the trip.
attr_accessor :segments
# The ticket number associated with the travel reservation.
attr_accessor :ticket_number
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
)
@affiliate = affiliate
@agency_number = agency_number
@carrier = carrier
@delivery = delivery
@passenger_name = passenger_name
@passengers = passengers
@segments = segments
@ticket_number = ticket_number
end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
# The lodging location's address.
attr_accessor :address
# The number of adults on the booking
attr_accessor :adults
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the lodging reservation.
attr_accessor :booking_number
# The lodging category
attr_accessor :category
# Lodging check-in time. Measured in seconds since the Unix epoch.
attr_accessor :checkin_at
# Lodging check-out time. Measured in seconds since the Unix epoch.
attr_accessor :checkout_at
# The customer service phone number of the lodging company.
attr_accessor :customer_service_phone_number
# The daily lodging room rate.
attr_accessor :daily_room_rate_amount
# Delivery details for this purchase.
attr_accessor :delivery
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates whether the lodging location is compliant with the Fire Safety Act.
attr_accessor :fire_safety_act_compliance
# The name of the lodging location.
attr_accessor :name
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
attr_accessor :no_show
# The number of rooms on the booking
attr_accessor :number_of_rooms
# The details of the passengers in the travel reservation
attr_accessor :passengers
# The phone number of the lodging location.
attr_accessor :property_phone_number
# The room class for this purchase.
attr_accessor :room_class
# The number of room nights
attr_accessor :room_nights
# The total tax amount associating with the room reservation.
attr_accessor :total_room_tax_amount
# The total tax amount
attr_accessor :total_tax_amount
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
)
@address = address
@adults = adults
@affiliate = affiliate
@booking_number = booking_number
@category = category
@checkin_at = checkin_at
@checkout_at = checkout_at
@customer_service_phone_number = customer_service_phone_number
@daily_room_rate_amount = daily_room_rate_amount
@delivery = delivery
@extra_charges = extra_charges
@fire_safety_act_compliance = fire_safety_act_compliance
@name = name
@no_show = no_show
@number_of_rooms = number_of_rooms
@passengers = passengers
@property_phone_number = property_phone_number
@room_class = room_class
@room_nights = room_nights
@total_room_tax_amount = total_room_tax_amount
@total_tax_amount = total_tax_amount
end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :count
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
def initialize(count: nil, interval: nil)
@count = count
@interval = interval
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# Info whether the subscription will be auto renewed upon expiry.
attr_accessor :auto_renewal
# Subscription billing details for this purchase.
attr_accessor :billing_interval
# Subscription end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Name of the product on subscription. e.g. Apple Music Subscription
attr_accessor :name
# Subscription start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
)
@affiliate = affiliate
@auto_renewal = auto_renewal
@billing_interval = billing_interval
@ends_at = ends_at
@name = name
@starts_at = starts_at
end
end
# Car rental details for this PaymentIntent.
attr_accessor :car_rental
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
attr_accessor :customer_reference
# Event details for this PaymentIntent
attr_accessor :event_details
# Flight reservation details for this PaymentIntent
attr_accessor :flight
# Lodging reservation details for this PaymentIntent
attr_accessor :lodging
# A unique value assigned by the business to identify the transaction.
attr_accessor :order_reference
# Subscription details for this PaymentIntent
attr_accessor :subscription
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
)
@car_rental = car_rental
@customer_reference = customer_reference
@event_details = event_details
@flight = flight
@lodging = lodging
@order_reference = order_reference
@subscription = subscription
end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
attr_accessor :account_number
# Institution number of the customer's bank.
attr_accessor :institution_number
# Transit number of the customer's bank.
attr_accessor :transit_number
def initialize(account_number: nil, institution_number: nil, transit_number: nil)
@account_number = account_number
@institution_number = institution_number
@transit_number = transit_number
end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
def initialize(account_number: nil, bsb_number: nil)
@account_number = account_number
@bsb_number = bsb_number
end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
attr_accessor :account_number
# Sort code of the bank account. (e.g., `10-20-30`)
attr_accessor :sort_code
def initialize(account_number: nil, sort_code: nil)
@account_number = account_number
@sort_code = sort_code
end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Billing address.
attr_accessor :address
# Email address.
attr_accessor :email
# Full name.
attr_accessor :name
# Billing phone number (including extension).
attr_accessor :phone
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
attr_accessor :tax_id
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil)
@address = address
@email = email
@name = name
@phone = phone
@tax_id = tax_id
end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
attr_accessor :tax_id
def initialize(tax_id: nil)
@tax_id = tax_id
end
end
class Cashapp < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
attr_accessor :account_holder_type
# The customer's bank.
attr_accessor :bank
def initialize(account_holder_type: nil, bank: nil)
@account_holder_type = account_holder_type
@bank = bank
end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
attr_accessor :funding
def initialize(funding: nil)
@funding = funding
end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethods billing details.
attr_accessor :account_holder_name
# The account number for the bank account.
attr_accessor :account_number
# The numeric code for the bank account's bank.
attr_accessor :bank_code
# The numeric code for the bank account's bank branch.
attr_accessor :branch_code
# Attribute for param field reference
attr_accessor :reference
# The suffix of the bank account number.
attr_accessor :suffix
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
)
@account_holder_name = account_holder_name
@account_number = account_number
@bank_code = bank_code
@branch_code = branch_code
@reference = reference
@suffix = suffix
end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
# The PayID alias for the bank account.
attr_accessor :pay_id
def initialize(account_number: nil, bsb_number: nil, pay_id: nil)
@account_number = account_number
@bsb_number = bsb_number
@pay_id = pay_id
end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
attr_accessor :session
def initialize(session: nil)
@session = session
end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
attr_accessor :iban
def initialize(iban: nil)
@iban = iban
end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
attr_accessor :account
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
attr_accessor :source_type
def initialize(account: nil, source_type: nil)
@account = account
@source_type = source_type
end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
attr_accessor :account_holder_type
# Account number of the bank account.
attr_accessor :account_number
# Account type: checkings or savings. Defaults to checking if omitted.
attr_accessor :account_type
# The ID of a Financial Connections Account to use as a payment method.
attr_accessor :financial_connections_account
# Routing number of the bank account.
attr_accessor :routing_number
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
)
@account_holder_type = account_holder_type
@account_number = account_number
@account_type = account_type
@financial_connections_account = financial_connections_account
@routing_number = routing_number
end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
attr_accessor :affirm
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
attr_accessor :afterpay_clearpay
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
attr_accessor :alipay
# 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`.
attr_accessor :allow_redisplay
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
attr_accessor :alma
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
attr_accessor :amazon_pay
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
attr_accessor :billie
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
attr_accessor :billing_details
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
attr_accessor :boleto
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
attr_accessor :cashapp
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
attr_accessor :customer_balance
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
attr_accessor :eps
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
attr_accessor :giropay
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
attr_accessor :grabpay
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
attr_accessor :id_bank_transfer
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
attr_accessor :ideal
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
attr_accessor :kr_card
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
attr_accessor :link
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
attr_accessor :mb_way
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
attr_accessor :naver_pay
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
attr_accessor :nz_bank_account
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
attr_accessor :qris
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
attr_accessor :radar_options
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
attr_accessor :sepa_debit
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
attr_accessor :sofort
# This hash contains details about the Stripe balance payment method.
attr_accessor :stripe_balance
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
attr_accessor :swish
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
attr_accessor :twint
# 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.
attr_accessor :type
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
attr_accessor :us_bank_account
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@allow_redisplay = allow_redisplay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@billing_details = billing_details
@blik = blik
@boleto = boleto
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@metadata = metadata
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@radar_options = radar_options
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@type = type
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
attr_accessor :custom_mandate_url
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
attr_accessor :interval_description
# Payment schedule for the mandate.
attr_accessor :payment_schedule
# Transaction type of the mandate.
attr_accessor :transaction_type
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
)
@custom_mandate_url = custom_mandate_url
@interval_description = interval_description
@payment_schedule = payment_schedule
@transaction_type = transaction_type
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Affirm authorization page that the customer is redirected to.
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil)
@capture_method = capture_method
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
attr_accessor :code
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(code: nil, setup_future_usage: nil)
@code = code
@setup_future_usage = setup_future_usage
end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
attr_accessor :count
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
attr_accessor :interval
# Type of installment plan, one of `fixed_count`.
attr_accessor :type
def initialize(count: nil, interval: nil, type: nil)
@count = count
@interval = interval
@type = type
end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
attr_accessor :enabled
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
attr_accessor :plan
def initialize(enabled: nil, plan: nil)
@enabled = enabled
@plan = plan
end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
attr_accessor :amount
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
attr_accessor :amount_type
# A description of the mandate or subscription that is meant to be displayed to the customer.
attr_accessor :description
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
attr_accessor :end_date
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
attr_accessor :interval
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
attr_accessor :interval_count
# Unique identifier for the mandate or subscription.
attr_accessor :reference
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
attr_accessor :start_date
# Specifies the type of mandates supported. Possible values are `india`.
attr_accessor :supported_types
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
)
@amount = amount
@amount_type = amount_type
@description = description
@end_date = end_date
@interval = interval
@interval_count = interval_count
@reference = reference
@start_date = start_date
@supported_types = supported_types
end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Please pass in an address that is within your Stripe user account country
attr_accessor :address
# Phone number (e.g., a toll-free number that customers can call)
attr_accessor :phone
def initialize(address: nil, phone: nil)
@address = address
@phone = phone
end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
attr_accessor :cb_avalgo
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
attr_accessor :cb_exemption
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
attr_accessor :cb_score
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil)
@cb_avalgo = cb_avalgo
@cb_exemption = cb_exemption
@cb_score = cb_score
end
end
# Cartes Bancaires-specific 3DS fields.
attr_accessor :cartes_bancaires
def initialize(cartes_bancaires: nil)
@cartes_bancaires = cartes_bancaires
end
end
# The `transStatus` returned from the card Issuers ACS in the ARes.
attr_accessor :ares_trans_status
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
attr_accessor :cryptogram
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
attr_accessor :electronic_commerce_indicator
# The exemption requested via 3DS and accepted by the issuer at authentication time.
attr_accessor :exemption_indicator
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
attr_accessor :network_options
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
attr_accessor :requestor_challenge_indicator
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
attr_accessor :transaction_id
# The version of 3D Secure that was performed.
attr_accessor :version
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
)
@ares_trans_status = ares_trans_status
@cryptogram = cryptogram
@electronic_commerce_indicator = electronic_commerce_indicator
@exemption_indicator = exemption_indicator
@network_options = network_options
@requestor_challenge_indicator = requestor_challenge_indicator
@transaction_id = transaction_id
@version = version
end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
attr_accessor :cvc_token
# Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
attr_accessor :installments
# Configuration options for setting up an eMandate for cards issued in India.
attr_accessor :mandate_options
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
attr_accessor :moto
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
attr_accessor :network
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
attr_accessor :request_decremental_authorization
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
attr_accessor :request_extended_authorization
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
attr_accessor :request_incremental_authorization
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
attr_accessor :request_multicapture
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
attr_accessor :request_overcapture
# Request partial authorization on this PaymentIntent.
attr_accessor :request_partial_authorization
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
attr_accessor :request_three_d_secure
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
attr_accessor :require_cvc_recollection
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor thats set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
attr_accessor :statement_descriptor_suffix_kana
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor thats set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
attr_accessor :statement_descriptor_suffix_kanji
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
attr_accessor :statement_details
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
attr_accessor :three_d_secure
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
)
@capture_method = capture_method
@cvc_token = cvc_token
@installments = installments
@mandate_options = mandate_options
@moto = moto
@network = network
@request_decremental_authorization = request_decremental_authorization
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization = request_incremental_authorization
@request_multicapture = request_multicapture
@request_overcapture = request_overcapture
@request_partial_authorization = request_partial_authorization
@request_three_d_secure = request_three_d_secure
@require_cvc_recollection = require_cvc_recollection
@setup_future_usage = setup_future_usage
@statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
@statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
@statement_details = statement_details
@three_d_secure = three_d_secure
end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
attr_accessor :requested_priority
def initialize(requested_priority: nil)
@requested_priority = requested_priority
end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
attr_accessor :request_extended_authorization
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
attr_accessor :request_incremental_authorization_support
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
attr_accessor :routing
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
)
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization_support = request_incremental_authorization_support
@routing = routing
end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
# Configuration for the eu_bank_transfer funding type.
attr_accessor :eu_bank_transfer
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
attr_accessor :requested_address_types
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
attr_accessor :type
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
@eu_bank_transfer = eu_bank_transfer
@requested_address_types = requested_address_types
@type = type
end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
attr_accessor :bank_transfer
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
attr_accessor :funding_type
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil)
@bank_transfer = bank_transfer
@funding_type = funding_type
@setup_future_usage = setup_future_usage
end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
attr_accessor :expires_after
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil)
@expires_after = expires_after
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Klarna < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Klarna authorization page that the customer is redirected to
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
attr_accessor :confirmation_number
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
attr_accessor :expires_after_days
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
attr_accessor :expires_at
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
attr_accessor :product_description
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
)
@confirmation_number = confirmation_number
@expires_after_days = expires_after_days
@expires_at = expires_at
@product_description = product_description
@setup_future_usage = setup_future_usage
end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# [Deprecated] This is a legacy parameter that no longer has any function.
attr_accessor :persistent_token
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil)
@capture_method = capture_method
@persistent_token = persistent_token
@setup_future_usage = setup_future_usage
end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Confirm that the payer has accepted the P24 terms and conditions.
attr_accessor :tos_shown_and_accepted
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil)
@setup_future_usage = setup_future_usage
@tos_shown_and_accepted = tos_shown_and_accepted
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :amount
# The tax behavior for the line item.
attr_accessor :behavior
def initialize(amount: nil, behavior: nil)
@amount = amount
@behavior = behavior
end
end
# Type of the line item.
attr_accessor :category
# Description of the line item.
attr_accessor :description
# Descriptive name of the line item.
attr_accessor :name
# Quantity of the line item. Must be a positive number.
attr_accessor :quantity
# Client facing stock keeping unit, article number or similar.
attr_accessor :sku
# The Stripe account ID of the connected account that sells the item.
attr_accessor :sold_by
# The tax information for the line item.
attr_accessor :tax
# Price for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :unit_amount
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
)
@category = category
@description = description
@name = name
@quantity = quantity
@sku = sku
@sold_by = sold_by
@tax = tax
@unit_amount = unit_amount
end
end
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# The line items purchased by the customer.
attr_accessor :line_items
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
attr_accessor :preferred_locale
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference_id
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
attr_accessor :risk_correlation_id
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
attr_accessor :subsellers
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
)
@capture_method = capture_method
@line_items = line_items
@preferred_locale = preferred_locale
@reference = reference
@reference_id = reference_id
@risk_correlation_id = risk_correlation_id
@setup_future_usage = setup_future_usage
@subsellers = subsellers
end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
attr_accessor :amount
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
attr_accessor :amount_type
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
attr_accessor :end_date
# The periodicity at which payments will be collected.
attr_accessor :payment_schedule
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
attr_accessor :payments_per_period
# The purpose for which payments are made. Defaults to retail.
attr_accessor :purpose
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
)
@amount = amount
@amount_type = amount_type
@end_date = end_date
@payment_schedule = payment_schedule
@payments_per_period = payments_per_period
@purpose = purpose
end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(mandate_options: nil, setup_future_usage: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
end
end
class Pix < Stripe::RequestParams
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
attr_accessor :expires_after_seconds
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
@expires_after_seconds = expires_after_seconds
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(reference: nil, setup_future_usage: nil)
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
attr_accessor :account_subcategories
# ID of the institution to use to filter for selectable accounts.
attr_accessor :institution
def initialize(account_subcategories: nil, institution: nil)
@account_subcategories = account_subcategories
@institution = institution
end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
attr_accessor :mode
def initialize(mode: nil)
@mode = mode
end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
attr_accessor :filters
# Customize manual entry behavior
attr_accessor :manual_entry
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
attr_accessor :permissions
# List of data features that you would like to retrieve upon account creation.
attr_accessor :prefetch
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
attr_accessor :return_url
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
)
@filters = filters
@manual_entry = manual_entry
@permissions = permissions
@prefetch = prefetch
@return_url = return_url
end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
attr_accessor :collection_method
def initialize(collection_method: nil)
@collection_method = collection_method
end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
attr_accessor :requested
def initialize(requested: nil)
@requested = requested
end
end
# Additional fields for Financial Connections Session creation
attr_accessor :financial_connections
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Additional fields for network related functions
attr_accessor :networks
# Preferred transaction settlement speed
attr_accessor :preferred_settlement_speed
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@financial_connections = financial_connections
@mandate_options = mandate_options
@networks = networks
@preferred_settlement_speed = preferred_settlement_speed
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
attr_accessor :app_id
# The client type that the end customer will pay from
attr_accessor :client
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(app_id: nil, client: nil, setup_future_usage: nil)
@app_id = app_id
@client = client
@setup_future_usage = setup_future_usage
end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
attr_accessor :affirm
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
attr_accessor :afterpay_clearpay
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
attr_accessor :alipay
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
attr_accessor :alma
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
attr_accessor :amazon_pay
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
attr_accessor :billie
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
attr_accessor :boleto
# Configuration for any card payments attempted on this PaymentIntent.
attr_accessor :card
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :card_present
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
attr_accessor :cashapp
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
attr_accessor :customer_balance
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
attr_accessor :eps
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
attr_accessor :giropay
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
attr_accessor :grabpay
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
attr_accessor :id_bank_transfer
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
attr_accessor :ideal
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
attr_accessor :kr_card
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
attr_accessor :link
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
attr_accessor :mb_way
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
attr_accessor :naver_pay
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
attr_accessor :nz_bank_account
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
attr_accessor :qris
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
attr_accessor :sepa_debit
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
attr_accessor :sofort
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
attr_accessor :stripe_balance
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
attr_accessor :swish
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
attr_accessor :twint
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
attr_accessor :us_bank_account
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@blik = blik
@boleto = boleto
@card = card
@card_present = card_present
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Shipping address.
attr_accessor :address
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
attr_accessor :carrier
# Recipient name.
attr_accessor :name
# Recipient phone (including extension).
attr_accessor :phone
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
attr_accessor :tracking_number
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
@address = address
@carrier = carrier
@name = name
@phone = phone
@tracking_number = tracking_number
end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
attr_accessor :amount
def initialize(amount: nil)
@amount = amount
end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
attr_accessor :amount
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
attr_accessor :customer
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
attr_accessor :customer_account
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_accessor :description
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
attr_accessor :fx_quote
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# This hash contains details about the Mandate to create.
attr_accessor :mandate_data
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# Provides industry-specific information about the charge.
attr_accessor :payment_details
# Attribute for param field payment_method
attr_accessor :payment_method
# The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
attr_accessor :payment_method_configuration
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
attr_accessor :payment_method_data
# Payment-method-specific configuration for this PaymentIntent.
attr_accessor :payment_method_options
# The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
attr_accessor :payment_method_types
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
attr_accessor :receipt_email
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Shipping information for this PaymentIntent.
attr_accessor :shipping
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
attr_accessor :statement_descriptor
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
attr_accessor :statement_descriptor_suffix
# Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_data
# A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_group
def initialize(
amount: nil,
application_fee_amount: nil,
capture_method: nil,
currency: nil,
customer: nil,
customer_account: nil,
description: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate_data: nil,
metadata: nil,
payment_details: nil,
payment_method: nil,
payment_method_configuration: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
receipt_email: nil,
setup_future_usage: nil,
shipping: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
)
@amount = amount
@application_fee_amount = application_fee_amount
@capture_method = capture_method
@currency = currency
@customer = customer
@customer_account = customer_account
@description = description
@expand = expand
@fx_quote = fx_quote
@hooks = hooks
@mandate_data = mandate_data
@metadata = metadata
@payment_details = payment_details
@payment_method = payment_method
@payment_method_configuration = payment_method_configuration
@payment_method_data = payment_method_data
@payment_method_options = payment_method_options
@payment_method_types = payment_method_types
@receipt_email = receipt_email
@setup_future_usage = setup_future_usage
@shipping = shipping
@statement_descriptor = statement_descriptor
@statement_descriptor_suffix = statement_descriptor_suffix
@transfer_data = transfer_data
@transfer_group = transfer_group
end
end
class SearchParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
attr_accessor :limit
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
attr_accessor :page
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).
attr_accessor :query
def initialize(expand: nil, limit: nil, page: nil, query: nil)
@expand = expand
@limit = limit
@page = page
@query = query
end
end
class ApplyCustomerBalanceParams < Stripe::RequestParams
# Amount that you intend to apply to this PaymentIntent from the customers cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.
#
# A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.
#
# When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.
attr_accessor :amount
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# Specifies which fields in the response should be expanded.
attr_accessor :expand
def initialize(amount: nil, currency: nil, expand: nil)
@amount = amount
@currency = currency
@expand = expand
end
end
class CancelParams < Stripe::RequestParams
# Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`
attr_accessor :cancellation_reason
# Specifies which fields in the response should be expanded.
attr_accessor :expand
def initialize(cancellation_reason: nil, expand: nil)
@cancellation_reason = cancellation_reason
@expand = expand
end
end
class CaptureParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Distance < Stripe::RequestParams
# Distance traveled.
attr_accessor :amount
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
attr_accessor :unit
def initialize(amount: nil, unit: nil)
@amount = amount
@unit = unit
end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
attr_accessor :driver_identification_number
# Driver's tax number.
attr_accessor :driver_tax_number
# Full name of the person or entity on the car reservation.
attr_accessor :name
def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
@driver_identification_number = driver_identification_number
@driver_tax_number = driver_tax_number
@name = name
end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the car rental.
attr_accessor :booking_number
# Class code of the car.
attr_accessor :car_class_code
# Make of the car.
attr_accessor :car_make
# Model of the car.
attr_accessor :car_model
# The name of the rental car company.
attr_accessor :company
# The customer service phone number of the car rental company.
attr_accessor :customer_service_phone_number
# Number of days the car is being rented.
attr_accessor :days_rented
# Delivery details for this purchase.
attr_accessor :delivery
# The details of the distance traveled during the rental period.
attr_accessor :distance
# The details of the passengers in the travel reservation
attr_accessor :drivers
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates if the customer did not keep nor cancel their booking.
attr_accessor :no_show
# Car pick-up address.
attr_accessor :pickup_address
# Car pick-up time. Measured in seconds since the Unix epoch.
attr_accessor :pickup_at
# Name of the pickup location.
attr_accessor :pickup_location_name
# Rental rate.
attr_accessor :rate_amount
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
attr_accessor :rate_interval
# The name of the person or entity renting the car.
attr_accessor :renter_name
# Car return address.
attr_accessor :return_address
# Car return time. Measured in seconds since the Unix epoch.
attr_accessor :return_at
# Name of the return location.
attr_accessor :return_location_name
# Indicates whether the goods or services are tax-exempt or tax is not collected.
attr_accessor :tax_exempt
# The vehicle identification number.
attr_accessor :vehicle_identification_number
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
)
@affiliate = affiliate
@booking_number = booking_number
@car_class_code = car_class_code
@car_make = car_make
@car_model = car_model
@company = company
@customer_service_phone_number = customer_service_phone_number
@days_rented = days_rented
@delivery = delivery
@distance = distance
@drivers = drivers
@extra_charges = extra_charges
@no_show = no_show
@pickup_address = pickup_address
@pickup_at = pickup_at
@pickup_location_name = pickup_location_name
@rate_amount = rate_amount
@rate_interval = rate_interval
@renter_name = renter_name
@return_address = return_address
@return_at = return_at
@return_location_name = return_location_name
@tax_exempt = tax_exempt
@vehicle_identification_number = vehicle_identification_number
end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
# Indicates if the tickets are digitally checked when entering the venue.
attr_accessor :access_controlled_venue
# The event location's address.
attr_accessor :address
# Affiliate details for this purchase.
attr_accessor :affiliate
# The name of the company
attr_accessor :company
# Delivery details for this purchase.
attr_accessor :delivery
# Event end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Type of the event entertainment (concert, sports event etc)
attr_accessor :genre
# The name of the event.
attr_accessor :name
# Event start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
)
@access_controlled_venue = access_controlled_venue
@address = address
@affiliate = affiliate
@company = company
@delivery = delivery
@ends_at = ends_at
@genre = genre
@name = name
@starts_at = starts_at
end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
attr_accessor :amount
# The International Air Transport Association (IATA) airport code for the arrival airport.
attr_accessor :arrival_airport
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :arrives_at
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
attr_accessor :carrier
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :departs_at
# The International Air Transport Association (IATA) airport code for the departure airport.
attr_accessor :departure_airport
# The flight number associated with the segment
attr_accessor :flight_number
# The fare class for the segment.
attr_accessor :service_class
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
)
@amount = amount
@arrival_airport = arrival_airport
@arrives_at = arrives_at
@carrier = carrier
@departs_at = departs_at
@departure_airport = departure_airport
@flight_number = flight_number
@service_class = service_class
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
attr_accessor :agency_number
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
attr_accessor :carrier
# Delivery details for this purchase.
attr_accessor :delivery
# The name of the person or entity on the reservation.
attr_accessor :passenger_name
# The details of the passengers in the travel reservation.
attr_accessor :passengers
# The individual flight segments associated with the trip.
attr_accessor :segments
# The ticket number associated with the travel reservation.
attr_accessor :ticket_number
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
)
@affiliate = affiliate
@agency_number = agency_number
@carrier = carrier
@delivery = delivery
@passenger_name = passenger_name
@passengers = passengers
@segments = segments
@ticket_number = ticket_number
end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
# The lodging location's address.
attr_accessor :address
# The number of adults on the booking
attr_accessor :adults
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the lodging reservation.
attr_accessor :booking_number
# The lodging category
attr_accessor :category
# Lodging check-in time. Measured in seconds since the Unix epoch.
attr_accessor :checkin_at
# Lodging check-out time. Measured in seconds since the Unix epoch.
attr_accessor :checkout_at
# The customer service phone number of the lodging company.
attr_accessor :customer_service_phone_number
# The daily lodging room rate.
attr_accessor :daily_room_rate_amount
# Delivery details for this purchase.
attr_accessor :delivery
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates whether the lodging location is compliant with the Fire Safety Act.
attr_accessor :fire_safety_act_compliance
# The name of the lodging location.
attr_accessor :name
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
attr_accessor :no_show
# The number of rooms on the booking
attr_accessor :number_of_rooms
# The details of the passengers in the travel reservation
attr_accessor :passengers
# The phone number of the lodging location.
attr_accessor :property_phone_number
# The room class for this purchase.
attr_accessor :room_class
# The number of room nights
attr_accessor :room_nights
# The total tax amount associating with the room reservation.
attr_accessor :total_room_tax_amount
# The total tax amount
attr_accessor :total_tax_amount
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
)
@address = address
@adults = adults
@affiliate = affiliate
@booking_number = booking_number
@category = category
@checkin_at = checkin_at
@checkout_at = checkout_at
@customer_service_phone_number = customer_service_phone_number
@daily_room_rate_amount = daily_room_rate_amount
@delivery = delivery
@extra_charges = extra_charges
@fire_safety_act_compliance = fire_safety_act_compliance
@name = name
@no_show = no_show
@number_of_rooms = number_of_rooms
@passengers = passengers
@property_phone_number = property_phone_number
@room_class = room_class
@room_nights = room_nights
@total_room_tax_amount = total_room_tax_amount
@total_tax_amount = total_tax_amount
end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :count
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
def initialize(count: nil, interval: nil)
@count = count
@interval = interval
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# Info whether the subscription will be auto renewed upon expiry.
attr_accessor :auto_renewal
# Subscription billing details for this purchase.
attr_accessor :billing_interval
# Subscription end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Name of the product on subscription. e.g. Apple Music Subscription
attr_accessor :name
# Subscription start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
)
@affiliate = affiliate
@auto_renewal = auto_renewal
@billing_interval = billing_interval
@ends_at = ends_at
@name = name
@starts_at = starts_at
end
end
# Car rental details for this PaymentIntent.
attr_accessor :car_rental
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
attr_accessor :customer_reference
# Event details for this PaymentIntent
attr_accessor :event_details
# Flight reservation details for this PaymentIntent
attr_accessor :flight
# Lodging reservation details for this PaymentIntent
attr_accessor :lodging
# A unique value assigned by the business to identify the transaction.
attr_accessor :order_reference
# Subscription details for this PaymentIntent
attr_accessor :subscription
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
)
@car_rental = car_rental
@customer_reference = customer_reference
@event_details = event_details
@flight = flight
@lodging = lodging
@order_reference = order_reference
@subscription = subscription
end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
attr_accessor :amount
def initialize(amount: nil)
@amount = amount
end
end
# The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided.
attr_accessor :amount_to_capture
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.
attr_accessor :final_capture
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# Provides industry-specific information about the charge.
attr_accessor :payment_details
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
attr_accessor :statement_descriptor
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
attr_accessor :statement_descriptor_suffix
# The parameters that you can use to automatically create a transfer after the payment
# is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_data
def initialize(
amount_to_capture: nil,
application_fee_amount: nil,
expand: nil,
final_capture: nil,
hooks: nil,
metadata: nil,
payment_details: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil
)
@amount_to_capture = amount_to_capture
@application_fee_amount = application_fee_amount
@expand = expand
@final_capture = final_capture
@hooks = hooks
@metadata = metadata
@payment_details = payment_details
@statement_descriptor = statement_descriptor
@statement_descriptor_suffix = statement_descriptor_suffix
@transfer_data = transfer_data
end
end
class ConfirmParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class MandateData < Stripe::RequestParams
class CustomerAcceptance < Stripe::RequestParams
class Offline < Stripe::RequestParams; end
class Online < Stripe::RequestParams
# The IP address from which the Mandate was accepted by the customer.
attr_accessor :ip_address
# The user agent of the browser from which the Mandate was accepted by the customer.
attr_accessor :user_agent
def initialize(ip_address: nil, user_agent: nil)
@ip_address = ip_address
@user_agent = user_agent
end
end
# The time at which the customer accepted the Mandate.
attr_accessor :accepted_at
# If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
attr_accessor :offline
# If this is a Mandate accepted online, this hash contains details about the online acceptance.
attr_accessor :online
# The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
attr_accessor :type
def initialize(accepted_at: nil, offline: nil, online: nil, type: nil)
@accepted_at = accepted_at
@offline = offline
@online = online
@type = type
end
end
# This hash contains details about the customer acceptance of the Mandate.
attr_accessor :customer_acceptance
def initialize(customer_acceptance: nil)
@customer_acceptance = customer_acceptance
end
end
class PaymentDetails < Stripe::RequestParams
class CarRental < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Distance < Stripe::RequestParams
# Distance traveled.
attr_accessor :amount
# Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
attr_accessor :unit
def initialize(amount: nil, unit: nil)
@amount = amount
@unit = unit
end
end
class Driver < Stripe::RequestParams
# Driver's identification number.
attr_accessor :driver_identification_number
# Driver's tax number.
attr_accessor :driver_tax_number
# Full name of the person or entity on the car reservation.
attr_accessor :name
def initialize(driver_identification_number: nil, driver_tax_number: nil, name: nil)
@driver_identification_number = driver_identification_number
@driver_tax_number = driver_tax_number
@name = name
end
end
class PickupAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class ReturnAddress < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the car rental.
attr_accessor :booking_number
# Class code of the car.
attr_accessor :car_class_code
# Make of the car.
attr_accessor :car_make
# Model of the car.
attr_accessor :car_model
# The name of the rental car company.
attr_accessor :company
# The customer service phone number of the car rental company.
attr_accessor :customer_service_phone_number
# Number of days the car is being rented.
attr_accessor :days_rented
# Delivery details for this purchase.
attr_accessor :delivery
# The details of the distance traveled during the rental period.
attr_accessor :distance
# The details of the passengers in the travel reservation
attr_accessor :drivers
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates if the customer did not keep nor cancel their booking.
attr_accessor :no_show
# Car pick-up address.
attr_accessor :pickup_address
# Car pick-up time. Measured in seconds since the Unix epoch.
attr_accessor :pickup_at
# Name of the pickup location.
attr_accessor :pickup_location_name
# Rental rate.
attr_accessor :rate_amount
# The frequency at which the rate amount is applied. One of `day`, `week` or `month`
attr_accessor :rate_interval
# The name of the person or entity renting the car.
attr_accessor :renter_name
# Car return address.
attr_accessor :return_address
# Car return time. Measured in seconds since the Unix epoch.
attr_accessor :return_at
# Name of the return location.
attr_accessor :return_location_name
# Indicates whether the goods or services are tax-exempt or tax is not collected.
attr_accessor :tax_exempt
# The vehicle identification number.
attr_accessor :vehicle_identification_number
def initialize(
affiliate: nil,
booking_number: nil,
car_class_code: nil,
car_make: nil,
car_model: nil,
company: nil,
customer_service_phone_number: nil,
days_rented: nil,
delivery: nil,
distance: nil,
drivers: nil,
extra_charges: nil,
no_show: nil,
pickup_address: nil,
pickup_at: nil,
pickup_location_name: nil,
rate_amount: nil,
rate_interval: nil,
renter_name: nil,
return_address: nil,
return_at: nil,
return_location_name: nil,
tax_exempt: nil,
vehicle_identification_number: nil
)
@affiliate = affiliate
@booking_number = booking_number
@car_class_code = car_class_code
@car_make = car_make
@car_model = car_model
@company = company
@customer_service_phone_number = customer_service_phone_number
@days_rented = days_rented
@delivery = delivery
@distance = distance
@drivers = drivers
@extra_charges = extra_charges
@no_show = no_show
@pickup_address = pickup_address
@pickup_at = pickup_at
@pickup_location_name = pickup_location_name
@rate_amount = rate_amount
@rate_interval = rate_interval
@renter_name = renter_name
@return_address = return_address
@return_at = return_at
@return_location_name = return_location_name
@tax_exempt = tax_exempt
@vehicle_identification_number = vehicle_identification_number
end
end
class EventDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
# Indicates if the tickets are digitally checked when entering the venue.
attr_accessor :access_controlled_venue
# The event location's address.
attr_accessor :address
# Affiliate details for this purchase.
attr_accessor :affiliate
# The name of the company
attr_accessor :company
# Delivery details for this purchase.
attr_accessor :delivery
# Event end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Type of the event entertainment (concert, sports event etc)
attr_accessor :genre
# The name of the event.
attr_accessor :name
# Event start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
access_controlled_venue: nil,
address: nil,
affiliate: nil,
company: nil,
delivery: nil,
ends_at: nil,
genre: nil,
name: nil,
starts_at: nil
)
@access_controlled_venue = access_controlled_venue
@address = address
@affiliate = affiliate
@company = company
@delivery = delivery
@ends_at = ends_at
@genre = genre
@name = name
@starts_at = starts_at
end
end
class Flight < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the flight reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Segment < Stripe::RequestParams
# The flight segment amount.
attr_accessor :amount
# The International Air Transport Association (IATA) airport code for the arrival airport.
attr_accessor :arrival_airport
# The arrival time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :arrives_at
# The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
attr_accessor :carrier
# The departure time for the flight segment. Measured in seconds since the Unix epoch.
attr_accessor :departs_at
# The International Air Transport Association (IATA) airport code for the departure airport.
attr_accessor :departure_airport
# The flight number associated with the segment
attr_accessor :flight_number
# The fare class for the segment.
attr_accessor :service_class
def initialize(
amount: nil,
arrival_airport: nil,
arrives_at: nil,
carrier: nil,
departs_at: nil,
departure_airport: nil,
flight_number: nil,
service_class: nil
)
@amount = amount
@arrival_airport = arrival_airport
@arrives_at = arrives_at
@carrier = carrier
@departs_at = departs_at
@departure_airport = departure_airport
@flight_number = flight_number
@service_class = service_class
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
attr_accessor :agency_number
# The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
attr_accessor :carrier
# Delivery details for this purchase.
attr_accessor :delivery
# The name of the person or entity on the reservation.
attr_accessor :passenger_name
# The details of the passengers in the travel reservation.
attr_accessor :passengers
# The individual flight segments associated with the trip.
attr_accessor :segments
# The ticket number associated with the travel reservation.
attr_accessor :ticket_number
def initialize(
affiliate: nil,
agency_number: nil,
carrier: nil,
delivery: nil,
passenger_name: nil,
passengers: nil,
segments: nil,
ticket_number: nil
)
@affiliate = affiliate
@agency_number = agency_number
@carrier = carrier
@delivery = delivery
@passenger_name = passenger_name
@passengers = passengers
@segments = segments
@ticket_number = ticket_number
end
end
class Lodging < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class Delivery < Stripe::RequestParams
class Recipient < Stripe::RequestParams
# The email of the recipient the ticket is delivered to.
attr_accessor :email
# The name of the recipient the ticket is delivered to.
attr_accessor :name
# The phone number of the recipient the ticket is delivered to.
attr_accessor :phone
def initialize(email: nil, name: nil, phone: nil)
@email = email
@name = name
@phone = phone
end
end
# The delivery method for the payment
attr_accessor :mode
# Details of the recipient.
attr_accessor :recipient
def initialize(mode: nil, recipient: nil)
@mode = mode
@recipient = recipient
end
end
class Passenger < Stripe::RequestParams
# Full name of the person or entity on the lodging reservation.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
# The lodging location's address.
attr_accessor :address
# The number of adults on the booking
attr_accessor :adults
# Affiliate details for this purchase.
attr_accessor :affiliate
# The booking number associated with the lodging reservation.
attr_accessor :booking_number
# The lodging category
attr_accessor :category
# Lodging check-in time. Measured in seconds since the Unix epoch.
attr_accessor :checkin_at
# Lodging check-out time. Measured in seconds since the Unix epoch.
attr_accessor :checkout_at
# The customer service phone number of the lodging company.
attr_accessor :customer_service_phone_number
# The daily lodging room rate.
attr_accessor :daily_room_rate_amount
# Delivery details for this purchase.
attr_accessor :delivery
# List of additional charges being billed.
attr_accessor :extra_charges
# Indicates whether the lodging location is compliant with the Fire Safety Act.
attr_accessor :fire_safety_act_compliance
# The name of the lodging location.
attr_accessor :name
# Indicates if the customer did not keep their booking while failing to cancel the reservation.
attr_accessor :no_show
# The number of rooms on the booking
attr_accessor :number_of_rooms
# The details of the passengers in the travel reservation
attr_accessor :passengers
# The phone number of the lodging location.
attr_accessor :property_phone_number
# The room class for this purchase.
attr_accessor :room_class
# The number of room nights
attr_accessor :room_nights
# The total tax amount associating with the room reservation.
attr_accessor :total_room_tax_amount
# The total tax amount
attr_accessor :total_tax_amount
def initialize(
address: nil,
adults: nil,
affiliate: nil,
booking_number: nil,
category: nil,
checkin_at: nil,
checkout_at: nil,
customer_service_phone_number: nil,
daily_room_rate_amount: nil,
delivery: nil,
extra_charges: nil,
fire_safety_act_compliance: nil,
name: nil,
no_show: nil,
number_of_rooms: nil,
passengers: nil,
property_phone_number: nil,
room_class: nil,
room_nights: nil,
total_room_tax_amount: nil,
total_tax_amount: nil
)
@address = address
@adults = adults
@affiliate = affiliate
@booking_number = booking_number
@category = category
@checkin_at = checkin_at
@checkout_at = checkout_at
@customer_service_phone_number = customer_service_phone_number
@daily_room_rate_amount = daily_room_rate_amount
@delivery = delivery
@extra_charges = extra_charges
@fire_safety_act_compliance = fire_safety_act_compliance
@name = name
@no_show = no_show
@number_of_rooms = number_of_rooms
@passengers = passengers
@property_phone_number = property_phone_number
@room_class = room_class
@room_nights = room_nights
@total_room_tax_amount = total_room_tax_amount
@total_tax_amount = total_tax_amount
end
end
class Subscription < Stripe::RequestParams
class Affiliate < Stripe::RequestParams
# The name of the affiliate that originated the purchase.
attr_accessor :name
def initialize(name: nil)
@name = name
end
end
class BillingInterval < Stripe::RequestParams
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :count
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
def initialize(count: nil, interval: nil)
@count = count
@interval = interval
end
end
# Affiliate details for this purchase.
attr_accessor :affiliate
# Info whether the subscription will be auto renewed upon expiry.
attr_accessor :auto_renewal
# Subscription billing details for this purchase.
attr_accessor :billing_interval
# Subscription end time. Measured in seconds since the Unix epoch.
attr_accessor :ends_at
# Name of the product on subscription. e.g. Apple Music Subscription
attr_accessor :name
# Subscription start time. Measured in seconds since the Unix epoch.
attr_accessor :starts_at
def initialize(
affiliate: nil,
auto_renewal: nil,
billing_interval: nil,
ends_at: nil,
name: nil,
starts_at: nil
)
@affiliate = affiliate
@auto_renewal = auto_renewal
@billing_interval = billing_interval
@ends_at = ends_at
@name = name
@starts_at = starts_at
end
end
# Car rental details for this PaymentIntent.
attr_accessor :car_rental
# Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
attr_accessor :customer_reference
# Event details for this PaymentIntent
attr_accessor :event_details
# Flight reservation details for this PaymentIntent
attr_accessor :flight
# Lodging reservation details for this PaymentIntent
attr_accessor :lodging
# A unique value assigned by the business to identify the transaction.
attr_accessor :order_reference
# Subscription details for this PaymentIntent
attr_accessor :subscription
def initialize(
car_rental: nil,
customer_reference: nil,
event_details: nil,
flight: nil,
lodging: nil,
order_reference: nil,
subscription: nil
)
@car_rental = car_rental
@customer_reference = customer_reference
@event_details = event_details
@flight = flight
@lodging = lodging
@order_reference = order_reference
@subscription = subscription
end
end
class PaymentMethodData < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
# Customer's bank account number.
attr_accessor :account_number
# Institution number of the customer's bank.
attr_accessor :institution_number
# Transit number of the customer's bank.
attr_accessor :transit_number
def initialize(account_number: nil, institution_number: nil, transit_number: nil)
@account_number = account_number
@institution_number = institution_number
@transit_number = transit_number
end
end
class Affirm < Stripe::RequestParams; end
class AfterpayClearpay < Stripe::RequestParams; end
class Alipay < Stripe::RequestParams; end
class Alma < Stripe::RequestParams; end
class AmazonPay < Stripe::RequestParams; end
class AuBecsDebit < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
def initialize(account_number: nil, bsb_number: nil)
@account_number = account_number
@bsb_number = bsb_number
end
end
class BacsDebit < Stripe::RequestParams
# Account number of the bank account that the funds will be debited from.
attr_accessor :account_number
# Sort code of the bank account. (e.g., `10-20-30`)
attr_accessor :sort_code
def initialize(account_number: nil, sort_code: nil)
@account_number = account_number
@sort_code = sort_code
end
end
class Bancontact < Stripe::RequestParams; end
class Billie < Stripe::RequestParams; end
class BillingDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Billing address.
attr_accessor :address
# Email address.
attr_accessor :email
# Full name.
attr_accessor :name
# Billing phone number (including extension).
attr_accessor :phone
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
attr_accessor :tax_id
def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil)
@address = address
@email = email
@name = name
@phone = phone
@tax_id = tax_id
end
end
class Blik < Stripe::RequestParams; end
class Boleto < Stripe::RequestParams
# The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
attr_accessor :tax_id
def initialize(tax_id: nil)
@tax_id = tax_id
end
end
class Cashapp < Stripe::RequestParams; end
class CustomerBalance < Stripe::RequestParams; end
class Eps < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Fpx < Stripe::RequestParams
# Account holder type for FPX transaction
attr_accessor :account_holder_type
# The customer's bank.
attr_accessor :bank
def initialize(account_holder_type: nil, bank: nil)
@account_holder_type = account_holder_type
@bank = bank
end
end
class Giropay < Stripe::RequestParams; end
class Gopay < Stripe::RequestParams; end
class Grabpay < Stripe::RequestParams; end
class IdBankTransfer < Stripe::RequestParams
# Bank where the account is held.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class Ideal < Stripe::RequestParams
# The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams; end
class Klarna < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class Konbini < Stripe::RequestParams; end
class KrCard < Stripe::RequestParams; end
class Link < Stripe::RequestParams; end
class MbWay < Stripe::RequestParams; end
class Mobilepay < Stripe::RequestParams; end
class Multibanco < Stripe::RequestParams; end
class NaverPay < Stripe::RequestParams
# Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
attr_accessor :funding
def initialize(funding: nil)
@funding = funding
end
end
class NzBankAccount < Stripe::RequestParams
# The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethods billing details.
attr_accessor :account_holder_name
# The account number for the bank account.
attr_accessor :account_number
# The numeric code for the bank account's bank.
attr_accessor :bank_code
# The numeric code for the bank account's bank branch.
attr_accessor :branch_code
# Attribute for param field reference
attr_accessor :reference
# The suffix of the bank account number.
attr_accessor :suffix
def initialize(
account_holder_name: nil,
account_number: nil,
bank_code: nil,
branch_code: nil,
reference: nil,
suffix: nil
)
@account_holder_name = account_holder_name
@account_number = account_number
@bank_code = bank_code
@branch_code = branch_code
@reference = reference
@suffix = suffix
end
end
class Oxxo < Stripe::RequestParams; end
class P24 < Stripe::RequestParams
# The customer's bank.
attr_accessor :bank
def initialize(bank: nil)
@bank = bank
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams; end
class Paynow < Stripe::RequestParams; end
class Paypal < Stripe::RequestParams; end
class Payto < Stripe::RequestParams
# The account number for the bank account.
attr_accessor :account_number
# Bank-State-Branch number of the bank account.
attr_accessor :bsb_number
# The PayID alias for the bank account.
attr_accessor :pay_id
def initialize(account_number: nil, bsb_number: nil, pay_id: nil)
@account_number = account_number
@bsb_number = bsb_number
@pay_id = pay_id
end
end
class Pix < Stripe::RequestParams; end
class Promptpay < Stripe::RequestParams; end
class Qris < Stripe::RequestParams; end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
attr_accessor :session
def initialize(session: nil)
@session = session
end
end
class Rechnung < Stripe::RequestParams
class Dob < Stripe::RequestParams
# The day of birth, between 1 and 31.
attr_accessor :day
# The month of birth, between 1 and 12.
attr_accessor :month
# The four-digit year of birth.
attr_accessor :year
def initialize(day: nil, month: nil, year: nil)
@day = day
@month = month
@year = year
end
end
# Customer's date of birth
attr_accessor :dob
def initialize(dob: nil)
@dob = dob
end
end
class RevolutPay < Stripe::RequestParams; end
class SamsungPay < Stripe::RequestParams; end
class Satispay < Stripe::RequestParams; end
class SepaDebit < Stripe::RequestParams
# IBAN of the bank account.
attr_accessor :iban
def initialize(iban: nil)
@iban = iban
end
end
class Shopeepay < Stripe::RequestParams; end
class Sofort < Stripe::RequestParams
# Two-letter ISO code representing the country the bank account is located in.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
class StripeBalance < Stripe::RequestParams
# The connected account ID whose Stripe balance to use as the source of payment
attr_accessor :account
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
attr_accessor :source_type
def initialize(account: nil, source_type: nil)
@account = account
@source_type = source_type
end
end
class Swish < Stripe::RequestParams; end
class Twint < Stripe::RequestParams; end
class UsBankAccount < Stripe::RequestParams
# Account holder type: individual or company.
attr_accessor :account_holder_type
# Account number of the bank account.
attr_accessor :account_number
# Account type: checkings or savings. Defaults to checking if omitted.
attr_accessor :account_type
# The ID of a Financial Connections Account to use as a payment method.
attr_accessor :financial_connections_account
# Routing number of the bank account.
attr_accessor :routing_number
def initialize(
account_holder_type: nil,
account_number: nil,
account_type: nil,
financial_connections_account: nil,
routing_number: nil
)
@account_holder_type = account_holder_type
@account_number = account_number
@account_type = account_type
@financial_connections_account = financial_connections_account
@routing_number = routing_number
end
end
class WechatPay < Stripe::RequestParams; end
class Zip < Stripe::RequestParams; end
# If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
attr_accessor :affirm
# If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
attr_accessor :afterpay_clearpay
# If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
attr_accessor :alipay
# 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`.
attr_accessor :allow_redisplay
# If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
attr_accessor :alma
# If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
attr_accessor :amazon_pay
# If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
attr_accessor :billie
# Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
attr_accessor :billing_details
# If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
attr_accessor :boleto
# If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
attr_accessor :cashapp
# If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
attr_accessor :customer_balance
# If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
attr_accessor :eps
# If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
attr_accessor :giropay
# If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
attr_accessor :grabpay
# If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
attr_accessor :id_bank_transfer
# If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
attr_accessor :ideal
# If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
attr_accessor :kr_card
# If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
attr_accessor :link
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
attr_accessor :mb_way
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
attr_accessor :naver_pay
# If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
attr_accessor :nz_bank_account
# If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
attr_accessor :qris
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
attr_accessor :radar_options
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
attr_accessor :sepa_debit
# If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
attr_accessor :sofort
# This hash contains details about the Stripe balance payment method.
attr_accessor :stripe_balance
# If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
attr_accessor :swish
# If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
attr_accessor :twint
# 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.
attr_accessor :type
# If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
attr_accessor :us_bank_account
# If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
allow_redisplay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
billing_details: nil,
blik: nil,
boleto: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
metadata: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
radar_options: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
type: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@allow_redisplay = allow_redisplay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@billing_details = billing_details
@blik = blik
@boleto = boleto
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@metadata = metadata
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@radar_options = radar_options
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@type = type
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class PaymentMethodOptions < Stripe::RequestParams
class AcssDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# A URL for custom mandate text to render during confirmation step.
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
attr_accessor :custom_mandate_url
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
attr_accessor :interval_description
# Payment schedule for the mandate.
attr_accessor :payment_schedule
# Transaction type of the mandate.
attr_accessor :transaction_type
def initialize(
custom_mandate_url: nil,
interval_description: nil,
payment_schedule: nil,
transaction_type: nil
)
@custom_mandate_url = custom_mandate_url
@interval_description = interval_description
@payment_schedule = payment_schedule
@transaction_type = transaction_type
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
mandate_options: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class Affirm < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Affirm authorization page that the customer is redirected to.
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class AfterpayClearpay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.
# This field differs from the statement descriptor and item name.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, reference: nil, setup_future_usage: nil)
@capture_method = capture_method
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Alipay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Alma < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class AmazonPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class AuBecsDebit < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class BacsDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Bancontact < Stripe::RequestParams
# Preferred language of the Bancontact authorization page that the customer is redirected to.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class Billie < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Blik < Stripe::RequestParams
# The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
attr_accessor :code
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(code: nil, setup_future_usage: nil)
@code = code
@setup_future_usage = setup_future_usage
end
end
class Boleto < Stripe::RequestParams
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class Card < Stripe::RequestParams
class Installments < Stripe::RequestParams
class Plan < Stripe::RequestParams
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
attr_accessor :count
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
# One of `month`.
attr_accessor :interval
# Type of installment plan, one of `fixed_count`.
attr_accessor :type
def initialize(count: nil, interval: nil, type: nil)
@count = count
@interval = interval
@type = type
end
end
# Setting to true enables installments for this PaymentIntent.
# This will cause the response to contain a list of available installment plans.
# Setting to false will prevent any selected plan from applying to a charge.
attr_accessor :enabled
# The selected installment plan to use for this payment attempt.
# This parameter can only be provided during confirmation.
attr_accessor :plan
def initialize(enabled: nil, plan: nil)
@enabled = enabled
@plan = plan
end
end
class MandateOptions < Stripe::RequestParams
# Amount to be charged for future payments.
attr_accessor :amount
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
attr_accessor :amount_type
# A description of the mandate or subscription that is meant to be displayed to the customer.
attr_accessor :description
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
attr_accessor :end_date
# Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
attr_accessor :interval
# The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
attr_accessor :interval_count
# Unique identifier for the mandate or subscription.
attr_accessor :reference
# Start date of the mandate or subscription. Start date should not be lesser than yesterday.
attr_accessor :start_date
# Specifies the type of mandates supported. Possible values are `india`.
attr_accessor :supported_types
def initialize(
amount: nil,
amount_type: nil,
description: nil,
end_date: nil,
interval: nil,
interval_count: nil,
reference: nil,
start_date: nil,
supported_types: nil
)
@amount = amount
@amount_type = amount_type
@description = description
@end_date = end_date
@interval = interval
@interval_count = interval_count
@reference = reference
@start_date = start_date
@supported_types = supported_types
end
end
class StatementDetails < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Please pass in an address that is within your Stripe user account country
attr_accessor :address
# Phone number (e.g., a toll-free number that customers can call)
attr_accessor :phone
def initialize(address: nil, phone: nil)
@address = address
@phone = phone
end
end
class ThreeDSecure < Stripe::RequestParams
class NetworkOptions < Stripe::RequestParams
class CartesBancaires < Stripe::RequestParams
# The cryptogram calculation algorithm used by the card Issuer's ACS
# to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
# messageExtension: CB-AVALGO
attr_accessor :cb_avalgo
# The exemption indicator returned from Cartes Bancaires in the ARes.
# message extension: CB-EXEMPTION; string (4 characters)
# This is a 3 byte bitmap (low significant byte first and most significant
# bit first) that has been Base64 encoded
attr_accessor :cb_exemption
# The risk score returned from Cartes Bancaires in the ARes.
# message extension: CB-SCORE; numeric value 0-99
attr_accessor :cb_score
def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil)
@cb_avalgo = cb_avalgo
@cb_exemption = cb_exemption
@cb_score = cb_score
end
end
# Cartes Bancaires-specific 3DS fields.
attr_accessor :cartes_bancaires
def initialize(cartes_bancaires: nil)
@cartes_bancaires = cartes_bancaires
end
end
# The `transStatus` returned from the card Issuers ACS in the ARes.
attr_accessor :ares_trans_status
# The cryptogram, also known as the "authentication value" (AAV, CAVV or
# AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
# (Most 3D Secure providers will return the base64-encoded version, which
# is what you should specify here.)
attr_accessor :cryptogram
# The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
# provider and indicates what degree of authentication was performed.
attr_accessor :electronic_commerce_indicator
# The exemption requested via 3DS and accepted by the issuer at authentication time.
attr_accessor :exemption_indicator
# Network specific 3DS fields. Network specific arguments require an
# explicit card brand choice. The parameter `payment_method_options.card.network``
# must be populated accordingly
attr_accessor :network_options
# The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
# AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
attr_accessor :requestor_challenge_indicator
# For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
# Transaction ID (dsTransID).
attr_accessor :transaction_id
# The version of 3D Secure that was performed.
attr_accessor :version
def initialize(
ares_trans_status: nil,
cryptogram: nil,
electronic_commerce_indicator: nil,
exemption_indicator: nil,
network_options: nil,
requestor_challenge_indicator: nil,
transaction_id: nil,
version: nil
)
@ares_trans_status = ares_trans_status
@cryptogram = cryptogram
@electronic_commerce_indicator = electronic_commerce_indicator
@exemption_indicator = exemption_indicator
@network_options = network_options
@requestor_challenge_indicator = requestor_challenge_indicator
@transaction_id = transaction_id
@version = version
end
end
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
attr_accessor :cvc_token
# Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
attr_accessor :installments
# Configuration options for setting up an eMandate for cards issued in India.
attr_accessor :mandate_options
# When specified, this parameter indicates that a transaction will be marked
# as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
# parameter can only be provided during confirmation.
attr_accessor :moto
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
attr_accessor :network
# Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.
attr_accessor :request_decremental_authorization
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.
attr_accessor :request_extended_authorization
# Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.
attr_accessor :request_incremental_authorization
# Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.
attr_accessor :request_multicapture
# Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.
attr_accessor :request_overcapture
# Request partial authorization on this PaymentIntent.
attr_accessor :request_partial_authorization
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
attr_accessor :request_three_d_secure
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
attr_accessor :require_cvc_recollection
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor thats set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
attr_accessor :statement_descriptor_suffix_kana
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor thats set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
attr_accessor :statement_descriptor_suffix_kanji
# Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.
attr_accessor :statement_details
# If 3D Secure authentication was performed with a third-party provider,
# the authentication details to use for this payment.
attr_accessor :three_d_secure
def initialize(
capture_method: nil,
cvc_token: nil,
installments: nil,
mandate_options: nil,
moto: nil,
network: nil,
request_decremental_authorization: nil,
request_extended_authorization: nil,
request_incremental_authorization: nil,
request_multicapture: nil,
request_overcapture: nil,
request_partial_authorization: nil,
request_three_d_secure: nil,
require_cvc_recollection: nil,
setup_future_usage: nil,
statement_descriptor_suffix_kana: nil,
statement_descriptor_suffix_kanji: nil,
statement_details: nil,
three_d_secure: nil
)
@capture_method = capture_method
@cvc_token = cvc_token
@installments = installments
@mandate_options = mandate_options
@moto = moto
@network = network
@request_decremental_authorization = request_decremental_authorization
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization = request_incremental_authorization
@request_multicapture = request_multicapture
@request_overcapture = request_overcapture
@request_partial_authorization = request_partial_authorization
@request_three_d_secure = request_three_d_secure
@require_cvc_recollection = require_cvc_recollection
@setup_future_usage = setup_future_usage
@statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
@statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
@statement_details = statement_details
@three_d_secure = three_d_secure
end
end
class CardPresent < Stripe::RequestParams
class Routing < Stripe::RequestParams
# Routing requested priority
attr_accessor :requested_priority
def initialize(requested_priority: nil)
@requested_priority = requested_priority
end
end
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
attr_accessor :request_extended_authorization
# Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
attr_accessor :request_incremental_authorization_support
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
attr_accessor :routing
def initialize(
request_extended_authorization: nil,
request_incremental_authorization_support: nil,
routing: nil
)
@request_extended_authorization = request_extended_authorization
@request_incremental_authorization_support = request_incremental_authorization_support
@routing = routing
end
end
class Cashapp < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class CustomerBalance < Stripe::RequestParams
class BankTransfer < Stripe::RequestParams
class EuBankTransfer < Stripe::RequestParams
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
attr_accessor :country
def initialize(country: nil)
@country = country
end
end
# Configuration for the eu_bank_transfer funding type.
attr_accessor :eu_bank_transfer
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
#
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
attr_accessor :requested_address_types
# The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
attr_accessor :type
def initialize(eu_bank_transfer: nil, requested_address_types: nil, type: nil)
@eu_bank_transfer = eu_bank_transfer
@requested_address_types = requested_address_types
@type = type
end
end
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
attr_accessor :bank_transfer
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
attr_accessor :funding_type
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(bank_transfer: nil, funding_type: nil, setup_future_usage: nil)
@bank_transfer = bank_transfer
@funding_type = funding_type
@setup_future_usage = setup_future_usage
end
end
class Eps < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Fpx < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Giropay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Gopay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Grabpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class IdBankTransfer < Stripe::RequestParams
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from 5 minutes from now until 31 days from now. If unset, it defaults to 3 days from now.
attr_accessor :expires_after
# The UNIX timestamp until which the virtual bank account is valid. Permitted range is from now until 30 days from now. If unset, it defaults to 1 days from now.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after: nil, expires_at: nil, setup_future_usage: nil)
@expires_after = expires_after
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Ideal < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class InteracPresent < Stripe::RequestParams; end
class KakaoPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Klarna < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Preferred language of the Klarna authorization page that the customer is redirected to
attr_accessor :preferred_locale
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, preferred_locale: nil, setup_future_usage: nil)
@capture_method = capture_method
@preferred_locale = preferred_locale
@setup_future_usage = setup_future_usage
end
end
class Konbini < Stripe::RequestParams
# An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.
attr_accessor :confirmation_number
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
attr_accessor :expires_after_days
# The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.
attr_accessor :expires_at
# A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
attr_accessor :product_description
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(
confirmation_number: nil,
expires_after_days: nil,
expires_at: nil,
product_description: nil,
setup_future_usage: nil
)
@confirmation_number = confirmation_number
@expires_after_days = expires_after_days
@expires_at = expires_at
@product_description = product_description
@setup_future_usage = setup_future_usage
end
end
class KrCard < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Link < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# [Deprecated] This is a legacy parameter that no longer has any function.
attr_accessor :persistent_token
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, persistent_token: nil, setup_future_usage: nil)
@capture_method = capture_method
@persistent_token = persistent_token
@setup_future_usage = setup_future_usage
end
end
class MbWay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Mobilepay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class Multibanco < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class NaverPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class NzBankAccount < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(setup_future_usage: nil, target_date: nil)
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Oxxo < Stripe::RequestParams
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
attr_accessor :expires_after_days
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_days: nil, setup_future_usage: nil)
@expires_after_days = expires_after_days
@setup_future_usage = setup_future_usage
end
end
class P24 < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Confirm that the payer has accepted the P24 terms and conditions.
attr_accessor :tos_shown_and_accepted
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil)
@setup_future_usage = setup_future_usage
@tos_shown_and_accepted = tos_shown_and_accepted
end
end
class PayByBank < Stripe::RequestParams; end
class Payco < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Paynow < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Paypal < Stripe::RequestParams
class LineItem < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The tax for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :amount
# The tax behavior for the line item.
attr_accessor :behavior
def initialize(amount: nil, behavior: nil)
@amount = amount
@behavior = behavior
end
end
# Type of the line item.
attr_accessor :category
# Description of the line item.
attr_accessor :description
# Descriptive name of the line item.
attr_accessor :name
# Quantity of the line item. Must be a positive number.
attr_accessor :quantity
# Client facing stock keeping unit, article number or similar.
attr_accessor :sku
# The Stripe account ID of the connected account that sells the item.
attr_accessor :sold_by
# The tax information for the line item.
attr_accessor :tax
# Price for a single unit of the line item in minor units. Cannot be a negative number.
attr_accessor :unit_amount
def initialize(
category: nil,
description: nil,
name: nil,
quantity: nil,
sku: nil,
sold_by: nil,
tax: nil,
unit_amount: nil
)
@category = category
@description = description
@name = name
@quantity = quantity
@sku = sku
@sold_by = sold_by
@tax = tax
@unit_amount = unit_amount
end
end
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# The line items purchased by the customer.
attr_accessor :line_items
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
attr_accessor :preferred_locale
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
attr_accessor :reference_id
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
attr_accessor :risk_correlation_id
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
attr_accessor :subsellers
def initialize(
capture_method: nil,
line_items: nil,
preferred_locale: nil,
reference: nil,
reference_id: nil,
risk_correlation_id: nil,
setup_future_usage: nil,
subsellers: nil
)
@capture_method = capture_method
@line_items = line_items
@preferred_locale = preferred_locale
@reference = reference
@reference_id = reference_id
@risk_correlation_id = risk_correlation_id
@setup_future_usage = setup_future_usage
@subsellers = subsellers
end
end
class Payto < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Amount that will be collected. It is required when `amount_type` is `fixed`.
attr_accessor :amount
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
attr_accessor :amount_type
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
attr_accessor :end_date
# The periodicity at which payments will be collected.
attr_accessor :payment_schedule
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
attr_accessor :payments_per_period
# The purpose for which payments are made. Defaults to retail.
attr_accessor :purpose
def initialize(
amount: nil,
amount_type: nil,
end_date: nil,
payment_schedule: nil,
payments_per_period: nil,
purpose: nil
)
@amount = amount
@amount_type = amount_type
@end_date = end_date
@payment_schedule = payment_schedule
@payments_per_period = payments_per_period
@purpose = purpose
end
end
# Additional fields for Mandate creation. Only `purpose` field is configurable for PayTo PaymentIntent with `setup_future_usage=none`. Other fields are only applicable to PayTo PaymentIntent with `setup_future_usage=off_session`
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(mandate_options: nil, setup_future_usage: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
end
end
class Pix < Stripe::RequestParams
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
attr_accessor :expires_after_seconds
# The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
attr_accessor :expires_at
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(expires_after_seconds: nil, expires_at: nil, setup_future_usage: nil)
@expires_after_seconds = expires_after_seconds
@expires_at = expires_at
@setup_future_usage = setup_future_usage
end
end
class Promptpay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Qris < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Rechnung < Stripe::RequestParams; end
class RevolutPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_accessor :setup_future_usage
def initialize(capture_method: nil, setup_future_usage: nil)
@capture_method = capture_method
@setup_future_usage = setup_future_usage
end
end
class SamsungPay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class Satispay < Stripe::RequestParams
# Controls when the funds are captured from the customer's account.
#
# If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.
#
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
attr_accessor :capture_method
def initialize(capture_method: nil)
@capture_method = capture_method
end
end
class SepaDebit < Stripe::RequestParams
class MandateOptions < Stripe::RequestParams
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
attr_accessor :reference_prefix
def initialize(reference_prefix: nil)
@reference_prefix = reference_prefix
end
end
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
@mandate_options = mandate_options
@setup_future_usage = setup_future_usage
@target_date = target_date
end
end
class Shopeepay < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Sofort < Stripe::RequestParams
# Language shown to the payer on redirect.
attr_accessor :preferred_language
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(preferred_language: nil, setup_future_usage: nil)
@preferred_language = preferred_language
@setup_future_usage = setup_future_usage
end
end
class StripeBalance < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class Swish < Stripe::RequestParams
# A reference for this payment to be displayed in the Swish app.
attr_accessor :reference
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(reference: nil, setup_future_usage: nil)
@reference = reference
@setup_future_usage = setup_future_usage
end
end
class Twint < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
class UsBankAccount < Stripe::RequestParams
class FinancialConnections < Stripe::RequestParams
class Filters < Stripe::RequestParams
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
attr_accessor :account_subcategories
# ID of the institution to use to filter for selectable accounts.
attr_accessor :institution
def initialize(account_subcategories: nil, institution: nil)
@account_subcategories = account_subcategories
@institution = institution
end
end
class ManualEntry < Stripe::RequestParams
# Settings for configuring manual entry of account details.
attr_accessor :mode
def initialize(mode: nil)
@mode = mode
end
end
# Provide filters for the linked accounts that the customer can select for the payment method.
attr_accessor :filters
# Customize manual entry behavior
attr_accessor :manual_entry
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
attr_accessor :permissions
# List of data features that you would like to retrieve upon account creation.
attr_accessor :prefetch
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
attr_accessor :return_url
def initialize(
filters: nil,
manual_entry: nil,
permissions: nil,
prefetch: nil,
return_url: nil
)
@filters = filters
@manual_entry = manual_entry
@permissions = permissions
@prefetch = prefetch
@return_url = return_url
end
end
class MandateOptions < Stripe::RequestParams
# The method used to collect offline mandate customer acceptance.
attr_accessor :collection_method
def initialize(collection_method: nil)
@collection_method = collection_method
end
end
class Networks < Stripe::RequestParams
# Triggers validations to run across the selected networks
attr_accessor :requested
def initialize(requested: nil)
@requested = requested
end
end
# Additional fields for Financial Connections Session creation
attr_accessor :financial_connections
# Additional fields for Mandate creation
attr_accessor :mandate_options
# Additional fields for network related functions
attr_accessor :networks
# Preferred transaction settlement speed
attr_accessor :preferred_settlement_speed
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
attr_accessor :target_date
# Bank account verification method.
attr_accessor :verification_method
def initialize(
financial_connections: nil,
mandate_options: nil,
networks: nil,
preferred_settlement_speed: nil,
setup_future_usage: nil,
target_date: nil,
verification_method: nil
)
@financial_connections = financial_connections
@mandate_options = mandate_options
@networks = networks
@preferred_settlement_speed = preferred_settlement_speed
@setup_future_usage = setup_future_usage
@target_date = target_date
@verification_method = verification_method
end
end
class WechatPay < Stripe::RequestParams
# The app ID registered with WeChat Pay. Only required when client is ios or android.
attr_accessor :app_id
# The client type that the end customer will pay from
attr_accessor :client
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(app_id: nil, client: nil, setup_future_usage: nil)
@app_id = app_id
@client = client
@setup_future_usage = setup_future_usage
end
end
class Zip < Stripe::RequestParams
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
def initialize(setup_future_usage: nil)
@setup_future_usage = setup_future_usage
end
end
# If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
attr_accessor :acss_debit
# If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
attr_accessor :affirm
# If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
attr_accessor :afterpay_clearpay
# If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
attr_accessor :alipay
# If this is a `alma` PaymentMethod, this sub-hash contains details about the Alma payment method options.
attr_accessor :alma
# If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.
attr_accessor :amazon_pay
# If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
attr_accessor :au_becs_debit
# If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
attr_accessor :bacs_debit
# If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
attr_accessor :bancontact
# If this is a `billie` PaymentMethod, this sub-hash contains details about the Billie payment method options.
attr_accessor :billie
# If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
attr_accessor :blik
# If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
attr_accessor :boleto
# Configuration for any card payments attempted on this PaymentIntent.
attr_accessor :card
# If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :card_present
# If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
attr_accessor :cashapp
# If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
attr_accessor :customer_balance
# If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
attr_accessor :eps
# If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
attr_accessor :fpx
# If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
attr_accessor :giropay
# If this is a `gopay` PaymentMethod, this sub-hash contains details about the Gopay payment method options.
attr_accessor :gopay
# If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
attr_accessor :grabpay
# If this is a `id_bank_transfer` PaymentMethod, this sub-hash contains details about the Indonesia Bank Transfer payment method options.
attr_accessor :id_bank_transfer
# If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
attr_accessor :ideal
# If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
attr_accessor :interac_present
# If this is a `kakao_pay` PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.
attr_accessor :kakao_pay
# If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
attr_accessor :klarna
# If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
attr_accessor :konbini
# If this is a `kr_card` PaymentMethod, this sub-hash contains details about the KR Card payment method options.
attr_accessor :kr_card
# If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
attr_accessor :link
# If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.
attr_accessor :mb_way
# If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.
attr_accessor :mobilepay
# If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.
attr_accessor :multibanco
# If this is a `naver_pay` PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.
attr_accessor :naver_pay
# If this is a `nz_bank_account` PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.
attr_accessor :nz_bank_account
# If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
attr_accessor :oxxo
# If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
attr_accessor :p24
# If this is a `pay_by_bank` PaymentMethod, this sub-hash contains details about the PayByBank payment method options.
attr_accessor :pay_by_bank
# If this is a `payco` PaymentMethod, this sub-hash contains details about the PAYCO payment method options.
attr_accessor :payco
# If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
attr_accessor :paynow
# If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
attr_accessor :paypal
# If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.
attr_accessor :payto
# If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
attr_accessor :pix
# If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
attr_accessor :promptpay
# If this is a `qris` PaymentMethod, this sub-hash contains details about the QRIS payment method options.
attr_accessor :qris
# If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.
attr_accessor :rechnung
# If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.
attr_accessor :revolut_pay
# If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.
attr_accessor :samsung_pay
# If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options.
attr_accessor :satispay
# If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
attr_accessor :sepa_debit
# If this is a `shopeepay` PaymentMethod, this sub-hash contains details about the ShopeePay payment method options.
attr_accessor :shopeepay
# If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
attr_accessor :sofort
# If this is a `stripe_balance` PaymentMethod, this sub-hash contains details about the Stripe Balance payment method options.
attr_accessor :stripe_balance
# If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.
attr_accessor :swish
# If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.
attr_accessor :twint
# If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
attr_accessor :us_bank_account
# If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
attr_accessor :wechat_pay
# If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
attr_accessor :zip
def initialize(
acss_debit: nil,
affirm: nil,
afterpay_clearpay: nil,
alipay: nil,
alma: nil,
amazon_pay: nil,
au_becs_debit: nil,
bacs_debit: nil,
bancontact: nil,
billie: nil,
blik: nil,
boleto: nil,
card: nil,
card_present: nil,
cashapp: nil,
customer_balance: nil,
eps: nil,
fpx: nil,
giropay: nil,
gopay: nil,
grabpay: nil,
id_bank_transfer: nil,
ideal: nil,
interac_present: nil,
kakao_pay: nil,
klarna: nil,
konbini: nil,
kr_card: nil,
link: nil,
mb_way: nil,
mobilepay: nil,
multibanco: nil,
naver_pay: nil,
nz_bank_account: nil,
oxxo: nil,
p24: nil,
pay_by_bank: nil,
payco: nil,
paynow: nil,
paypal: nil,
payto: nil,
pix: nil,
promptpay: nil,
qris: nil,
rechnung: nil,
revolut_pay: nil,
samsung_pay: nil,
satispay: nil,
sepa_debit: nil,
shopeepay: nil,
sofort: nil,
stripe_balance: nil,
swish: nil,
twint: nil,
us_bank_account: nil,
wechat_pay: nil,
zip: nil
)
@acss_debit = acss_debit
@affirm = affirm
@afterpay_clearpay = afterpay_clearpay
@alipay = alipay
@alma = alma
@amazon_pay = amazon_pay
@au_becs_debit = au_becs_debit
@bacs_debit = bacs_debit
@bancontact = bancontact
@billie = billie
@blik = blik
@boleto = boleto
@card = card
@card_present = card_present
@cashapp = cashapp
@customer_balance = customer_balance
@eps = eps
@fpx = fpx
@giropay = giropay
@gopay = gopay
@grabpay = grabpay
@id_bank_transfer = id_bank_transfer
@ideal = ideal
@interac_present = interac_present
@kakao_pay = kakao_pay
@klarna = klarna
@konbini = konbini
@kr_card = kr_card
@link = link
@mb_way = mb_way
@mobilepay = mobilepay
@multibanco = multibanco
@naver_pay = naver_pay
@nz_bank_account = nz_bank_account
@oxxo = oxxo
@p24 = p24
@pay_by_bank = pay_by_bank
@payco = payco
@paynow = paynow
@paypal = paypal
@payto = payto
@pix = pix
@promptpay = promptpay
@qris = qris
@rechnung = rechnung
@revolut_pay = revolut_pay
@samsung_pay = samsung_pay
@satispay = satispay
@sepa_debit = sepa_debit
@shopeepay = shopeepay
@sofort = sofort
@stripe_balance = stripe_balance
@swish = swish
@twint = twint
@us_bank_account = us_bank_account
@wechat_pay = wechat_pay
@zip = zip
end
end
class RadarOptions < Stripe::RequestParams
# A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
attr_accessor :session
def initialize(session: nil)
@session = session
end
end
class Shipping < Stripe::RequestParams
class Address < Stripe::RequestParams
# City, district, suburb, town, or village.
attr_accessor :city
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
attr_accessor :country
# Address line 1 (e.g., street, PO Box, or company name).
attr_accessor :line1
# Address line 2 (e.g., apartment, suite, unit, or building).
attr_accessor :line2
# ZIP or postal code.
attr_accessor :postal_code
# State, county, province, or region.
attr_accessor :state
def initialize(
city: nil,
country: nil,
line1: nil,
line2: nil,
postal_code: nil,
state: nil
)
@city = city
@country = country
@line1 = line1
@line2 = line2
@postal_code = postal_code
@state = state
end
end
# Shipping address.
attr_accessor :address
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
attr_accessor :carrier
# Recipient name.
attr_accessor :name
# Recipient phone (including extension).
attr_accessor :phone
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
attr_accessor :tracking_number
def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
@address = address
@carrier = carrier
@name = name
@phone = phone
@tracking_number = tracking_number
end
end
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# Controls when the funds will be captured from the customer's account.
attr_accessor :capture_method
# ID of the ConfirmationToken used to confirm this PaymentIntent.
#
# If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
attr_accessor :confirmation_token
# Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).
attr_accessor :error_on_requires_action
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
attr_accessor :fx_quote
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# ID of the mandate that's used for this payment.
attr_accessor :mandate
# Attribute for param field mandate_data
attr_accessor :mandate_data
# Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
attr_accessor :off_session
# Provides industry-specific information about the charge.
attr_accessor :payment_details
# ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
# If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent.
attr_accessor :payment_method
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
# in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)
# property on the PaymentIntent.
attr_accessor :payment_method_data
# Payment method-specific configuration for this PaymentIntent.
attr_accessor :payment_method_options
# The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
attr_accessor :payment_method_types
# Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).
attr_accessor :radar_options
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
attr_accessor :receipt_email
# The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
# If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
# This parameter is only used for cards and other redirect-based payment methods.
attr_accessor :return_url
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
#
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
attr_accessor :setup_future_usage
# Shipping information for this PaymentIntent.
attr_accessor :shipping
# Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
attr_accessor :use_stripe_sdk
def initialize(
application_fee_amount: nil,
capture_method: nil,
confirmation_token: nil,
error_on_requires_action: nil,
expand: nil,
fx_quote: nil,
hooks: nil,
mandate: nil,
mandate_data: nil,
off_session: nil,
payment_details: nil,
payment_method: nil,
payment_method_data: nil,
payment_method_options: nil,
payment_method_types: nil,
radar_options: nil,
receipt_email: nil,
return_url: nil,
setup_future_usage: nil,
shipping: nil,
use_stripe_sdk: nil
)
@application_fee_amount = application_fee_amount
@capture_method = capture_method
@confirmation_token = confirmation_token
@error_on_requires_action = error_on_requires_action
@expand = expand
@fx_quote = fx_quote
@hooks = hooks
@mandate = mandate
@mandate_data = mandate_data
@off_session = off_session
@payment_details = payment_details
@payment_method = payment_method
@payment_method_data = payment_method_data
@payment_method_options = payment_method_options
@payment_method_types = payment_method_types
@radar_options = radar_options
@receipt_email = receipt_email
@return_url = return_url
@setup_future_usage = setup_future_usage
@shipping = shipping
@use_stripe_sdk = use_stripe_sdk
end
end
class DecrementAuthorizationParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
attr_accessor :amount
def initialize(amount: nil)
@amount = amount
end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount.
attr_accessor :amount
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_accessor :description
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_data
def initialize(
amount: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
transfer_data: nil
)
@amount = amount
@application_fee_amount = application_fee_amount
@description = description
@expand = expand
@hooks = hooks
@metadata = metadata
@transfer_data = transfer_data
end
end
class IncrementAuthorizationParams < Stripe::RequestParams
class Hooks < Stripe::RequestParams
class Inputs < Stripe::RequestParams
class Tax < Stripe::RequestParams
# The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
attr_accessor :calculation
def initialize(calculation: nil)
@calculation = calculation
end
end
# Tax arguments for automations
attr_accessor :tax
def initialize(tax: nil)
@tax = tax
end
end
# Arguments passed in automations
attr_accessor :inputs
def initialize(inputs: nil)
@inputs = inputs
end
end
class PaymentMethodOptions < Stripe::RequestParams
class Card < Stripe::RequestParams
# Request partial authorization on this PaymentIntent.
attr_accessor :request_partial_authorization
def initialize(request_partial_authorization: nil)
@request_partial_authorization = request_partial_authorization
end
end
# Configuration for any card payments attempted on this PaymentIntent.
attr_accessor :card
def initialize(card: nil)
@card = card
end
end
class TransferData < Stripe::RequestParams
# The amount that will be transferred automatically when a charge succeeds.
attr_accessor :amount
def initialize(amount: nil)
@amount = amount
end
end
# The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
attr_accessor :amount
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :application_fee_amount
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_accessor :description
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Automations to be run during the PaymentIntent lifecycle
attr_accessor :hooks
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# Payment method-specific configuration for this PaymentIntent.
attr_accessor :payment_method_options
# Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
attr_accessor :statement_descriptor
# The parameters used to automatically create a transfer after the payment is captured.
# Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_accessor :transfer_data
def initialize(
amount: nil,
application_fee_amount: nil,
description: nil,
expand: nil,
hooks: nil,
metadata: nil,
payment_method_options: nil,
statement_descriptor: nil,
transfer_data: nil
)
@amount = amount
@application_fee_amount = application_fee_amount
@description = description
@expand = expand
@hooks = hooks
@metadata = metadata
@payment_method_options = payment_method_options
@statement_descriptor = statement_descriptor
@transfer_data = transfer_data
end
end
class VerifyMicrodepositsParams < Stripe::RequestParams
# Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
attr_accessor :amounts
# A six-character code starting with SM present in the microdeposit sent to the bank account.
attr_accessor :descriptor_code
# Specifies which fields in the response should be expanded.
attr_accessor :expand
def initialize(amounts: nil, descriptor_code: nil, expand: nil)
@amounts = amounts
@descriptor_code = descriptor_code
@expand = expand
end
end
class TriggerActionParams < Stripe::RequestParams
class ScanQrCode < Stripe::RequestParams
# Whether the QR Code scan's payment should succeed or fail.
attr_accessor :result
def initialize(result: nil)
@result = result
end
end
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# True to simulate success, false to simulate failure.
attr_accessor :scan_qr_code
# The type of action to be simulated.
attr_accessor :type
def initialize(expand: nil, scan_qr_code: nil, type: nil)
@expand = expand
@scan_qr_code = scan_qr_code
@type = type
end
end
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
attr_reader :amount
# Amount that can be captured from this PaymentIntent.
attr_reader :amount_capturable
# Attribute for field amount_details
attr_reader :amount_details
# Amount that this PaymentIntent collects.
attr_reader :amount_received
# ID of the Connect application that created the PaymentIntent.
attr_reader :application
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_reader :application_fee_amount
# Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
attr_reader :automatic_payment_methods
# Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
attr_reader :canceled_at
# Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).
attr_reader :cancellation_reason
# Controls when the funds will be captured from the customer's account.
attr_reader :capture_method
# The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
#
# The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
#
# Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.
attr_reader :client_secret
# Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
attr_reader :confirmation_method
# Time at which the object was created. Measured in seconds since the Unix epoch.
attr_reader :created
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_reader :currency
# ID of the Customer this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
attr_reader :customer
# ID of the Account this PaymentIntent belongs to, if one exists.
#
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
#
# If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
attr_reader :customer_account
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_reader :description
# The FX Quote used for the PaymentIntent.
attr_reader :fx_quote
# Attribute for field hooks
attr_reader :hooks
# Unique identifier for the object.
attr_reader :id
# The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
attr_reader :last_payment_error
# ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.
attr_reader :latest_charge
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
attr_reader :livemode
# 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. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
attr_reader :metadata
# If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
attr_reader :next_action
# String representing the object's type. Objects of the same type share the same value.
attr_reader :object
# The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
attr_reader :on_behalf_of
# Attribute for field payment_details
attr_reader :payment_details
# ID of the payment method used in this PaymentIntent.
attr_reader :payment_method
# Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.
attr_reader :payment_method_configuration_details
# Payment-method-specific configuration for this PaymentIntent.
attr_reader :payment_method_options
# The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
attr_reader :payment_method_types
# Attribute for field presentment_details
attr_reader :presentment_details
# If present, this property tells you about the processing state of the payment.
attr_reader :processing
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
attr_reader :receipt_email
# ID of the review associated with this PaymentIntent, if any.
attr_reader :review
# Indicates whether confirmation for this PaymentIntent using a secret key is `required` or `optional`.
attr_reader :secret_key_confirmation
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
#
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
#
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
#
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
attr_reader :setup_future_usage
# Shipping information for this PaymentIntent.
attr_reader :shipping
# This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.
attr_reader :source
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
#
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
attr_reader :statement_descriptor
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
attr_reader :statement_descriptor_suffix
# Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
attr_reader :status
# The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
attr_reader :transfer_data
# A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
attr_reader :transfer_group
# Manually reconcile the remaining amount for a customer_balance PaymentIntent.
def apply_customer_balance(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/apply_customer_balance", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Manually reconcile the remaining amount for a customer_balance PaymentIntent.
def self.apply_customer_balance(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/apply_customer_balance", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing.
#
# After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
#
# You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
def cancel(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/cancel", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing.
#
# After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
#
# You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
def self.cancel(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/cancel", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
#
# Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
#
# Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later).
def capture(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/capture", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
#
# Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
#
# Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later).
def self.capture(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/capture", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Confirm that your customer intends to pay with current or provided
# payment method. Upon confirmation, the PaymentIntent will attempt to initiate
# a payment.
# If the selected payment method requires additional authentication steps, the
# PaymentIntent will transition to the requires_action status and
# suggest additional actions via next_action. If payment fails,
# the PaymentIntent transitions to the requires_payment_method status or the
# canceled status if the confirmation limit is reached. If
# payment succeeds, the PaymentIntent will transition to the succeeded
# status (or requires_capture, if capture_method is set to manual).
# If the confirmation_method is automatic, payment may be attempted
# using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
# and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
# After next_actions are handled by the client, no additional
# confirmation is required to complete the payment.
# If the confirmation_method is manual, all payment attempts must be
# initiated using a secret key.
# If any actions are required for the payment, the PaymentIntent will
# return to the requires_confirmation state
# after those actions are completed. Your server needs to then
# explicitly re-confirm the PaymentIntent to initiate the next payment
# attempt.
# There is a variable upper limit on how many times a PaymentIntent can be confirmed.
# After this limit is reached, any further calls to this endpoint will
# transition the PaymentIntent to the canceled state.
def confirm(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/confirm", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Confirm that your customer intends to pay with current or provided
# payment method. Upon confirmation, the PaymentIntent will attempt to initiate
# a payment.
# If the selected payment method requires additional authentication steps, the
# PaymentIntent will transition to the requires_action status and
# suggest additional actions via next_action. If payment fails,
# the PaymentIntent transitions to the requires_payment_method status or the
# canceled status if the confirmation limit is reached. If
# payment succeeds, the PaymentIntent will transition to the succeeded
# status (or requires_capture, if capture_method is set to manual).
# If the confirmation_method is automatic, payment may be attempted
# using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
# and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
# After next_actions are handled by the client, no additional
# confirmation is required to complete the payment.
# If the confirmation_method is manual, all payment attempts must be
# initiated using a secret key.
# If any actions are required for the payment, the PaymentIntent will
# return to the requires_confirmation state
# after those actions are completed. Your server needs to then
# explicitly re-confirm the PaymentIntent to initiate the next payment
# attempt.
# There is a variable upper limit on how many times a PaymentIntent can be confirmed.
# After this limit is reached, any further calls to this endpoint will
# transition the PaymentIntent to the canceled state.
def self.confirm(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/confirm", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Creates a PaymentIntent object.
#
# After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm)
# to continue the payment. Learn more about <a href="/docs/payments/payment-intents">the available payment flows
# with the Payment Intents API.
#
# When you use confirm=true during creation, it's equivalent to creating
# and confirming the PaymentIntent in the same call. You can use any parameters
# available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply
# confirm=true.
def self.create(params = {}, opts = {})
request_stripe_object(method: :post, path: "/v1/payment_intents", params: params, opts: opts)
end
# Perform a decremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
# must be available.
#
# Decremental authorizations decrease the authorized amount on your customer's card
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
#
# After decrement, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# The PaymentIntent will now be capturable up to the new authorized amount.
#
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
# After it's fully captured, a PaymentIntent can no longer be decremented.
def decrement_authorization(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Perform a decremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
# must be available.
#
# Decremental authorizations decrease the authorized amount on your customer's card
# to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
#
# After decrement, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# The PaymentIntent will now be capturable up to the new authorized amount.
#
# Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
# After it's fully captured, a PaymentIntent can no longer be decremented.
def self.decrement_authorization(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Perform an incremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported)
# must be true.
#
# Incremental authorizations attempt to increase the authorized amount on
# your customer's card to the new, higher amount provided. Similar to the
# initial authorization, incremental authorizations can be declined. A
# single PaymentIntent can call this endpoint multiple times to further
# increase the authorized amount.
#
# If the incremental authorization succeeds, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# If the incremental authorization fails, a
# [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other
# fields on the PaymentIntent or Charge update. The PaymentIntent
# object remains capturable for the previously authorized amount.
#
# Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.
# After it's captured, a PaymentIntent can no longer be incremented.
#
# Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations).
def increment_authorization(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/increment_authorization", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Perform an incremental authorization on an eligible
# [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
# PaymentIntent's status must be requires_capture and
# [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported)
# must be true.
#
# Incremental authorizations attempt to increase the authorized amount on
# your customer's card to the new, higher amount provided. Similar to the
# initial authorization, incremental authorizations can be declined. A
# single PaymentIntent can call this endpoint multiple times to further
# increase the authorized amount.
#
# If the incremental authorization succeeds, the PaymentIntent object
# returns with the updated
# [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
# If the incremental authorization fails, a
# [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other
# fields on the PaymentIntent or Charge update. The PaymentIntent
# object remains capturable for the previously authorized amount.
#
# Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.
# After it's captured, a PaymentIntent can no longer be incremented.
#
# Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations).
def self.increment_authorization(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/increment_authorization", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Returns a list of PaymentIntents.
def self.list(params = {}, opts = {})
request_stripe_object(method: :get, path: "/v1/payment_intents", params: params, opts: opts)
end
def self.search(params = {}, opts = {})
request_stripe_object(
method: :get,
path: "/v1/payment_intents/search",
params: params,
opts: opts
)
end
def self.search_auto_paging_each(params = {}, opts = {}, &blk)
search(params, opts).auto_paging_each(&blk)
end
# Trigger an external action on a PaymentIntent.
def trigger_action(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/test/payment_intents/%<intent>s/trigger_action", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Trigger an external action on a PaymentIntent.
def self.trigger_action(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/test/payment_intents/%<intent>s/trigger_action", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Updates properties on a PaymentIntent object without confirming.
#
# Depending on which properties you update, you might need to confirm the
# PaymentIntent again. For example, updating the payment_method
# always requires you to confirm the PaymentIntent again. If you prefer to
# update and confirm at the same time, we recommend updating properties through
# the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead.
def self.update(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
# Verifies microdeposits on a PaymentIntent object.
def verify_microdeposits(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Verifies microdeposits on a PaymentIntent object.
def self.verify_microdeposits(intent, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/payment_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(intent) }),
params: params,
opts: opts
)
end
end
end