checkout_sdk 2.7.1 → 2.8.1

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

@@ -2,19 +2,51 @@
 
 module CheckoutSdk
   module Payments
+    # Account funding transaction sender details on a Payment Setup.
+    # Maps swagger `PaymentSetup.account_funding_transaction.sender`.
+    #
     # @!attribute first_name
+    #   The sender's first name.
+    #   [Optional]
+    #   @deprecated Not part of the Sender schema of the Payment Setups account funding transaction; the
+    #     API ignores it on requests. There is no replacement. Will be removed in the next major version.
     #   @return [String]
     # @!attribute last_name
+    #   The sender's last name.
+    #   [Optional]
+    #   @deprecated Not part of the Sender schema of the Payment Setups account funding transaction; the
+    #     API ignores it on requests. There is no replacement. Will be removed in the next major version.
     #   @return [String]
     # @!attribute date_of_birth
-    #   @return [String] Format: YYYY-MM-DD
+    #   Date of birth of the sender (yyyy-mm-dd).
+    #   [Optional]
+    #   Format: date
+    #   @return [String]
     # @!attribute country_of_birth
+    #   The sender's country of birth, as an ISO 3166-1 alpha-2 code.
+    #   [Optional]
+    #   @deprecated Not part of the Sender schema of the Payment Setups account funding transaction; the
+    #     API ignores it on requests. There is no replacement. Will be removed in the next major version.
     #   @return [String] {CheckoutSdk::Common::Country}
     # @!attribute nationality
+    #   The sender's nationality, as an ISO 3166-1 alpha-2 code.
+    #   [Optional]
+    #   @deprecated Not part of the Sender schema of the Payment Setups account funding transaction; the
+    #     API ignores it on requests. There is no replacement. Will be removed in the next major version.
     #   @return [String] {CheckoutSdk::Common::Country}
     # @!attribute address
+    #   The sender's address.
+    #   [Optional]
+    #   @deprecated Not part of the Sender schema of the Payment Setups account funding transaction; the
+    #     API ignores it on requests. There is no replacement. Will be removed in the next major version.
     #   @return [CheckoutSdk::Common::Address]
+    # @!attribute reference
+    #   The unique reference for the sender of the payment.
+    #   [Optional]
+    #   @return [String]
     # @!attribute identification
+    #   Sender identification details.
+    #   [Optional]
     #   @return [AccountFundingTransactionIdentification]
     class AccountFundingTransactionSender
       attr_accessor :first_name,
@@ -23,6 +55,7 @@ module CheckoutSdk
                     :country_of_birth,
                     :nationality,
                     :address,
+                    :reference,
                     :identification
     end
   end

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

@@ -2,41 +2,77 @@
 
 module CheckoutSdk
   module Payments
-    # Bacs payment method configuration on a Payment Setup. Maps swagger `Bacs`.
-    #
-    # @!attribute status
-    #   @return [String] (response-only) Payment method status, one of
-    #     {PaymentSetupPaymentMethodStatus} (e.g. "ready").
-    # @!attribute flags
-    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
-    # @!attribute initialization
-    #   @return [String] The initialization type for the payment method.
-    # @!attribute instrument_id
-    #   @return [String] (response-only) The ID of the Bacs instrument used for the payment.
-    # @!attribute account_holder
-    #   @return [Hash] The account holder details (`type`, `first_name`, `last_name`,
-    #     `company_name`, `email`).
-    # @!attribute account_number
-    #   @return [String] The account number of the Bacs Direct Debit account.
-    # @!attribute bank_code
-    #   @return [String] The bank code (sort code) of the Bacs Direct Debit account.
-    # @!attribute country
-    #   @return [String] {CheckoutSdk::Common::Country}
-    # @!attribute currency
-    #   @return [String] {CheckoutSdk::Common::Currency}
-    # @!attribute allow_partial_match
-    #   @return [TrueClass, FalseClass] Whether to allow a partial match of the account holder details.
+    # The Bacs payment method's details and configuration on a Payment Setup. Maps swagger `Bacs`.
+    # Sent under the `payment_methods.bacs` key.
     class BacsPaymentMethod
