checkout_sdk 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7aae1c3707fc4f1c0b73f5ca4cecceb1eaa052d54eabf28957746c8510871b
-  data.tar.gz: d5fe7d069ed73f21ce0735c812628264bb6c4032f4665bef2caadb62f1dc64f0
+  metadata.gz: 7c26660018aea61f28d8d1e742c57948b6ebadadb0440e245ca45eb14d53eede
+  data.tar.gz: 3192d546b4240013ac01de9de0411f6654a974e465e285529f36d3df666f345c
 SHA512:
-  metadata.gz: 9090c0826b9a456ca253ff600da4074d43ef57ce214d864c7d85f74ba040f30d1542705fd6834d0dde2264f12bb66415762af749379529cf0256cd41daf5ab66
-  data.tar.gz: 654a11201af0922d2949831c9d4db6436c7badd6b858e5776dc54a109abf169872960f72fa82579c663a39e22891a0d9df09a94e614e26a95b48d0612c47769c
+  metadata.gz: 1791fa5f04fe3a5628e4804312fc778ff407398f657e47c1b51e85844251e4e28f81d88593a994b0318212fc016eb42f392f6de2612dc856aad55430783e7558
+  data.tar.gz: cf4e630a4fd64a029bae0238c0e32bbdb0ab1a4576324fe31a7d09e74bfd54842440baf2725837527118d78d0b2a36b100f2051701c5fa50926c31bae4250c88

data/lib/checkout_sdk/accounts/accounts.rb

@@ -22,6 +22,7 @@ require 'checkout_sdk/accounts/profile'
 require 'checkout_sdk/accounts/accounts_client'
 require 'checkout_sdk/accounts/entity_financial_documents'
 require 'checkout_sdk/accounts/document_type'
+require 'checkout_sdk/accounts/instrument_document_type'
 require 'checkout_sdk/accounts/company'
 require 'checkout_sdk/accounts/phone'
 require 'checkout_sdk/accounts/contact_details'

data/lib/checkout_sdk/accounts/instrument_document_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The document type accepted by the legal document that verifies a bank account when
+    # creating a payment instrument.
+    #
+    # Deliberately separate from DocumentType, which lists identity documents (passport,
+    # national identity card, driving license). The API keeps the bank account document type
+    # as its own enum whose only accepted value is bank_statement, so offering it alongside
+    # the identity documents would suggest it is valid where the API rejects it, and vice
+    # versa.
+    module InstrumentDocumentType
+      BANK_STATEMENT = 'bank_statement'
+    end
+  end
+end

data/lib/checkout_sdk/payments/processing_data.rb

@@ -5,12 +5,94 @@ module CheckoutSdk
     # Response-side `processing` object returned alongside payment responses.
     # Distinct from {ProcessingSettings} which is the request-side equivalent.
     #
