checkout_sdk 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643ab11801801b6384afcf53088f20e10fd700aea656dd166f1355fd1f5d445e
-  data.tar.gz: ebf1ad17a6f86067c740e66896ea79b49ff2a4433e690e4134f39b89d475bc5a
+  metadata.gz: 5cd5982ca215c9826f2e674ae220b9e8e543df849aa3a53f52bb6776d10640d7
+  data.tar.gz: db69647504e345b28e6b59984c7003f5af518857e5c1d5e272f286ef412f9640
 SHA512:
-  metadata.gz: a2aec6348780a7fe62a67ff99cfe125a60b17285b4f4704ecdb32f950a218e7b2464124a54e1a485dcd4271ed3f253f7721ba663d638c8c6eb4eec2232201e48
-  data.tar.gz: 6107aa6f953cfad64ad7a4c99a05530ee989b27843ebfcf27c4c0c5ce108b96aad2c4b105251a3d74ca68871c87655f373912be6a173da4199c1c03f0ddf9de5
+  metadata.gz: 37f9058e2c2201e2718792e701c23cc691f41219fbbd3b483475399d2de69c0ab26ba3c07f218ba5ea656da4ef37976f962c77e4d60d142c8c9c98c55b51da44
+  data.tar.gz: 4449ec19ac66472ce3a4f1d01eae9deb4f4535b2ed7c9c8060c26219245183d8beb8361ab8b7316f7d21041ac7d7af885581daf520b1dabd8aeab743c150c750

data/lib/checkout_sdk/payments/payments.rb

@@ -233,6 +233,12 @@ require 'checkout_sdk/payments/setups/blik_payment_method'
 require 'checkout_sdk/payments/setups/bacs_payment_method'
 require 'checkout_sdk/payments/setups/card_present_payment_method'
 require 'checkout_sdk/payments/setups/pay_by_bank_payment_method'
+require 'checkout_sdk/payments/setups/cash_app_action_type'
+require 'checkout_sdk/payments/setups/cash_app_payment_method'
+require 'checkout_sdk/payments/setups/payment_setup_device_client'
+require 'checkout_sdk/payments/setups/payment_setup_device_os'
+require 'checkout_sdk/payments/setups/payment_setup_payment_method_initialization'
+require 'checkout_sdk/payments/setups/payment_setup_payment_method_status'
 require 'checkout_sdk/payments/setups/stablecoin_payment_method'
 require 'checkout_sdk/payments/setups/payment_setups_client'
 

data/lib/checkout_sdk/payments/sessions/payment_methods_type.rb

@@ -2,19 +2,55 @@
 
 module CheckoutSdk
   module Payments
+    # The type of payment method that can be enabled or disabled for a payment session.
+    #
+    # This is a consolidated list covering every payment method the Flow API accepts for
+    # enabled_payment_methods / disabled_payment_methods. Constants marked deprecated are no
+    # longer part of the specification but are kept for backward compatibility.
     module PaymentMethodsType
+      ALIPAY_CN = 'alipay_cn'
+      ALIPAY_HK = 'alipay_hk'
+      ALMA = 'alma'
       APPLEPAY = 'applepay'
       BANCONTACT = 'bancontact'
+      BENEFIT = 'benefit'
+      BIZUM = 'bizum'
       CARD = 'card'
+      DANA = 'dana'
       EPS = 'eps'
+      # @deprecated No longer part of the specification.
       GIROPAY = 'giropay'
+      GCASH = 'gcash'
       GOOGLEPAY = 'googlepay'
       IDEAL = 'ideal'
+      KAKAOPAY = 'kakaopay'
+      KLARNA = 'klarna'
       KNET = 'knet'
+      MBWAY = 'mbway'
+      MOBILEPAY = 'mobilepay'
       MULTIBANCO = 'multibanco'
+      OCTOPUS = 'octopus'
       PRZELEWY24 = 'p24'
+      PAYNOW = 'paynow'
       PAYPAL = 'paypal'