-      attr_accessor :status,
-                    :flags,
-                    :initialization,
-                    :instrument_id,
-                    :account_holder,
-                    :account_number,
-                    :bank_code,
-                    :country,
-                    :currency,
-                    :allow_partial_match
+      # The payment method status.
+      # [Optional]
+      # Read only.
+      # @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`.
+      # On update the API replaces the payment methods, so send `enabled` again to keep the method enabled.
+      # The specification does not state this; it is the API's behaviour.
+      # [Optional]
+      # Default: disabled
+      # @return [String] One of {PaymentSetupPaymentMethodInitialization}.
+      attr_accessor :initialization
+
+      # The ID of the Bacs instrument used for the payment.
+      # [Optional]
+      # Read only.
+      # @return [String]
+      attr_accessor :instrument_id
+
+      # The account holder details.
+      # [Optional]
+      # Keys:
+      # - `type` (String): The type of account holder. Enum: "individual" "corporate".
+      # - `first_name` (String): The first name of the account holder.
+      # - `last_name` (String): The last name of the account holder.
+      # - `company_name` (String): The legal name of a registered company that holds the account.
+      # - `email` (String): The email address of the account holder.
+      # @return [Hash]
+      attr_accessor :account_holder
+
+      # The account number of the Bacs Direct Debit account.
+      # [Optional]
+      # Write only.
+      # @return [String]
+      attr_accessor :account_number
+
+      # The sort code of the Bacs Direct Debit account.
+      # [Optional]
+      # Write only.
+      # @return [String]
+      attr_accessor :bank_code
+
+      # The account's country, as an ISO 3166-1 alpha-2 code.
+      # [Optional]
+      # min 2 characters, max 2 characters
+      # @return [String] {CheckoutSdk::Common::Country}
+      attr_accessor :country
+
+      # The account holder's account currency.
+      # [Optional]
+      # @return [String] {CheckoutSdk::Common::Currency}
+      attr_accessor :currency
+
+      # Indicates whether the Bacs instrument is created when account validation returns a partial
+      # match. When `true`, the instrument is created on a partial match; when `false`, instrument
+      # creation fails on a partial match.
+      # [Optional]
+      # Default: false
+      # @return [TrueClass, FalseClass]
+      attr_accessor :allow_partial_match
     end
   end
 end

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

@@ -18,7 +18,6 @@ module CheckoutSdk
       # The payment method status.
       # [Optional]
       # Read only.
-      # Enum: "unavailable" "action_required" "ready" "initialization_required" "invalid"
       # @return [String] One of {PaymentSetupPaymentMethodStatus}.
       attr_accessor :status
 
@@ -30,9 +29,10 @@ module CheckoutSdk
 
       # The initialization state of the payment method.
       # When you create a Payment Setup, this defaults to `disabled`.
+      # On update the API replaces the payment methods, so send `enabled` again to keep the method enabled.
+      # The specification does not state this; it is the API's behaviour.
       # [Optional]
-      # Default: "disabled"
-      # Enum: "disabled" "enabled"
+      # Default: disabled
       # @return [String] One of {PaymentSetupPaymentMethodInitialization}.
       attr_accessor :initialization
 

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The type of payment on a Payment Setup. Maps swagger `PaymentSetup.payment_type`.
+    #
+    # The Payment Setups API declares these values in lowercase, unlike {PaymentType}, which is the
+    # capitalized enum of the payments API. Use this module for the :payment_type key of a Payment
+    # Setup request. When :payment_type is not sent, the API uses "regular".
+    module PaymentSetupPaymentType
+      REGULAR = 'regular'
+      RECURRING = 'recurring'
+      MOTO = 'moto'
+      INSTALLMENT = 'installment'
+      PAY_LATER = 'pay_later'
+      UNSCHEDULED = 'unscheduled'
+    end
+  end
+end

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

@@ -32,6 +32,11 @@ module CheckoutSdk
       #   {PaymentSetupRisk}), 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_type - String, the type of payment, one of {PaymentSetupPaymentType} (lowercase,
+      #   unlike {PaymentType}): "regular", "recurring", "moto", "installment", "pay_later" or
+      #   "unscheduled". Default "regular". You must provide it for card payments in which the
+      #   cardholder is not present, for example a recurring payment or a mail order/telephone order
+      #   (MOTO) payment.
       #   :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).
@@ -128,6 +133,11 @@ module CheckoutSdk
       #   {PaymentSetupRisk}), 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_type - String, the type of payment, one of {PaymentSetupPaymentType} (lowercase,