-    # Mirrors the swagger ProcessingData schema:
-    #   preferred_scheme, app_id, partner_*, tax_amount, locale, retrieval_reference_number,
-    #   cko_network_token_available (SDK-only), aft, merchant_category_code, scheme_merchant_id,
-    #   pan_type_processed, fallback_source_used, failure_code, partner_code, partner_response_code,
-    #   scheme, partner_fraud_status, partner_merchant_advice_code, accommodation_data, airline_data,
-    #   custom_payment_method_ids
+    # Mirrors the swagger ProcessingData schema, referenced by PaymentDetails.processing
+    # (GET /payments/{id}).
+    #
+    # @!attribute preferred_scheme
+    #   @return [String] [Optional] The preferred scheme for co-badged card payment processing.
+    #     If performing 3DS via a third party, this is the scheme that processed 3DS. Does not
+    #     support PINless debit schemes in the US (STAR, PULSE, NYCE, ACCEL, SHAZAM).
+    #     Enum: "mastercard" "visa" "cartes_bancaires"
+    # @!attribute app_id
+    #   @return [String] [Optional] The customer's application identifier.
+    # @!attribute partner_customer_id
+    #   @return [String] [Optional] The customer's ID on the partner platform.
+    # @!attribute partner_payment_id
+    #   @return [String] [Optional] The partner-originated unique payment identifier.
+    # @!attribute tax_amount
+    #   @return [Numeric] [Optional] Total tax amount of the order.
+    # @!attribute locale
+    #   @return [String] [Optional] The language and region of the customer. ISO 639-2 language
+    #     code, its value consists of language-country. Pattern:
+    #     ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$ - min 2 characters, max 10 characters
+    # @!attribute retrieval_reference_number
+    #   @return [String] [Optional] A unique identifier for the authorization provided by partner.
+    # @!attribute partner_order_id
+    #   @return [String] [Optional] The Klarna order ID associated with the payment.
+    # @!attribute partner_status
+    #   @return [String] [Optional] Status of a payment provided by partner.
+    # @!attribute partner_transaction_id
+    #   @return [String] [Optional] Unique transaction identification provided by partner.
+    # @!attribute partner_error_codes
+    #   @return [Array<String>] [Optional] The list of error codes that led the payment to fail or
+    #     be declined, as given by the payment provider.
+    # @!attribute partner_error_message
+    #   @return [String] [Optional] Error description provided by partner.
+    # @!attribute partner_authorization_code
+    #   @return [String] [Optional] Authorization code provided by partner.
+    # @!attribute partner_authorization_response_code
+    #   @return [String] [Optional] Authorization response code provided by partner.
+    # @!attribute partner_fraud_status
+    #   @return [String] [Optional] Partner fraud status. If the status is Pending, and the
+    #     merchant captures before it changes to Accepted, the risk of the transaction is solely
+    #     on the merchant.
+    # @!attribute partner_merchant_advice_code
+    #   @return [String] [Optional] The Mastercard Merchant Advice Code (MAC), which contains
+    #     additional information about the transaction. For declined transactions it also
+    #     indicates whether the payment can be retried and how long to wait.
+    # @!attribute custom_payment_method_ids
+    #   @return [Array<String>] [Optional] An array defining which of the configured payment
+    #     options within a payment category (for example, pay_later or pay_over_time) should be
+    #     displayed for this purchase.
+    # @!attribute aft
+    #   @return [Boolean] [Optional] Indicates whether the payment is an Account Funding
+    #     Transaction.
+    # @!attribute merchant_category_code
+    #   @return [String] [Optional] Four-digit code for retail financial services expressed in
+    #     ISO 18245 format, classifying the types of goods or services you provide.
+    # @!attribute scheme_merchant_id
+    #   @return [String] [Optional] The merchant identifier that was configured with the scheme
+    #     and used for the payment.
+    # @!attribute pan_type_processed
+    #   @return [String] [Optional] The type of Primary Account Number (PAN) used for the payment.
+    #     DPAN indicates a network token was used, FPAN indicates the full card was used.
+    #     Enum: "fpan" "dpan"
+    # @!attribute fallback_source_used
+    #   @return [Boolean] [Optional] Indicates whether the fallback_source field was used for
+    #     the payment.
+    # @!attribute failure_code
+    #   @return [String] [Optional] A high-level failure category returned by the payment provider
+    #     when a payment is declined or fails. Not all payment methods return this field.
+    # @!attribute partner_code
+    #   @return [String] [Optional] The 6-digit partner code returned by the payment provider.
+    #     Returned when source.type is blik. Pattern: ^\d{6}$ - 6 characters
+    # @!attribute partner_response_code
+    #   @return [String] [Optional] The raw response code returned by the payment provider when a
+    #     payment is declined or fails. Not all payment methods return this field.
+    # @!attribute scheme
+    #   @return [String] [Optional] The scheme on which the payment was authorized. This may
+    #     differ from the card's scheme used for the payment if the card is co-badged and the
+    #     payment was authorized on a different network. Read-only.
+    # @!attribute accommodation_data
+    #   @return [Array<AccommodationData>] [Optional] Contains information about the accommodation
+    #     booked by the customer.
+    # @!attribute airline_data
+    #   @return [Array<AirlineData>] [Optional] Contains information about the airline ticket and
+    #     flights booked by the customer.
+    # @!attribute scheme_transaction_link_id
+    #   @return [String] [Optional] The scheme transaction link identifier. Returned for
+    #     Mastercard transactions when the scheme provides a link identifier that ties together
+    #     related transactions on the network.
     class ProcessingData
       attr_accessor :preferred_scheme,
                     :app_id,
