stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/resources/issuing/dispute_settlement_detail.rb

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
+    class DisputeSettlementDetail < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.dispute_settlement_detail"
+      def self.object_name
+        "issuing.dispute_settlement_detail"
+      end
+
+      class NetworkData < ::Stripe::StripeObject
+        # The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
+        attr_reader :processing_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
+      attr_reader :amount
+      # The card used to make the original transaction.
+      attr_reader :card
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency the original transaction was made in. 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
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
+      attr_reader :event_type
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
+      attr_reader :network
+      # Details about the transaction, such as processing dates, set by the card network.
+      attr_reader :network_data
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ID of the linked card network settlement.
+      attr_reader :settlement
+
+      # Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/dispute_settlement_details",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { network_data: NetworkData }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/fraud_liability_debit.rb

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
+    class FraudLiabilityDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.fraud_liability_debit"
+      def self.object_name
+        "issuing.fraud_liability_debit"
+      end
+
+      # Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
+      attr_reader :amount
+      # ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this debit.
+      attr_reader :balance_transaction
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency of the debit. 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
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      # Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/fraud_liability_debits",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/program.rb

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # An Issuing `Program` represents a card program that the user has access to.
+    class Program < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "issuing.program"
+      def self.object_name
+        "issuing.program"
+      end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      attr_reader :id
+      # Whether or not this is the "default" issuing program new cards are created on. Only one active `is_default` program at the same time.
+      attr_reader :is_default
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The platform's Issuing Program for which this program is associated.
+      attr_reader :platform_program
+
+      # Create a Program object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/programs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List all of the programs the given Issuing user has access to.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/programs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a Program object.
+      def self.update(program, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/programs/%<program>s", { program: CGI.escape(program) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/settlement.rb

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
+    class Settlement < APIResource
+      OBJECT_NAME = "issuing.settlement"
+      def self.object_name
+        "issuing.settlement"
+      end
+
+      # The Bank Identification Number reflecting this settlement record.
+      attr_reader :bin
+      # The date that the transactions are cleared and posted to user's accounts.
+      attr_reader :clearing_date
+      # 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
+      # Unique identifier for the object.
+      attr_reader :id
+      # The total interchange received as reimbursement for the transactions.
+      attr_reader :interchange_fees_amount
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # The total net amount required to settle with the network.
+      attr_reader :net_total_amount
+      # The card network for this settlement report. One of ["visa", "maestro", "mastercard"]
+      attr_reader :network
+      # The total amount of fees owed to the network.
+      attr_reader :network_fees_amount
+      # The Settlement Identification Number assigned by the network.
+      attr_reader :network_settlement_identifier
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The total amount of any additional fees assessed by the card network.
+      attr_reader :other_fees_amount
+      # The total number of additional fees assessed by the card network.
+      attr_reader :other_fees_count
+      # One of `international` or `uk_national_net`.
+      attr_reader :settlement_service
+      # The current processing status of this settlement.
+      attr_reader :status
+      # The total transaction amount reflected in this settlement.
+      attr_reader :transaction_amount
+      # The total number of transactions reflected in this settlement.
+      attr_reader :transaction_count
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/token.rb

@@ -17,8 +17,12 @@ module Stripe
         class Device < ::Stripe::StripeObject
           # An obfuscated ID derived from the device ID.
           attr_reader :device_fingerprint
+          # An identifier for the device used during wallet provisioning.
+          attr_reader :device_id
           # The IP address of the device at provisioning time.
           attr_reader :ip_address
+          # The ISO 639-1 language code of the device associated with the tokenization request.
+          attr_reader :language
           # The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.
           attr_reader :location
           # The name of the device used for tokenization.
@@ -59,6 +63,8 @@ module Stripe
         class Visa < ::Stripe::StripeObject
           # A unique reference ID from Visa to represent the card account number.
           attr_reader :card_reference_id
+          # The network's recommendation to Stripe for this token activation request.
+          attr_reader :token_decision_recommendation
           # The network-unique identifier for the token.
           attr_reader :token_reference_id
           # The ID of the entity requesting tokenization, specific to Visa.
@@ -163,8 +169,12 @@ module Stripe
       attr_reader :network_updated_at
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
+      # The decision made during token provisioning.
+      attr_reader :provisioning_decision
       # The usage state of the token.
       attr_reader :status
+      # The type of the token, indicating how it is used.
+      attr_reader :token_type
       # The digital wallet for this token, if one was used.
       attr_reader :wallet_provider
 

data/lib/stripe/resources/issuing/transaction.rb

@@ -32,6 +32,121 @@ module Stripe
         end
       end
 
+      class CryptoTransaction < ::Stripe::StripeObject
+        class CryptoTransactionConfirmed < ::Stripe::StripeObject
+          class Fee < ::Stripe::StripeObject
+            # The fee amount.
+            attr_reader :amount
+            # The fee currency.
+            attr_reader :currency
+            # The fee type.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The crypto amount for the confirmed transaction.
+          attr_reader :amount
+          # The upcharged MCC amount, if one was applied.
+          attr_reader :amount_mcc_upcharged
+          # The blockchain network for the confirmed transaction.
+          attr_reader :chain
+          # When the transaction was confirmed onchain.
+          attr_reader :confirmed_at
+          # The currency of the crypto transaction amount.
+          attr_reader :currency
+          # Fees associated with the transaction.
+          attr_reader :fees
+          # The source wallet address for the transaction.
+          attr_reader :from_address
+          # Memo metadata attached to the transaction, if present.
+          attr_reader :memo
+          # The destination wallet address for the transaction.
+          attr_reader :to_address
+          # The blockchain transaction hash.
+          attr_reader :transaction_hash
+
+          def self.inner_class_types
+            @inner_class_types = { fees: Fee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CryptoTransactionFailed < ::Stripe::StripeObject
+          class Fee < ::Stripe::StripeObject
+            # The fee amount.
+            attr_reader :amount
+            # The fee currency.
+            attr_reader :currency
+            # The fee type.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The crypto amount for the failed transaction.
+          attr_reader :amount
+          # The upcharged MCC amount, if one was applied.
+          attr_reader :amount_mcc_upcharged
+          # The blockchain network for the failed transaction.
+          attr_reader :chain
+          # The currency of the crypto transaction amount.
+          attr_reader :currency
+          # When the transaction failed.
+          attr_reader :failed_at
+          # The reason the transaction failed.
+          attr_reader :failure_reason
+          # Fees associated with the transaction.
+          attr_reader :fees
+          # The source wallet address for the attempted transaction.
+          attr_reader :from_address
+          # Memo metadata attached to the transaction, if present.
+          attr_reader :memo
+          # The destination wallet address for the attempted transaction when one exists.
+          attr_reader :to_address
+          # The blockchain transaction hash when one exists.
+          attr_reader :transaction_hash
+
+          def self.inner_class_types
+            @inner_class_types = { fees: Fee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The confirmed crypto transaction details when `type` is `crypto_transaction_confirmed`; otherwise null.
+        attr_reader :crypto_transaction_confirmed
+        # The failed crypto transaction details when `type` is `crypto_transaction_failed`; otherwise null.
+        attr_reader :crypto_transaction_failed
+        # The crypto transaction variant for this array entry.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            crypto_transaction_confirmed: CryptoTransactionConfirmed,
+            crypto_transaction_failed: CryptoTransactionFailed,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class MerchantData < ::Stripe::StripeObject
         # A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.
         attr_reader :category
@@ -45,10 +160,14 @@ module Stripe
         attr_reader :name
         # Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
         attr_reader :network_id
+        # The identifier of the payment facilitator (PayFac) that processed this authorization, as assigned by the card network. Null when the transaction was not processed through a PayFac.
+        attr_reader :payment_facilitator_id
         # Postal code where the seller is located
         attr_reader :postal_code
         # State where the seller is located
         attr_reader :state
+        # The identifier of the sub-merchant involved in this authorization, as assigned by the payment facilitator. Null when the transaction was not processed through a PayFac or when no sub-merchant ID was provided.
+        attr_reader :sub_merchant_id
         # The seller's tax identification number. Currently populated for French merchants only.
         attr_reader :tax_id
         # An ID assigned by the seller to the location of the sale.
@@ -66,6 +185,8 @@ module Stripe
       end
 
       class NetworkData < ::Stripe::StripeObject
+        # The network-provided acquirer reference number for this transaction, if available. Use this value for downstream operational workflows such as filing disputes with the card network.
+        attr_reader :acquirer_reference_number
         # A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
         attr_reader :authorization_code
         # The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
@@ -390,6 +511,19 @@ module Stripe
         end
       end
 
+      class Redaction < ::Stripe::StripeObject
+        # Indicates whether this object and its related objects have been redacted or not.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Treasury < ::Stripe::StripeObject
         # The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
         attr_reader :received_credit
@@ -418,6 +552,8 @@ module Stripe
       attr_reader :cardholder
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
+      # Array of onchain crypto transactions linked to this resource.
+      attr_reader :crypto_transactions
       # 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
       # If you've disputed the transaction, the ID of the dispute.
@@ -428,6 +564,8 @@ module Stripe
       attr_reader :livemode
       # The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.
       attr_reader :merchant_amount
+      # The exchange rate used by the network to convert the `merchant_amount` to `amount`. The `merchant_amount` multiplied with this rate will equal to the `amount`.
+      attr_reader :merchant_amount_exchange_rate
       # The currency with which the merchant is taking payment.
       attr_reader :merchant_currency
       # Attribute for field merchant_data
@@ -440,6 +578,10 @@ module Stripe
       attr_reader :object
       # Additional purchase information that is optionally provided by the merchant.
       attr_reader :purchase_details
+      # Redaction status of this transaction. If the transaction is not redacted, this field will be null.
+      attr_reader :redaction
+      # The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
+      attr_reader :settlement
       # [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
       attr_reader :token
       # [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
@@ -523,9 +665,11 @@ module Stripe
       def self.inner_class_types
         @inner_class_types = {
           amount_details: AmountDetails,
+          crypto_transactions: CryptoTransaction,
           merchant_data: MerchantData,
           network_data: NetworkData,
           purchase_details: PurchaseDetails,
+          redaction: Redaction,
           treasury: Treasury,
         }
       end

data/lib/stripe/resources/line_item.rb

@@ -44,6 +44,38 @@ module Stripe
       end
     end
 
+    class Display < ::Stripe::StripeObject
+      # Attribute for field description
+      attr_reader :description
+      # Attribute for field images
+      attr_reader :images
+      # Attribute for field name
+      attr_reader :name
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class TaxCalculationReference < ::Stripe::StripeObject
+      # The calculation identifier for tax calculation response.
+      attr_reader :calculation_id
+      # The calculation identifier for tax calculation response line item.
+      attr_reader :calculation_item_id
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Tax < ::Stripe::StripeObject
       # Amount of tax applied for this rate.
       attr_reader :amount
@@ -80,6 +112,8 @@ module Stripe
     attr_reader :description
     # The discounts applied to the line item.
     attr_reader :discounts
+    # Attribute for field display
+    attr_reader :display
     # Unique identifier for the object.
     attr_reader :id
     # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
@@ -88,8 +122,14 @@ module Stripe
     attr_reader :object
     # The price used to generate the line item.
     attr_reader :price
+    # The ID of the product for this line item.
+    #
+    # This will always be the same as `price.product`.
+    attr_reader :product
     # The quantity of products being purchased.
     attr_reader :quantity
+    # The tax calculation identifiers of the line item.
+    attr_reader :tax_calculation_reference
     # The taxes applied to the line item.
     attr_reader :taxes
 
@@ -97,6 +137,8 @@ module Stripe
       @inner_class_types = {
         adjustable_quantity: AdjustableQuantity,
         discounts: Discount,
+        display: Display,
+        tax_calculation_reference: TaxCalculationReference,
         taxes: Tax,
       }
     end

data/lib/stripe/resources/mandate.rb

@@ -4,6 +4,8 @@
 module Stripe
   # A Mandate is a record of the permission that your customer gives you to debit their payment method.
   class Mandate < APIResource
+    extend Stripe::APIOperations::List
+
     OBJECT_NAME = "mandate"
     def self.object_name
       "mandate"
@@ -133,6 +135,21 @@ module Stripe
         end
       end
 
+      class Blik < ::Stripe::StripeObject
+        # Date at which the mandate expires.
+        attr_reader :expires_after
+        # Type of the mandate.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Card < ::Stripe::StripeObject
         def self.inner_class_types
           @inner_class_types = {}
@@ -216,8 +233,13 @@ module Stripe
       class Paypal < ::Stripe::StripeObject
         # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
         attr_reader :billing_agreement_id
+        # Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+        attr_reader :fingerprint
         # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
         attr_reader :payer_id
+        # 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
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -350,6 +372,8 @@ module Stripe
       attr_reader :au_becs_debit
       # Attribute for field bacs_debit
       attr_reader :bacs_debit
+      # Attribute for field blik
+      attr_reader :blik
       # Attribute for field card
       attr_reader :card
       # Attribute for field cashapp
@@ -391,6 +415,7 @@ module Stripe
           amazon_pay: AmazonPay,
           au_becs_debit: AuBecsDebit,
           bacs_debit: BacsDebit,
+          blik: Blik,
           card: Card,
           cashapp: Cashapp,
           kakao_pay: KakaoPay,
@@ -452,6 +477,11 @@ module Stripe
     # The type of the mandate.
     attr_reader :type
 
+    # Retrieves a list of Mandates for a given PaymentMethod.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/mandates", params: params, opts: opts)
+    end
+
     def self.inner_class_types
       @inner_class_types = {
         customer_acceptance: CustomerAcceptance,