+      #   unlike {PaymentType}): "regular", "recurring", "moto", "installment", "pay_later" or
+      #   "unscheduled". Default "regular". You must provide it for card payments in which the
+      #   cardholder is not present, for example a recurring payment or a mail order/telephone order
+      #   (MOTO) payment.
       #   :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).

data/lib/checkout_sdk/payments/source/currency_account_source.rb

@@ -2,6 +2,14 @@
 
 module CheckoutSdk
   module Payments
+    # A currency account source, with type currency_account.
+    # Used by card payouts, bank payouts and unreferenced refunds.
+    #
+    # id: the ID of the currency account that will fund the payout or the unreferenced refund. For bank
+    # payouts, its holding currency must match the payout's currency.
+    # [Required]
+    # ^(ca)_(\w{26})$
+    # 29 characters
     class CurrencyAccountSource < PayoutSource
       def initialize
         super(PayoutSourceType::CURRENCY_ACCOUNT)

data/lib/checkout_sdk/payments/source/entity_source.rb

@@ -2,6 +2,11 @@
 
 module CheckoutSdk
   module Payments
+    # An entity source, with type entity. Bank payouts only.
+    #
+    # id: the entity or sub-entity's identifier, only applies to Platform Clients.
+    # [Required]
+    # ^(ent)_(\w{26})$
     class EntitySource < PayoutSource
       def initialize
         super(PayoutSourceType::ENTITY)

data/lib/checkout_sdk/payments/source/payout_source.rb

@@ -2,12 +2,23 @@
 
 module CheckoutSdk
   module Payments
+    # The source of a card payout, bank payout or unreferenced refund.
+    #
     # @!attribute type
+    #   The payout source type. Set by each subclass.
+    #   [Required]
     #   @return [String] {PayoutSourceType}
     # @!attribute id
+    #   The identifier of the source. See {CurrencyAccountSource} and {EntitySource} for the format.
+    #   [Required]
     #   @return [String]
     # @!attribute amount
-    #   @return [String]
+    #   The amount of the source.
+    #   [Optional]
+    #   @deprecated Not in the request schema of any payout or unreferenced refund source; still returned in
+    #     PayoutDetails (source.amount). Retained for backwards compatibility and will be removed in the next
+    #     major version. There is no replacement.
+    #   @return [Integer]
     class PayoutSource
       attr_reader :type
       attr_accessor :id,

data/lib/checkout_sdk/payments/unreferenced_refund_request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # An unreferenced refund request, sent to POST /payments.
+    # The payment_type is set to UnreferencedRefund by the constructor.
+    #
+    # @!attribute source
+    #   The source of the unreferenced refund.
+    #   Only type and id are part of this position; amount is not used.
+    #   [Required]
+    #   @return [CurrencyAccountSource]
+    # @!attribute destination
+    #   The destination of the unreferenced refund.
+    #   Takes {CardDestination}, {NetworkTokenDestination}, {IdDestination} or {TokenDestination}.
+    #   [Required]
+    #   @return [Destination]
+    # @!attribute instruction
+    #   Additional details about the unreferenced refund instruction.
+    #   Only funds_transfer_type and purpose are part of this position.
+    #   [Optional]
+    #   @return [PaymentInstruction]
+    # @!attribute amount
+    #   The amount in minor currency.
+    #   [Required]
+    #   Format: int64
+    #   min 1
+    #   max 9999999999
+    #   @return [Integer]
+    # @!attribute currency
+    #   The three-letter ISO currency code of the payment.
+    #   [Required]
+    #   3 characters
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute payment_type
+    #   The type of the payment. Set to UnreferencedRefund by the constructor.
+    #   [Required]
+    #   Enum: "UnreferencedRefund"
+    #   @return [String]
+    # @!attribute processing_channel_id
+    #   The processing channel identifier.
+    #   [Required]
+    #   ^(pc)_(\w{26})$
+    #   @return [String]
+    # @!attribute reference
+    #   An internal reference you can later use to identify this payment.
+    #   [Optional]
+    #   @return [String]
+    # @!attribute metadata
+    #   A set of key-value pairs that you can attach to the refund request. It can be useful for storing
+    #   additional information in a structured format. Note: this object only allows one level of depth,
+    #   so cannot accept non-primitive data types such as objects or arrays.
+    #   [Optional]
+    #   @return [Hash{String => Object}]
+    # @!attribute previous_payment_id
+    #   The previous related payment identifier. This could be the ID of the payment that you want to refund.
+    #   [Optional]
+    #   @return [String]
+    # @!attribute segment
+    #   The dimension details about business segment for payment request. At least one dimension required.
+    #   [Optional]
+    #   @return [PaymentSegment]
+    # @!attribute processing
+    #   Returns information related to the processing of the payment.
+    #   Only processing_speed is part of this position.
+    #   [Optional]
+    #   @return [CardPayoutProcessing]
+    class UnreferencedRefundRequest
+      PAYMENT_TYPE = 'UnreferencedRefund'
+
+      attr_reader :payment_type
+      attr_accessor :source,
+                    :destination,
+                    :instruction,
+                    :amount,
+                    :currency,
+                    :processing_channel_id,
+                    :reference,
+                    :metadata,
+                    :previous_payment_id,
+                    :segment,
+                    :processing
+
+      def initialize
+        @payment_type = PAYMENT_TYPE
+      end
+    end
+  end
+end