@@ -39,7 +121,8 @@ module CheckoutSdk
                     :partner_response_code,
                     :scheme,
                     :accommodation_data,
-                    :airline_data
+                    :airline_data,
+                    :scheme_transaction_link_id
     end
   end
 end

data/lib/checkout_sdk/sessions/category.rb

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Sessions
     module Category
       PAYMENT = 'payment'
-      NON_PAYMENT = 'nonPayment'
+      NON_PAYMENT = 'non_payment'
     end
   end
 end

data/lib/checkout_sdk/sessions/channel/browser_session.rb

@@ -26,6 +26,11 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute ip_address
     #   @return [String]
+    # @!attribute iframe_payment_allowed
+    #   @return [TrueClass, FalseClass] Whether the Payment API is enabled for all parent frames.
+    #     Required for Google SPA support in hosted sessions.
+    # @!attribute user_agent_client_hint
+    #   @return [String] The raw Sec-CH-UA header value. This can improve Google SPA support.
     class BrowserSession < ChannelData
       attr_accessor :three_ds_method_completion,
                     :accept_header,
@@ -37,7 +42,9 @@ module CheckoutSdk
                     :screen_width,
                     :timezone,
                     :user_agent,
-                    :ip_address
+                    :ip_address,
+                    :iframe_payment_allowed,
+                    :user_agent_client_hint
 
       def initialize(three_ds_method_completion: CheckoutSdk::Sessions::ThreeDsMethodCompletion::U)
         super(ChannelDataType::BROWSER)

data/lib/checkout_sdk/sessions/channel/three_ds_method_completion.rb

@@ -3,9 +3,9 @@
 module CheckoutSdk
   module Sessions
     module ThreeDsMethodCompletion
-      Y = 'y'
-      N = 'n'
-      U = 'u'
+      Y = 'Y'
+      N = 'N'
+      U = 'U'
     end
   end
 end

data/lib/checkout_sdk/sessions/experience.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # The authentication experience chosen for a session.
+    #
+    # Used by {SessionRequest#preferred_experiences}, which takes an array of these values.
+    #
+    # [Optional]
+    module Experience
+      # 3D Secure authentication. The constant is named THREE_DS because a Ruby constant cannot
+      # begin with a digit; the wire value is '3ds'.
+      THREE_DS = '3ds'
+      # Google Secure Payment Authentication.
+      GOOGLE_SPA = 'google_spa'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/google_spa.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # This object contains the Google SPA properties (non-hosted only).
+    #
+    # @!attribute continue_url
+    #   @return [String] Fully qualified URL for redirecting the user's browser session after
+    #     authentication. For example, this field may be the merchant's website for purchase
+    #     confirmation once payment is complete. Required if in full redirect (not iframe) mode.
+    class GoogleSpa
+      attr_accessor :continue_url
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_challenge_indicator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # Indicates whether a challenge is requested for this session.
+    #
+    # Used by {SessionRequest#challenge_indicator} for POST /sessions. This is the only field in the
+    # API that accepts the exemption values below; the 3ds.challenge_indicator field on payments,
+    # hosted payments, payment links and payment sessions accepts only the first four values and is
+    # modelled by {CheckoutSdk::Common::ChallengeIndicator}.
+    #
+    # The following are requests for exemption: {LOW_VALUE}, {TRUSTED_LISTING},
+    # {TRUSTED_LISTING_PROMPT} and {TRANSACTION_RISK_ASSESSMENT}. If an exemption cannot be applied,
+    # then the value {NO_CHALLENGE_REQUESTED} will be used instead.
+    #
+    # [Optional]
+    # Default: {NO_PREFERENCE}
+    # max 50 characters
+    module SessionChallengeIndicator
+      NO_PREFERENCE = 'no_preference'
+      NO_CHALLENGE_REQUESTED = 'no_challenge_requested'
+      CHALLENGE_REQUESTED = 'challenge_requested'
+      CHALLENGE_REQUESTED_MANDATE = 'challenge_requested_mandate'
+      LOW_VALUE = 'low_value'
+      TRUSTED_LISTING = 'trusted_listing'
+      TRUSTED_LISTING_PROMPT = 'trusted_listing_prompt'
+      TRANSACTION_RISK_ASSESSMENT = 'transaction_risk_assessment'
+      DATA_SHARE = 'data_share'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_request.rb

