sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-06-06 00:01:04 -04:00
Code Issues Projects Releases Wiki Activity
stripe-ruby/lib/stripe/resources/charge.rb
Stripe OpenAPI 1200cf2342 Update generated code for v1770
2025-05-20 18:14:52 +00:00

3242 lines
149 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
# The `Charge` object represents a single attempt to move money into your Stripe account.
# PaymentIntent confirmation is the most common way to create Charges, but transferring
# money to a different Stripe account through Connect also creates Charges.
# Some legacy payment flows create Charges directly, which is not recommended for new integrations.
class Charge < APIResource
extend Stripe::APIOperations::Create
extend Stripe::APIOperations::List
extend Stripe::APIOperations::NestedResource
extend Stripe::APIOperations::Search
include Stripe::APIOperations::Save
OBJECT_NAME = "charge"
def self.object_name
"charge"
end
nested_resource_class_methods :refund, operations: %i[retrieve list]
class BillingDetails < 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
# Billing address.
attr_reader :address
# Email address.
attr_reader :email
# Full name.
attr_reader :name
# Billing phone number (including extension).
attr_reader :phone
# Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
attr_reader :tax_id
end
class FraudDetails < Stripe::StripeObject
# Assessments from Stripe. If set, the value is `fraudulent`.
attr_reader :stripe_report
# Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
attr_reader :user_report
end
class Level3 < Stripe::StripeObject
class LineItem < Stripe::StripeObject
# Attribute for field discount_amount
attr_reader :discount_amount
# Attribute for field product_code
attr_reader :product_code
# Attribute for field product_description
attr_reader :product_description
# Attribute for field quantity
attr_reader :quantity
# Attribute for field tax_amount
attr_reader :tax_amount
# Attribute for field unit_cost
attr_reader :unit_cost
end
# Attribute for field customer_reference
attr_reader :customer_reference
# Attribute for field line_items
attr_reader :line_items
# Attribute for field merchant_reference
attr_reader :merchant_reference
# Attribute for field shipping_address_zip
attr_reader :shipping_address_zip
# Attribute for field shipping_amount
attr_reader :shipping_amount
# Attribute for field shipping_from_zip
attr_reader :shipping_from_zip
end
class Outcome < Stripe::StripeObject
class Rule < Stripe::StripeObject
# The action taken on the payment.
attr_reader :action
# Unique identifier for the object.
attr_reader :id
# The predicate to evaluate the payment against.
attr_reader :predicate
end
# An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
attr_reader :advice_code
# For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
attr_reader :network_advice_code
# For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
attr_reader :network_decline_code
# Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
attr_reader :network_status
# An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
attr_reader :reason
# Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
attr_reader :risk_level
# Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
attr_reader :risk_score
# The ID of the Radar rule that matched the payment, if applicable.
attr_reader :rule
# A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
attr_reader :seller_message
# Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
attr_reader :type
end
class PaymentMethodDetails < Stripe::StripeObject
class AchCreditTransfer < Stripe::StripeObject
# Account number to transfer funds to.
attr_reader :account_number
# Name of the bank associated with the routing number.
attr_reader :bank_name
# Routing transit number for the bank account to transfer funds to.
attr_reader :routing_number
# SWIFT code of the bank associated with the routing number.
attr_reader :swift_code
end
class AchDebit < Stripe::StripeObject
# Type of entity that holds the account. This can be either `individual` or `company`.
attr_reader :account_holder_type
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Two-letter ISO code representing the country the bank account is located in.
attr_reader :country
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Last four digits of the bank account number.
attr_reader :last4
# Routing transit number of the bank account.
attr_reader :routing_number
end
class AcssDebit < Stripe::StripeObject
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Institution number of the bank account
attr_reader :institution_number
# Last four digits of the bank account number.
attr_reader :last4
# ID of the mandate used to make this payment.
attr_reader :mandate
# Transit number of the bank account.
attr_reader :transit_number
end
class Affirm < Stripe::StripeObject
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
attr_reader :location
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
attr_reader :reader
# The Affirm transaction ID associated with this payment.
attr_reader :transaction_id
end
class AfterpayClearpay < Stripe::StripeObject
# The Afterpay order ID associated with this payment intent.
attr_reader :order_id
# Order identifier shown to the merchant in Afterpay’s online portal.
attr_reader :reference
end
class Alipay < Stripe::StripeObject
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
attr_reader :buyer_id
# Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
attr_reader :fingerprint
# Transaction ID of this particular Alipay transaction.
attr_reader :transaction_id
end
class Alma < Stripe::StripeObject; end
class AmazonPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :brand
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
attr_reader :brand_product
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
attr_reader :country
# Two-digit number representing the card's expiration month.
attr_reader :exp_month
# Four-digit number representing the card's expiration year.
attr_reader :exp_year
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
attr_reader :funding
# The last four digits of the card.
attr_reader :last4
end
# Attribute for field card
attr_reader :card
# funding type of the underlying payment method.
attr_reader :type
end
# Attribute for field funding
attr_reader :funding
end
class AuBecsDebit < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
attr_reader :bsb_number
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Last four digits of the bank account number.
attr_reader :last4
# ID of the mandate used to make this payment.
attr_reader :mandate
end
class BacsDebit < Stripe::StripeObject
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Last four digits of the bank account number.
attr_reader :last4
# ID of the mandate used to make this payment.
attr_reader :mandate
# Sort code of the bank account. (e.g., `10-20-30`)
attr_reader :sort_code
end
class Bancontact < Stripe::StripeObject
# Bank code of bank associated with the bank account.
attr_reader :bank_code
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Bank Identifier Code of the bank associated with the bank account.
attr_reader :bic
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit_mandate
# Last four characters of the IBAN.
attr_reader :iban_last4
# Preferred language of the Bancontact authorization page that the customer is redirected to.
# Can be one of `en`, `de`, `fr`, or `nl`
attr_reader :preferred_language
# Owner's verified full name. Values are verified or provided by Bancontact directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :verified_name
end
class Billie < Stripe::StripeObject; end
class Blik < Stripe::StripeObject
# A unique and immutable identifier assigned by BLIK to every buyer.
attr_reader :buyer_id
end
class Boleto < Stripe::StripeObject
# The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
attr_reader :tax_id
end
class Card < Stripe::StripeObject
class Checks < Stripe::StripeObject
# If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
attr_reader :address_line1_check
# If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
attr_reader :address_postal_code_check
# If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
attr_reader :cvc_check
end
class DecrementalAuthorization < Stripe::StripeObject
# Indicates whether or not the decremental authorization feature is supported.
attr_reader :status
end
class ExtendedAuthorization < Stripe::StripeObject
# Indicates whether or not the capture window is extended beyond the standard authorization.
attr_reader :status
end
class IncrementalAuthorization < Stripe::StripeObject
# Indicates whether or not the incremental authorization feature is supported.
attr_reader :status
end
class Installments < Stripe::StripeObject
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 plan selected for the payment.
attr_reader :plan
end
class Multicapture < Stripe::StripeObject
# Indicates whether or not multiple captures are supported.
attr_reader :status
end
class NetworkToken < Stripe::StripeObject
# Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
attr_reader :used
end
class Overcapture < Stripe::StripeObject
# The maximum amount that can be captured.
attr_reader :maximum_amount_capturable
# Indicates whether or not the authorized amount can be over-captured.
attr_reader :status
end
class PartialAuthorization < Stripe::StripeObject
# Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
attr_reader :status
end
class ThreeDSecure < Stripe::StripeObject
# For authenticated transactions: how the customer was authenticated by
# the issuing bank.
attr_reader :authentication_flow
# The Electronic Commerce Indicator (ECI). A protocol-level field
# indicating what degree of authentication was performed.
attr_reader :electronic_commerce_indicator
# The exemption requested via 3DS and accepted by the issuer at authentication time.
attr_reader :exemption_indicator
# Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
# the outcome of Stripe's internal risk assessment.
attr_reader :exemption_indicator_applied
# Indicates the outcome of 3D Secure authentication.
attr_reader :result
# Additional information about why 3D Secure succeeded or failed based
# on the `result`.
attr_reader :result_reason
# The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
# (dsTransId) for this payment.
attr_reader :transaction_id
# The version of 3D Secure that was used.
attr_reader :version
end
class Wallet < Stripe::StripeObject
class AmexExpressCheckout < Stripe::StripeObject; end
class ApplePay < Stripe::StripeObject; end
class GooglePay < Stripe::StripeObject; end
class Link < Stripe::StripeObject; end
class Masterpass < Stripe::StripeObject
class BillingAddress < 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 ShippingAddress < 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
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :billing_address
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :email
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :name
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :shipping_address
end
class SamsungPay < Stripe::StripeObject; end
class VisaCheckout < Stripe::StripeObject
class BillingAddress < 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 ShippingAddress < 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
# Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :billing_address
# Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :email
# Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :name
# Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :shipping_address
end
# Attribute for field amex_express_checkout
attr_reader :amex_express_checkout
# Attribute for field apple_pay
attr_reader :apple_pay
# (For tokenized numbers only.) The last four digits of the device account number.
attr_reader :dynamic_last4
# Attribute for field google_pay
attr_reader :google_pay
# Attribute for field link
attr_reader :link
# Attribute for field masterpass
attr_reader :masterpass
# Attribute for field samsung_pay
attr_reader :samsung_pay
# The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
attr_reader :type
# Attribute for field visa_checkout
attr_reader :visa_checkout
end
# The authorized amount.
attr_reader :amount_authorized
# The latest amount intended to be authorized by this charge.
attr_reader :amount_requested
# Authorization code on the charge.
attr_reader :authorization_code
# Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :brand
# When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
attr_reader :capture_before
# Check results by Card networks on Card address and CVC at time of payment.
attr_reader :checks
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
attr_reader :country
# Attribute for field decremental_authorization
attr_reader :decremental_authorization
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
attr_reader :description
# Two-digit number representing the card's expiration month.
attr_reader :exp_month
# Four-digit number representing the card's expiration year.
attr_reader :exp_year
# Attribute for field extended_authorization
attr_reader :extended_authorization
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
attr_reader :fingerprint
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
attr_reader :funding
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
attr_reader :iin
# Attribute for field incremental_authorization
attr_reader :incremental_authorization
# Installment details for this payment (Mexico only).
#
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
attr_reader :installments
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
attr_reader :issuer
# The last four digits of the card.
attr_reader :last4
# ID of the mandate used to make this payment or created by it.
attr_reader :mandate
# True if this payment was marked as MOTO and out of scope for SCA.
attr_reader :moto
# Attribute for field multicapture
attr_reader :multicapture
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :network
# If this card has network token credentials, this contains the details of the network token credentials.
attr_reader :network_token
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
attr_reader :network_transaction_id
# Attribute for field overcapture
attr_reader :overcapture
# Attribute for field partial_authorization
attr_reader :partial_authorization
# Status of a card based on the card issuer.
attr_reader :regulated_status
# Populated if this transaction used 3D Secure authentication.
attr_reader :three_d_secure
# If this Card is part of a card wallet, this contains the details of the card wallet.
attr_reader :wallet
end
class CardPresent < Stripe::StripeObject
class Offline < Stripe::StripeObject
# Time at which the payment was collected while offline
attr_reader :stored_at
# The method used to process this payment method offline. Only deferred is allowed.
attr_reader :type
end
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
attr_reader :account_type
# EMV tag 9F26, cryptogram generated by the integrated circuit chip.
attr_reader :application_cryptogram
# Mnenomic of the Application Identifier.
attr_reader :application_preferred_name
# Identifier for this transaction.
attr_reader :authorization_code
# EMV tag 8A. A code returned by the card issuer.
attr_reader :authorization_response_code
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
attr_reader :cardholder_verification_method
# EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
attr_reader :dedicated_file_name
# The outcome of a series of EMV functions performed by the card reader.
attr_reader :terminal_verification_results
# An indication of various EMV functions performed during the transaction.
attr_reader :transaction_status_information
end
class Wallet < Stripe::StripeObject
# The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
attr_reader :type
end
# The authorized amount
attr_reader :amount_authorized
# Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :brand
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
attr_reader :brand_product
# When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
attr_reader :capture_before
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
attr_reader :cardholder_name
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
attr_reader :country
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
attr_reader :description
# Authorization response cryptogram.
attr_reader :emv_auth_data
# Two-digit number representing the card's expiration month.
attr_reader :exp_month
# Four-digit number representing the card's expiration year.
attr_reader :exp_year
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
attr_reader :fingerprint
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
attr_reader :funding
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
attr_reader :generated_card
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
attr_reader :iin
# Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
attr_reader :incremental_authorization_supported
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
attr_reader :issuer
# The last four digits of the card.
attr_reader :last4
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :network
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
attr_reader :network_transaction_id
# Details about payments collected offline.
attr_reader :offline
# Defines whether the authorized amount can be over-captured or not
attr_reader :overcapture_supported
# EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
attr_reader :preferred_locales
# How card details were read in this transaction.
attr_reader :read_method
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
attr_reader :receipt
# Attribute for field wallet
attr_reader :wallet
end
class Cashapp < Stripe::StripeObject
# A unique and immutable identifier assigned by Cash App to every buyer.
attr_reader :buyer_id
# A public identifier for buyers using Cash App.
attr_reader :cashtag
end
class CustomerBalance < Stripe::StripeObject; end
class Eps < Stripe::StripeObject
# The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
attr_reader :bank
# Owner's verified full name. Values are verified or provided by EPS directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# EPS rarely provides this information so the attribute is usually empty.
attr_reader :verified_name
end
class Fpx < Stripe::StripeObject
# Account holder type, if provided. Can be one of `individual` or `company`.
attr_reader :account_holder_type
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
attr_reader :bank
# Unique transaction id generated by FPX for every request from the merchant
attr_reader :transaction_id
end
class Giropay < Stripe::StripeObject
# Bank code of bank associated with the bank account.
attr_reader :bank_code
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Bank Identifier Code of the bank associated with the bank account.
attr_reader :bic
# Owner's verified full name. Values are verified or provided by Giropay directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Giropay rarely provides this information so the attribute is usually empty.
attr_reader :verified_name
end
class Gopay < Stripe::StripeObject; end
class Grabpay < Stripe::StripeObject
# Unique transaction id generated by GrabPay
attr_reader :transaction_id
end
class IdBankTransfer < Stripe::StripeObject
# Account number of the bank account to transfer funds to.
attr_reader :account_number
# Bank where the account is located.
attr_reader :bank
# Local bank code of the bank.
attr_reader :bank_code
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
attr_reader :display_name
end
class Ideal < Stripe::StripeObject
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
attr_reader :bank
# The Bank Identifier Code of the customer's bank.
attr_reader :bic
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit_mandate
# Last four characters of the IBAN.
attr_reader :iban_last4
# Owner's verified full name. Values are verified or provided by iDEAL directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :verified_name
end
class InteracPresent < Stripe::StripeObject
class Receipt < Stripe::StripeObject
# The type of account being debited or credited
attr_reader :account_type
# EMV tag 9F26, cryptogram generated by the integrated circuit chip.
attr_reader :application_cryptogram
# Mnenomic of the Application Identifier.
attr_reader :application_preferred_name
# Identifier for this transaction.
attr_reader :authorization_code
# EMV tag 8A. A code returned by the card issuer.
attr_reader :authorization_response_code
# Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
attr_reader :cardholder_verification_method
# EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
attr_reader :dedicated_file_name
# The outcome of a series of EMV functions performed by the card reader.
attr_reader :terminal_verification_results
# An indication of various EMV functions performed during the transaction.
attr_reader :transaction_status_information
end
# Card brand. Can be `interac`, `mastercard` or `visa`.
attr_reader :brand
# The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
attr_reader :cardholder_name
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
attr_reader :country
# A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
attr_reader :description
# Authorization response cryptogram.
attr_reader :emv_auth_data
# Two-digit number representing the card's expiration month.
attr_reader :exp_month
# Four-digit number representing the card's expiration year.
attr_reader :exp_year
# Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
#
# *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
attr_reader :fingerprint
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
attr_reader :funding
# ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
attr_reader :generated_card
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
attr_reader :iin
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
attr_reader :issuer
# The last four digits of the card.
attr_reader :last4
# Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :network
# This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
attr_reader :network_transaction_id
# EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
attr_reader :preferred_locales
# How card details were read in this transaction.
attr_reader :read_method
# A collection of fields required to be displayed on receipts. Only required for EMV transactions.
attr_reader :receipt
end
class KakaoPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
attr_reader :buyer_id
end
class Klarna < Stripe::StripeObject
class PayerDetails < Stripe::StripeObject
class Address < Stripe::StripeObject
# The payer address country
attr_reader :country
end
# The payer's address
attr_reader :address
end
# The payer details for this transaction.
attr_reader :payer_details
# The Klarna payment method used for this transaction.
# Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
attr_reader :payment_method_category
# Preferred language of the Klarna authorization page that the customer is redirected to.
# Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
attr_reader :preferred_locale
end
class Konbini < Stripe::StripeObject
class Store < Stripe::StripeObject
# The name of the convenience store chain where the payment was completed.
attr_reader :chain
end
# If the payment succeeded, this contains the details of the convenience store where the payment was completed.
attr_reader :store
end
class KrCard < Stripe::StripeObject
# The local credit or debit card brand.
attr_reader :brand
# A unique identifier for the buyer as determined by the local payment processor.
attr_reader :buyer_id
# The last four digits of the card. This may not be present for American Express cards.
attr_reader :last4
end
class Link < Stripe::StripeObject
# Two-letter ISO code representing the funding source country beneath the Link payment.
# You could use this attribute to get a sense of international fees.
attr_reader :country
end
class MbWay < Stripe::StripeObject; end
class Mobilepay < Stripe::StripeObject
class Card < Stripe::StripeObject
# Brand of the card used in the transaction
attr_reader :brand
# Two-letter ISO code representing the country of the card
attr_reader :country
# Two digit number representing the card's expiration month
attr_reader :exp_month
# Two digit number representing the card's expiration year
attr_reader :exp_year
# The last 4 digits of the card
attr_reader :last4
end
# Internal card details
attr_reader :card
end
class Multibanco < Stripe::StripeObject
# Entity number associated with this Multibanco payment.
attr_reader :entity
# Reference number associated with this Multibanco payment.
attr_reader :reference
end
class NaverPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
attr_reader :buyer_id
end
class NzBankAccount < Stripe::StripeObject
# The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
attr_reader :account_holder_name
# The numeric code for the bank account's bank.
attr_reader :bank_code
# The name of the bank.
attr_reader :bank_name
# The numeric code for the bank account's bank branch.
attr_reader :branch_code
# Last four digits of the bank account number.
attr_reader :last4
# The suffix of the bank account number.
attr_reader :suffix
end
class Oxxo < Stripe::StripeObject
# OXXO reference number
attr_reader :number
end
class P24 < Stripe::StripeObject
# The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
attr_reader :bank
# Unique reference for this Przelewy24 payment.
attr_reader :reference
# Owner's verified full name. Values are verified or provided by Przelewy24 directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
# Przelewy24 rarely provides this information so the attribute is usually empty.
attr_reader :verified_name
end
class PayByBank < Stripe::StripeObject; end
class Payco < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
attr_reader :buyer_id
end
class Paynow < Stripe::StripeObject
# Reference number associated with this PayNow payment
attr_reader :reference
end
class Paypal < Stripe::StripeObject
class SellerProtection < Stripe::StripeObject
# An array of conditions that are covered for the transaction, if applicable.
attr_reader :dispute_categories
# Indicates whether the transaction is eligible for PayPal's seller protection.
attr_reader :status
end
class Shipping < 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 VerifiedAddress < 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
# Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :country
# Owner's email. Values are provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :payer_email
# PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
attr_reader :payer_id
# Owner's full name. Values provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :payer_name
# The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
attr_reader :seller_protection
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
attr_reader :shipping
# A unique ID generated by PayPal for this transaction.
attr_reader :transaction_id
# The shipping address for the customer, as supplied by the merchant at the point of payment
# execution. This shipping address will not be updated if the merchant updates the shipping
# address on the PaymentIntent after the PaymentIntent was successfully confirmed.
attr_reader :verified_address
# Owner's verified email. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :verified_email
# Owner's verified full name. Values are verified or provided by PayPal directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :verified_name
end
class Payto < Stripe::StripeObject
# Bank-State-Branch number of the bank account.
attr_reader :bsb_number
# Last four digits of the bank account number.
attr_reader :last4
# ID of the mandate used to make this payment.
attr_reader :mandate
# The PayID alias for the bank account.
attr_reader :pay_id
end
class Pix < Stripe::StripeObject
# Unique transaction id generated by BCB
attr_reader :bank_transaction_id
end
class Promptpay < Stripe::StripeObject
# Bill reference generated by PromptPay
attr_reader :reference
end
class Qris < Stripe::StripeObject; end
class Rechnung < Stripe::StripeObject; end
class RevolutPay < Stripe::StripeObject
class Funding < Stripe::StripeObject
class Card < Stripe::StripeObject
# Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
attr_reader :brand
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
attr_reader :brand_product
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
attr_reader :country
# Two-digit number representing the card's expiration month.
attr_reader :exp_month
# Four-digit number representing the card's expiration year.
attr_reader :exp_year
# Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
attr_reader :funding
# The last four digits of the card.
attr_reader :last4
end
# Attribute for field card
attr_reader :card
# funding type of the underlying payment method.
attr_reader :type
end
# Attribute for field funding
attr_reader :funding
end
class SamsungPay < Stripe::StripeObject
# A unique identifier for the buyer as determined by the local payment processor.
attr_reader :buyer_id
end
class Satispay < Stripe::StripeObject; end
class SepaCreditTransfer < Stripe::StripeObject
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Bank Identifier Code of the bank associated with the bank account.
attr_reader :bic
# IBAN of the bank account to transfer funds to.
attr_reader :iban
end
class SepaDebit < Stripe::StripeObject
# Bank code of bank associated with the bank account.
attr_reader :bank_code
# Branch code of bank associated with the bank account.
attr_reader :branch_code
# Two-letter ISO code representing the country the bank account is located in.
attr_reader :country
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Last four characters of the IBAN.
attr_reader :last4
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
attr_reader :mandate
end
class Shopeepay < Stripe::StripeObject; end
class Sofort < Stripe::StripeObject
# Bank code of bank associated with the bank account.
attr_reader :bank_code
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Bank Identifier Code of the bank associated with the bank account.
attr_reader :bic
# Two-letter ISO code representing the country the bank account is located in.
attr_reader :country
# The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit
# The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
attr_reader :generated_sepa_debit_mandate
# Last four characters of the IBAN.
attr_reader :iban_last4
# Preferred language of the SOFORT authorization page that the customer is redirected to.
# Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
attr_reader :preferred_language
# Owner's verified full name. Values are verified or provided by SOFORT directly
# (if supported) at the time of authorization or settlement. They cannot be set or mutated.
attr_reader :verified_name
end
class StripeAccount < Stripe::StripeObject; end
class StripeBalance < Stripe::StripeObject
# The connected account ID whose Stripe balance to use as the source of payment
attr_reader :account
# The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
attr_reader :source_type
end
class Swish < Stripe::StripeObject
# Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
attr_reader :fingerprint
# Payer bank reference number for the payment
attr_reader :payment_reference
# The last four digits of the Swish account phone number
attr_reader :verified_phone_last4
end
class Twint < Stripe::StripeObject; end
class UsBankAccount < Stripe::StripeObject
# Account holder type: individual or company.
attr_reader :account_holder_type
# Account type: checkings or savings. Defaults to checking if omitted.
attr_reader :account_type
# Name of the bank associated with the bank account.
attr_reader :bank_name
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
attr_reader :fingerprint
# Last four digits of the bank account number.
attr_reader :last4
# ID of the mandate used to make this payment.
attr_reader :mandate
# Reference number to locate ACH payments with customer's bank.
attr_reader :payment_reference
# Routing number of the bank account.
attr_reader :routing_number
end
class Wechat < Stripe::StripeObject; end
class WechatPay < Stripe::StripeObject
# Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
attr_reader :fingerprint
# ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
attr_reader :location
# ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
attr_reader :reader
# Transaction ID of this particular WeChat Pay transaction.
attr_reader :transaction_id
end
class Zip < Stripe::StripeObject; end
# Attribute for field ach_credit_transfer
attr_reader :ach_credit_transfer
# Attribute for field ach_debit
attr_reader :ach_debit
# 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_credit_transfer
attr_reader :sepa_credit_transfer
# 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_account
attr_reader :stripe_account
# Attribute for field stripe_balance
attr_reader :stripe_balance
# Attribute for field swish
attr_reader :swish
# Attribute for field twint
attr_reader :twint
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
# An additional hash is included on `payment_method_details` with a name matching this value.
# It contains information specific to the payment method.
attr_reader :type
# Attribute for field us_bank_account
attr_reader :us_bank_account
# Attribute for field wechat
attr_reader :wechat
# 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 RadarOptions < Stripe::StripeObject
# 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_reader :session
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, if specified. By default, the entire charge amount is transferred to the destination account.
attr_reader :amount
# ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
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
# Only return charges that were created during the given date interval.
attr_accessor :created
# Only return charges for the customer specified by this customer ID.
attr_accessor :customer
# 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
# Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
attr_accessor :payment_intent
# 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
# Only return charges for this transfer group, limited to 100.
attr_accessor :transfer_group
def initialize(
created: nil,
customer: nil,
ending_before: nil,
expand: nil,
limit: nil,
payment_intent: nil,
starting_after: nil,
transfer_group: nil
)
@created = created
@customer = customer
@ending_before = ending_before
@expand = expand
@limit = limit
@payment_intent = payment_intent
@starting_after = starting_after
@transfer_group = transfer_group
end
end
class CreateParams < Stripe::RequestParams
class Destination < Stripe::RequestParams
# ID of an existing, connected Stripe account.
attr_accessor :account
# The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
attr_accessor :amount
def initialize(account: nil, amount: nil)
@account = account
@amount = amount
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 transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
attr_accessor :amount
# ID of an existing, connected Stripe account.
attr_accessor :destination
def initialize(amount: nil, destination: nil)
@amount = amount
@destination = destination
end
end
# Amount intended to be collected by this payment. 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
# Attribute for param field application_fee
attr_accessor :application_fee
# A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
attr_accessor :application_fee_amount
# Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
attr_accessor :capture
# 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
# The ID of an existing customer that will be charged in this request.
attr_accessor :customer
# An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
attr_accessor :description
# Attribute for param field destination
attr_accessor :destination
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# 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 Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
attr_accessor :on_behalf_of
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
attr_accessor :radar_options
# The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
attr_accessor :receipt_email
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
attr_accessor :shipping
# A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
attr_accessor :source
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. 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).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
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. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
attr_accessor :statement_descriptor_suffix
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
attr_accessor :transfer_data
# A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
attr_accessor :transfer_group
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
capture: nil,
currency: nil,
customer: nil,
description: nil,
destination: nil,
expand: nil,
metadata: nil,
on_behalf_of: nil,
radar_options: nil,
receipt_email: nil,
shipping: nil,
source: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
)
@amount = amount
@application_fee = application_fee
@application_fee_amount = application_fee_amount
@capture = capture
@currency = currency
@customer = customer
@description = description
@destination = destination
@expand = expand
@metadata = metadata
@on_behalf_of = on_behalf_of
@radar_options = radar_options
@receipt_email = receipt_email
@shipping = shipping
@source = source
@statement_descriptor = statement_descriptor
@statement_descriptor_suffix = statement_descriptor_suffix
@transfer_data = transfer_data
@transfer_group = transfer_group
end
end
class UpdateParams < Stripe::RequestParams
class FraudDetails < Stripe::RequestParams
# Either `safe` or `fraudulent`.
attr_accessor :user_report
def initialize(user_report: nil)
@user_report = user_report
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 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 ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
attr_accessor :customer
# An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
attr_accessor :description
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
attr_accessor :fraud_details
# 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
# This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
attr_accessor :receipt_email
# Shipping information for the charge. Helps prevent fraud on charges for physical goods.
attr_accessor :shipping
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
attr_accessor :transfer_group
def initialize(
customer: nil,
description: nil,
expand: nil,
fraud_details: nil,
metadata: nil,
payment_details: nil,
receipt_email: nil,
shipping: nil,
transfer_group: nil
)
@customer = customer
@description = description
@expand = expand
@fraud_details = fraud_details
@metadata = metadata
@payment_details = payment_details
@receipt_email = receipt_email
@shipping = shipping
@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 charges](https://stripe.com/docs/search#query-fields-for-charges).
attr_accessor :query
def initialize(expand: nil, limit: nil, page: nil, query: nil)
@expand = expand
@limit = limit
@page = page
@query = query
end
end
class CaptureParams < Stripe::RequestParams
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 transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
attr_accessor :amount
def initialize(amount: nil)
@amount = amount
end
end
# The amount to capture, which must be less than or equal to the original amount.
attr_accessor :amount
# An application fee to add on to this charge.
attr_accessor :application_fee
# An application fee amount to add on to this charge, which must be less than or equal to the original amount.
attr_accessor :application_fee_amount
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Provides industry-specific information about the charge.
attr_accessor :payment_details
# The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
attr_accessor :receipt_email
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. 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).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
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. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
attr_accessor :statement_descriptor_suffix
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
attr_accessor :transfer_data
# A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
attr_accessor :transfer_group
def initialize(
amount: nil,
application_fee: nil,
application_fee_amount: nil,
expand: nil,
payment_details: nil,
receipt_email: nil,
statement_descriptor: nil,
statement_descriptor_suffix: nil,
transfer_data: nil,
transfer_group: nil
)
@amount = amount
@application_fee = application_fee
@application_fee_amount = application_fee_amount
@expand = expand
@payment_details = payment_details
@receipt_email = receipt_email
@statement_descriptor = statement_descriptor
@statement_descriptor_suffix = statement_descriptor_suffix
@transfer_data = transfer_data
@transfer_group = transfer_group
end
end
# Amount intended to be collected by this payment. 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 in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
attr_reader :amount_captured
# Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
attr_reader :amount_refunded
# ID of the Connect application that created the charge.
attr_reader :application
# The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
attr_reader :application_fee
# The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
attr_reader :application_fee_amount
# Authorization code on the charge.
attr_reader :authorization_code
# ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
attr_reader :balance_transaction
# Attribute for field billing_details
attr_reader :billing_details
# The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
attr_reader :calculated_statement_descriptor
# If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
attr_reader :captured
# 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 charge is for if one exists.
attr_reader :customer
# An arbitrary string attached to the object. Often useful for displaying to users.
attr_reader :description
# Whether the charge has been disputed.
attr_reader :disputed
# ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
attr_reader :failure_balance_transaction
# Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
attr_reader :failure_code
# Message to user further explaining reason for charge failure if available.
attr_reader :failure_message
# Information on fraud assessments for the charge.
attr_reader :fraud_details
# Unique identifier for the object.
attr_reader :id
# Attribute for field level3
attr_reader :level3
# 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.
attr_reader :metadata
# String representing the object's type. Objects of the same type share the same value.
attr_reader :object
# The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
attr_reader :on_behalf_of
# Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
attr_reader :outcome
# `true` if the charge succeeded, or was successfully authorized for later capture.
attr_reader :paid
# ID of the PaymentIntent associated with this charge, if one exists.
attr_reader :payment_intent
# ID of the payment method used in this charge.
attr_reader :payment_method
# Details about the payment method at the time of the transaction.
attr_reader :payment_method_details
# Attribute for field presentment_details
attr_reader :presentment_details
# Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
attr_reader :radar_options
# This is the email address that the receipt for this charge was sent to.
attr_reader :receipt_email
# This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
attr_reader :receipt_number
# This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
attr_reader :receipt_url
# Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
attr_reader :refunded
# A list of refunds that have been applied to the charge.
attr_reader :refunds
# ID of the review associated with this charge if one exists.
attr_reader :review
# Shipping information for the charge.
attr_reader :shipping
# This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
attr_reader :source
# The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
attr_reader :source_transfer
# For a non-card charge, text that appears on the customer's statement as the statement descriptor. 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).
#
# For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
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. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
attr_reader :statement_descriptor_suffix
# The status of the payment is either `succeeded`, `pending`, or `failed`.
attr_reader :status
# ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
attr_reader :transfer
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
attr_reader :transfer_data
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
attr_reader :transfer_group
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
#
# Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
#
# Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
def capture(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
#
# Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
#
# Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
def self.capture(charge, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
params: params,
opts: opts
)
end
# This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
# to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
# object used to request payment.
def self.create(params = {}, opts = {})
request_stripe_object(method: :post, path: "/v1/charges", params: params, opts: opts)
end
# Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
def self.list(params = {}, opts = {})
request_stripe_object(method: :get, path: "/v1/charges", params: params, opts: opts)
end
def self.search(params = {}, opts = {})
request_stripe_object(method: :get, path: "/v1/charges/search", params: params, opts: opts)
end
def self.search_auto_paging_each(params = {}, opts = {}, &blk)
search(params, opts).auto_paging_each(&blk)
end
# Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
def self.update(charge, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/charges/%<charge>s", { charge: CGI.escape(charge) }),
params: params,
opts: opts
)
end
end
end
Reference in New Issue View Git Blame Copy Permalink