data/lib/checkout_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.1
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-20 00:00:00.000000000 Z
+date: 2026-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -297,6 +311,7 @@ files:
 - lib/checkout_sdk/common/payment_source_type.rb
 - lib/checkout_sdk/common/phone.rb
 - lib/checkout_sdk/common/product.rb
+- lib/checkout_sdk/common/residential_status_type.rb
 - lib/checkout_sdk/common/shipping_info.rb
 - lib/checkout_sdk/common/update_customer_request.rb
 - lib/checkout_sdk/compliance_requests/compliance_request_responded_field.rb
@@ -476,6 +491,8 @@ files:
 - lib/checkout_sdk/payments/capture_request.rb
 - lib/checkout_sdk/payments/capture_type.rb
 - lib/checkout_sdk/payments/card.rb
+- lib/checkout_sdk/payments/card_payout_item.rb
+- lib/checkout_sdk/payments/card_payout_processing.rb
 - lib/checkout_sdk/payments/charge_bearer.rb
 - lib/checkout_sdk/payments/contexts/payment_contexts_client.rb
 - lib/checkout_sdk/payments/d_local_installments.rb
@@ -485,7 +502,10 @@ files:
 - lib/checkout_sdk/payments/destination/destination.rb
 - lib/checkout_sdk/payments/destination/destination_type.rb
 - lib/checkout_sdk/payments/destination/id_destination.rb
+- lib/checkout_sdk/payments/destination/network_token_destination.rb
 - lib/checkout_sdk/payments/destination/token_destination.rb
+- lib/checkout_sdk/payments/downtime_retry_request.rb
+- lib/checkout_sdk/payments/dunning_retry_request.rb
 - lib/checkout_sdk/payments/exemption.rb
 - lib/checkout_sdk/payments/flight_leg_details.rb
 - lib/checkout_sdk/payments/flow/flow_client.rb
@@ -497,6 +517,7 @@ files:
 - lib/checkout_sdk/payments/hosted/hosted_payments_client.rb
 - lib/checkout_sdk/payments/hosted/hosted_payments_session.rb
 - lib/checkout_sdk/payments/hosted/payment_purpose_type.rb
+- lib/checkout_sdk/payments/instruction_remittance.rb
 - lib/checkout_sdk/payments/instruction_scheme.rb
 - lib/checkout_sdk/payments/links/payment_link.rb
 - lib/checkout_sdk/payments/links/payments_links_client.rb
@@ -612,6 +633,7 @@ files:
 - 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_payment_type.rb
 - lib/checkout_sdk/payments/setups/payment_setup_presentment_details.rb
 - lib/checkout_sdk/payments/setups/payment_setup_risk.rb
 - lib/checkout_sdk/payments/setups/payment_setup_terminal.rb
@@ -686,6 +708,7 @@ files:
 - lib/checkout_sdk/payments/three_ds_flow_type.rb
 - lib/checkout_sdk/payments/three_ds_request.rb
 - lib/checkout_sdk/payments/ticket.rb
+- lib/checkout_sdk/payments/unreferenced_refund_request.rb
 - lib/checkout_sdk/payments/user_action.rb
 - lib/checkout_sdk/payments/void_request.rb
 - lib/checkout_sdk/platform_type.rb