@@ -3,7 +3,7 @@
 require 'checkout_sdk/sessions/authentication_type'
 require 'checkout_sdk/sessions/category'
 require 'checkout_sdk/sessions/transaction_type'
-require 'checkout_sdk/common/challenge_indicator'
+require 'checkout_sdk/sessions/session_challenge_indicator'
 
 module CheckoutSdk
   module Sessions
@@ -24,15 +24,13 @@ module CheckoutSdk
     # @!attribute account_info
     #   @return [CardHolderAccountInfo]
     # @!attribute challenge_indicator
-    #   @return [String] {CheckoutSdk::Common::ChallengeIndicator}
+    #   @return [String] {SessionChallengeIndicator}
     # @!attribute billing_descriptor
     #   @return [SessionsBillingDescriptor]
     # @!attribute reference
     #   @return [String]
     # @!attribute merchant_risk_info
     #   @return [MerchantRiskInfo]
-    # @!attribute prior_transaction_reference
-    #   @return [String]
     # @!attribute transaction_type
     #   @return [String] {TransactionType}
     # @!attribute shipping_address
@@ -51,6 +49,12 @@ module CheckoutSdk
     #   @return [Optimization]
     # @!attribute initial_transaction
     #   @return [InitialTransaction]
+    # @!attribute device_information
+    #   @return [DeviceInformation]
+    # @!attribute google_spa
+    #   @return [GoogleSpa] Google SPA properties (non-hosted only).
+    # @!attribute preferred_experiences
+    #   @return [Array<String>] The chosen experience(s) for this session. {Experience}
     class SessionRequest
       attr_accessor :source,
                     :amount,
@@ -64,7 +68,6 @@ module CheckoutSdk
                     :billing_descriptor,
                     :reference,
                     :merchant_risk_info,
-                    :prior_transaction_reference,
                     :transaction_type,
                     :shipping_address,
                     :shipping_address_matches_billing,
@@ -74,12 +77,14 @@ module CheckoutSdk
                     :installment,
                     :optimization,
                     :initial_transaction,
-                    :device_information
+                    :device_information,
+                    :google_spa,
+                    :preferred_experiences
 
       def initialize(source: CardSource.new,
                      authentication_type: CheckoutSdk::Sessions::AuthenticationType::REGULAR,
                      authentication_category: CheckoutSdk::Sessions::Category::PAYMENT,
-                     challenge_indicator: CheckoutSdk::Common::ChallengeIndicator::NO_PREFERENCE,
+                     challenge_indicator: CheckoutSdk::Sessions::SessionChallengeIndicator::NO_PREFERENCE,
                      transaction_type: CheckoutSdk::Sessions::TransactionType::GOODS_SERVICE)
         @source = source
         @authentication_type = authentication_type

data/lib/checkout_sdk/sessions/sessions.rb

@@ -6,10 +6,13 @@ require 'checkout_sdk/sessions/card_holder_account_info'
 require 'checkout_sdk/sessions/category'
 require 'checkout_sdk/sessions/delivery_timeframe'
 require 'checkout_sdk/sessions/device_information'
+require 'checkout_sdk/sessions/experience'
+require 'checkout_sdk/sessions/google_spa'
 require 'checkout_sdk/sessions/installment'
 require 'checkout_sdk/sessions/merchant_risk_info'
 require 'checkout_sdk/sessions/recurring'
 require 'checkout_sdk/sessions/session_address'
+require 'checkout_sdk/sessions/session_challenge_indicator'
 require 'checkout_sdk/sessions/session_marketplace_data'
 require 'checkout_sdk/sessions/session_request'
 require 'checkout_sdk/sessions/session_source_type'