+      PLAID = 'plaid'
+      QPAY = 'qpay'
+      # Fully supported by the API but deliberately unlisted in the public specification, so
+      # that merchants do not disable Remember Me en masse. Do not remove it as an unspecified
+      # value.
+      REMEMBER_ME = 'remember_me'
+      SEPA = 'sepa'
+      # @deprecated No longer part of the specification.
       SOFORT = 'sofort'
+      STCPAY = 'stcpay'
+      STORED_CARD = 'stored_card'
+      TABBY = 'tabby'
+      TAMARA = 'tamara'
+      TNG = 'tng'
+      TRUEMONEY = 'truemoney'
+      TWINT = 'twint'
+      VIPPS = 'vipps'
+      WECHATPAY = 'wechatpay'
     end
   end
 end

data/lib/checkout_sdk/payments/setups/cash_app_action_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The type of the next available action for the Cash App Pay payment method on a
+    # Payment Setup. Maps swagger `CashApp.action.type`.
+    module CashAppActionType
+      REDIRECT = 'redirect'
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/cash_app_payment_method.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The Cash App payment method's details and configuration on a Payment Setup.
+    # Maps swagger `CashApp`. Sent under the `payment_methods.cashapp` key (one lowercase word,
+    # not `cash_app`).
+    #
+    # The Payment Setup request is a Hash, and a Hash request is sent as is, so do not nest an
+    # instance of this class in it directly: it would not be serialized. Pass a Hash with these keys,
+    # or convert an instance first:
+    #   cash_app = CheckoutSdk::Payments::CashAppPaymentMethod.new
+    #   cash_app.initialization = 'enabled'
+    #   cash_app.customer_profile_sharing = true
+    #   request[:payment_methods] = { cashapp: CheckoutSdk::JsonSerializer.to_custom_hash(cash_app) }
+    # Responses are read with dot access, for example response.payment_methods.cashapp.action.redirect_url.
+    class CashAppPaymentMethod
+      # The payment method status.
+      # [Optional]
+      # Read only.
+      # Enum: "unavailable" "action_required" "ready" "initialization_required" "invalid"
+      # @return [String] One of {PaymentSetupPaymentMethodStatus}.
+      attr_accessor :status
+
+      # The list of error codes or indicators that highlight missing or invalid information.
+      # [Optional]
+      # Read only.
+      # @return [Array(String)]
+      attr_accessor :flags
+
+      # The initialization state of the payment method.
+      # When you create a Payment Setup, this defaults to `disabled`.
+      # [Optional]
+      # Default: "disabled"
+      # Enum: "disabled" "enabled"
+      # @return [String] One of {PaymentSetupPaymentMethodInitialization}.
+      attr_accessor :initialization
+
+      # Indicates whether the customer consents to share their Cash App customer profile with Checkout.com.
+      # [Optional]
+      # @return [TrueClass, FalseClass]
+      attr_accessor :customer_profile_sharing
+
+      # The customer's Cash App profile that they consented to share. Included in the response when
+      # `customer_profile_sharing` is enabled.
+      # Cash App releases this profile only once. It's present in the first successful response when you
+      # get the Payment Setup after the customer authorizes the payment. Every subsequent response omits it.
+      # [Optional]
+      # Read only.
+      # Keys (all strings, all optional):
+      # - `customer_id`: Cash App's identifier for the customer. This is not a Checkout.com customer identifier.
+      # - `cashtag`: The customer's $Cashtag.
+      # - `reference_id`: Cash App's reference for the customer profile.
+      # - `full_name`: The customer's full name.
+      # - `given_name`: The customer's given name.
+      # - `middle_name`: The customer's middle name.
+      # - `family_name`: The customer's family name.
+      # - `suffix`: The suffix of the customer's name.
+      # - `birth_date`: The customer's date of birth. Format: date (the API example carries a time part,
+      #   so the value is kept as a string).
+      # - `address` (Hash): The customer's address, with Cash App's own key names (not the Checkout.com
+      #   common address): `address_line_1` (the first line of the address), `address_line_2` (the second
+      #   line of the address), `address_line_3` (the third line of the address), `locality` (the address
+      #   locality, such as the city or town), `sublocality` (the address sublocality, such as the district
+      #   or neighborhood), `administrative_district_level_1` (the address's top-level administrative
+      #   district, such as the state or province), `postal_code` (the postal or zip code) and `country`
+      #   (the address country, in ISO 3166-1 alpha-2 format, max 2 characters).
+      # - `phone_number`: The customer's phone number.
+      # - `email_address`: The customer's email address.
+      # - `customer_since`: The date and time the customer's Cash App account was created.
+      #   Format: date-time (kept as a string).
+      # @return [Hash]
+      attr_accessor :customer_profile
+
+      # A reference for the Cash App Pay transaction, returned by the provider.
+      # [Optional]
+      # Read only.
+      # max 80 characters
+      # @return [String]
+      attr_accessor :reference
+
+      # The next available action for the payment method.
+      # [Optional]
+      # Read only.
+      # Keys:
+      # - `type` (String): The type of action. One of {CashAppActionType}.
+      # - `redirect_url` (String): The URL to redirect the customer to so they can authorize the payment
+      #   with Cash App. Format: uri
+      # @return [Hash]
+      attr_accessor :action
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/payment_setup_device_client.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The type of client the customer uses to initiate the payment.
+    # Maps swagger `PaymentSetup.customer.device.client`.
+    module PaymentSetupDeviceClient
+      WEB = 'web'
+      MOBILE_WEB = 'mobile_web'
+      APP = 'app'
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/payment_setup_device_os.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The operating system of the customer's device.
+    # Maps swagger `PaymentSetup.customer.device.os`.
+    module PaymentSetupDeviceOs
+      ANDROID = 'android'
+      IOS = 'ios'
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/payment_setup_payment_method_initialization.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The initialization state of a payment method on a Payment Setup.
+    # Maps swagger `PaymentMethodInitialization.initialization`.
+    module PaymentSetupPaymentMethodInitialization
+      DISABLED = 'disabled'
+      ENABLED = 'enabled'
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/payment_setup_payment_method_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The payment method status on a Payment Setup.
+    # Maps swagger `PaymentMethodStatus`.
+    module PaymentSetupPaymentMethodStatus
+      UNAVAILABLE = 'unavailable'
+      ACTION_REQUIRED = 'action_required'
+      READY = 'ready'
+      INITIALIZATION_REQUIRED = 'initialization_required'
+      INVALID = 'invalid'
+    end
+  end
+end

data/lib/checkout_sdk/payments/setups/payment_setups_client.rb

@@ -16,9 +16,9 @@ module CheckoutSdk
       end
 
       # Creates a Payment Setup.
-      # To maximize the amount of information the payment setup can use, we recommend that you create
-      # a payment setup as early as possible in the customer's journey. For example, the first time
-      # they land on the basket page.
+      # To maximize the information available to the payment setup, create a Payment Setup as early as
+      # possible in the customer's journey. For example, create it the first time they land on the
+      # basket page.
       # [Beta]
       #
       # @param [Hash] payment_setups_request
@@ -27,6 +27,38 @@ module CheckoutSdk
       #   :terminal {PaymentSetupTerminal} and
       #   :industry {PaymentSetupIndustry} (containing :accommodation
       #   {Array(PaymentSetupAccommodation)} and :airline {Array(PaymentSetupAirline)}).
+      #   A Hash request is sent as is, so every nested value must be a Hash too. To use one of the
+      #   typed classes above (or {CashAppPaymentMethod}), convert it first with
+      #   CheckoutSdk::JsonSerializer.to_custom_hash(object); a typed object nested directly in the
+      #   Hash is not serialized and is sent as "#<CheckoutSdk::...>".
+      #   :payment_methods may include :cashapp (the key is the single lowercase word `cashapp`), a Hash
+      #   with the keys documented on {CashAppPaymentMethod}; you send :initialization ("disabled" or
+      #   "enabled") and :customer_profile_sharing (Boolean).
+      #   :customer may include:
+      #   - :id - The unique identifier of the customer.
+      #   - :country - The two-letter ISO country code of the customer for this payment
+      #     (min 2 characters, max 2 characters).
+      #   - :email - Details of the customer's email: :address (the customer's email address) and
+      #     :verified (Boolean, whether the customer's email address is verified).
+      #   - :name - The customer's full name (max 100 characters).
+      #   - :tax_number - The customer's tax identification number.
+      #   - :phone - The customer's phone number: :country_code (the international country calling
+      #     code, min 1 character, max 7 characters) and :number (the phone number, min 6 characters,
+      #     max 25 characters).
+      #   - :merchant_account - Details of the account the customer holds with the merchant: :id,
+      #     :registration_date, :last_modified, :first_transaction_date and :last_transaction_date
+      #     (dates, yyyy-MM-dd), :returning_customer (Boolean), :total_order_count (Integer) and
+      #     :last_payment_amount (Number).
+      #   - :device - Details of the customer's device: :locale (the locale of the device),
+      #     :fingerprint (a unique identifier for the customer's device), :ipv4 and :ipv6 (the
+      #     customer's device IPv4 or IPv6 address, used by some payment methods for risk and
+      #     eligibility checks), :client (the type of client the customer uses to initiate the
+      #     payment, one of {PaymentSetupDeviceClient}; Cash App Pay requires it, although the API
+      #     reference does not mark it as required) and :os (the operating system of the
+      #     customer's device, one of {PaymentSetupDeviceOs}).
+      # @return [Hash] The Payment Setup (swagger `PaymentSetup`, 200). For Cash App Pay, read
+      #   payment_methods.cashapp.action.redirect_url, payment_methods.cashapp.reference and, once only,
+      #   payment_methods.cashapp.customer_profile.
       def create_payment_setup(payment_setups_request)
         api_client.invoke_post(
           build_path(PAYMENTS_PATH, SETUPS_PATH),
@@ -36,9 +68,9 @@ module CheckoutSdk
       end
 
       # Updates a Payment Setup.
-      # You should update the payment setup whenever there are significant changes in the data relevant
-      # to the customer's transaction. For example, when the customer makes a change that impacts the
-      # total payment amount.
+      # Update the Payment Setup whenever there are significant changes in the data relevant to the
+      # customer's transaction. For example, when the customer makes a change that impacts the total
+      # payment amount.
       # [Beta]
       #
       # @param [String] id - The unique identifier of the Payment Setup to update
@@ -48,6 +80,38 @@ module CheckoutSdk
       #   :terminal {PaymentSetupTerminal} and
       #   :industry {PaymentSetupIndustry} (containing :accommodation
       #   {Array(PaymentSetupAccommodation)} and :airline {Array(PaymentSetupAirline)}).
+      #   A Hash request is sent as is, so every nested value must be a Hash too. To use one of the
+      #   typed classes above (or {CashAppPaymentMethod}), convert it first with
+      #   CheckoutSdk::JsonSerializer.to_custom_hash(object); a typed object nested directly in the
+      #   Hash is not serialized and is sent as "#<CheckoutSdk::...>".
+      #   :payment_methods may include :cashapp (the key is the single lowercase word `cashapp`), a Hash
+      #   with the keys documented on {CashAppPaymentMethod}; you send :initialization ("disabled" or
+      #   "enabled") and :customer_profile_sharing (Boolean).
+      #   :customer may include:
+      #   - :id - The unique identifier of the customer.
+      #   - :country - The two-letter ISO country code of the customer for this payment
+      #     (min 2 characters, max 2 characters).
+      #   - :email - Details of the customer's email: :address (the customer's email address) and
+      #     :verified (Boolean, whether the customer's email address is verified).
+      #   - :name - The customer's full name (max 100 characters).
+      #   - :tax_number - The customer's tax identification number.
+      #   - :phone - The customer's phone number: :country_code (the international country calling
+      #     code, min 1 character, max 7 characters) and :number (the phone number, min 6 characters,
+      #     max 25 characters).
+      #   - :merchant_account - Details of the account the customer holds with the merchant: :id,
+      #     :registration_date, :last_modified, :first_transaction_date and :last_transaction_date
+      #     (dates, yyyy-MM-dd), :returning_customer (Boolean), :total_order_count (Integer) and
+      #     :last_payment_amount (Number).
+      #   - :device - Details of the customer's device: :locale (the locale of the device),
+      #     :fingerprint (a unique identifier for the customer's device), :ipv4 and :ipv6 (the
+      #     customer's device IPv4 or IPv6 address, used by some payment methods for risk and
+      #     eligibility checks), :client (the type of client the customer uses to initiate the
+      #     payment, one of {PaymentSetupDeviceClient}; Cash App Pay requires it, although the API
+      #     reference does not mark it as required) and :os (the operating system of the
+      #     customer's device, one of {PaymentSetupDeviceOs}).
+      # @return [Hash] The Payment Setup (swagger `PaymentSetup`, 200). For Cash App Pay, read
+      #   payment_methods.cashapp.action.redirect_url, payment_methods.cashapp.reference and, once only,
+      #   payment_methods.cashapp.customer_profile.
       def update_payment_setup(id, payment_setups_request)
         api_client.invoke_put(
           build_path(PAYMENTS_PATH, SETUPS_PATH, id),
@@ -56,10 +120,13 @@ module CheckoutSdk
         )
       end
 
-      # Retrieves a Payment Setup.
+      # Retrieves a Payment Setup by its unique identifier.
       # [Beta]
       #
       # @param [String] id - The unique identifier of the Payment Setup to retrieve
+      # @return [Hash] The Payment Setup (swagger `PaymentSetup`, 200). For Cash App Pay, read
+      #   payment_methods.cashapp.action.redirect_url, payment_methods.cashapp.reference and, once only,
+      #   payment_methods.cashapp.customer_profile.
       def get_payment_setup(id)
         api_client.invoke_get(
           build_path(PAYMENTS_PATH, SETUPS_PATH, id),
@@ -73,7 +140,10 @@ module CheckoutSdk
       #
       # @param [String] id - The unique identifier of the Payment Setup
       # @param [String] payment_method_name - The name of the payment method to process the
-      # payment with (for example, "tabby", "klarna", "card")
+      #   payment with (for example, "tabby", "klarna", "card" or "cashapp")
+      # @return [Hash] The Payment Setup (swagger `PaymentSetup`, 200). For Cash App Pay, read
+      #   payment_methods.cashapp.action.redirect_url, payment_methods.cashapp.reference and, once only,
+      #   payment_methods.cashapp.customer_profile.
       def confirm_payment_setup(id, payment_method_name)
         api_client.invoke_post(
           build_path(PAYMENTS_PATH, SETUPS_PATH, id, CONFIRM_PATH, payment_method_name),

data/lib/checkout_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-06 00:00:00.000000000 Z
+date: 2026-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -593,6 +593,8 @@ files:
 - lib/checkout_sdk/payments/setups/bacs_payment_method.rb
 - lib/checkout_sdk/payments/setups/blik_payment_method.rb
 - lib/checkout_sdk/payments/setups/card_present_payment_method.rb
+- lib/checkout_sdk/payments/setups/cash_app_action_type.rb
+- lib/checkout_sdk/payments/setups/cash_app_payment_method.rb
 - lib/checkout_sdk/payments/setups/pay_by_bank_payment_method.rb
 - lib/checkout_sdk/payments/setups/payment_setup_accommodation.rb
 - lib/checkout_sdk/payments/setups/payment_setup_accommodation_address.rb
@@ -605,7 +607,11 @@ files:
 - lib/checkout_sdk/payments/setups/payment_setup_airline_passenger.rb
 - lib/checkout_sdk/payments/setups/payment_setup_airline_ticket.rb
 - lib/checkout_sdk/payments/setups/payment_setup_billing_descriptor.rb
+- lib/checkout_sdk/payments/setups/payment_setup_device_client.rb
+- lib/checkout_sdk/payments/setups/payment_setup_device_os.rb
 - lib/checkout_sdk/payments/setups/payment_setup_industry.rb
+- lib/checkout_sdk/payments/setups/payment_setup_payment_method_initialization.rb
+- lib/checkout_sdk/payments/setups/payment_setup_payment_method_status.rb
 - lib/checkout_sdk/payments/setups/payment_setup_presentment_details.rb
 - lib/checkout_sdk/payments/setups/payment_setup_terminal.rb
 - lib/checkout_sdk/payments/setups/payment_setups_client.rb