data/lib/checkout_sdk/sessions/shipping_indicator.rb

@@ -2,8 +2,20 @@
 
 module CheckoutSdk
   module Sessions
+    # Indicates the shipping method chosen for the transaction.
+    #
+    # Used by {MerchantRiskInfo#shipping_indicator}. Choose the option that accurately describes the
+    # cardholder's specific transaction.
+    #
+    # [Optional]
     module ShippingIndicator
-      VISA = 'visa'
+      BILLING_ADDRESS = 'billing_address'
+      ANOTHER_ADDRESS_ON_FILE = 'another_address_on_file'
+      NOT_ON_FILE = 'not_on_file'
+      STORE_PICK_UP = 'store_pick_up'
+      DIGITAL_GOODS = 'digital_goods'
+      TRAVEL_AND_EVENT_NO_SHIPPING = 'travel_and_event_no_shipping'
+      OTHER = 'other'
     end
   end
 end

data/lib/checkout_sdk/sessions/source/card_source.rb

@@ -12,15 +12,12 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute stored
     #   @return [TrueClass, FalseClass]
-    # @!attribute store_for_future_use
-    #   @return [TrueClass, FalseClass]
     class CardSource < SessionSource
       attr_accessor :number,
                     :expiry_month,
                     :expiry_year,
                     :name,
-                    :stored,
-                    :store_for_future_use
+                    :stored
 
       def initialize(stored: false)
         super(SessionSourceType::CARD)

data/lib/checkout_sdk/sessions/source/session_scheme.rb

@@ -9,6 +9,8 @@ module CheckoutSdk
       AMEX = 'amex'
       DINERS = 'diners'
       CARTES_BANCAIRES = 'cartes_bancaires'
+      DISCOVER = 'discover'
+      UPI = 'upi'
     end
   end
 end

data/lib/checkout_sdk/sessions/transaction_type.rb

@@ -7,7 +7,7 @@ module CheckoutSdk
       CHECK_ACCEPTANCE = 'check_acceptance'
       GOODS_SERVICE = 'goods_service'
       PREPAID_ACTIVATION_AND_LOAD = 'prepaid_activation_and_load'
-      QUASHI_CARD_TRANSACTION = 'quashi_card_transaction'
+      QUASI_CARD_TRANSACTION = 'quasi_card_transaction'
     end
   end
 end

data/lib/checkout_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CheckoutSdk
-  VERSION = '1.10.0'
+  VERSION = '1.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-31 00:00:00.000000000 Z
+date: 2026-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -188,6 +188,7 @@ files:
 - lib/checkout_sdk/accounts/instrument_details_faster_payments.rb
 - lib/checkout_sdk/accounts/instrument_details_sepa.rb
 - lib/checkout_sdk/accounts/instrument_document.rb
+- lib/checkout_sdk/accounts/instrument_document_type.rb
 - lib/checkout_sdk/accounts/invitee.rb
 - lib/checkout_sdk/accounts/national_id_type.rb
 - lib/checkout_sdk/accounts/onboard_entity.rb
@@ -635,6 +636,8 @@ files:
 - lib/checkout_sdk/sessions/completion/non_hosted_completion_info.rb
 - lib/checkout_sdk/sessions/delivery_timeframe.rb
 - lib/checkout_sdk/sessions/device_information.rb
+- lib/checkout_sdk/sessions/experience.rb
+- lib/checkout_sdk/sessions/google_spa.rb
 - lib/checkout_sdk/sessions/initial_transaction.rb
 - lib/checkout_sdk/sessions/installment.rb
 - lib/checkout_sdk/sessions/merchant_risk_info.rb
@@ -644,6 +647,7 @@ files:
 - lib/checkout_sdk/sessions/recurring.rb
 - lib/checkout_sdk/sessions/reorder_items_indicator_type.rb
 - lib/checkout_sdk/sessions/session_address.rb
+- lib/checkout_sdk/sessions/session_challenge_indicator.rb
 - lib/checkout_sdk/sessions/session_marketplace_data.rb
 - lib/checkout_sdk/sessions/session_request.rb
 - lib/checkout_sdk/sessions/session_secret_credentials.rb