checkout_sdk 2.7.0 → 2.8.0

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

@@ -2,40 +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.
-    # @!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/blik_payment_method.rb

@@ -2,10 +2,11 @@
 
 module CheckoutSdk
   module Payments
-    # Blik payment method configuration on a Payment Setup.
+    # Blik payment method configuration on a Payment Setup. Maps swagger `Blik`.
     #
     # @!attribute status
-    #   @return [String] (response-only) Payment method status (e.g. "available").
+    #   @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 partner_code

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

@@ -5,7 +5,8 @@ module CheckoutSdk
     # Card Present payment method configuration on a Payment Setup. Maps swagger `CardPresent`.
     #
     # @!attribute status
-    #   @return [String] (response-only) Payment method 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 track2

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/pay_by_bank_payment_method.rb

@@ -2,23 +2,47 @@
 
 module CheckoutSdk
   module Payments
-    # Pay by Bank (Open Banking) payment method configuration on a Payment Setup.
-    # Maps swagger `PayByBank`.
+    # The Pay by Bank (Open Banking) payment method's details and configuration on a Payment Setup.
+    # Maps swagger `PayByBank`. Sent under the `payment_methods.paybybank` key (one lowercase word,
+    # not `pay_by_bank`; the API ignores `pay_by_bank` without an error).
     #
-    # @!attribute status
-    #   @return [String] (response-only) Payment method status.
-    # @!attribute flags
-    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
-    # @!attribute bank_id
-    #   @return [String] The identifier of the bank the customer has selected for the payment.
-    # @!attribute action
-    #   @return [Hash] (response-only) The next available action for the payment method
-    #     (`type`, `banks`).
+    # 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:
+    #   pay_by_bank = CheckoutSdk::Payments::PayByBankPaymentMethod.new
+    #   pay_by_bank.bank_id = 'ob-natwest'
+    #   request[:payment_methods] = { paybybank: CheckoutSdk::JsonSerializer.to_custom_hash(pay_by_bank) }
+    # Responses are read with dot access, for example response.payment_methods.paybybank.action.banks.
     class PayByBankPaymentMethod
-      attr_accessor :status,
-                    :flags,
-                    :bank_id,
-                    :action
+      # 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 identifier of the bank the customer has selected for the payment.
+      # [Optional]
+      # @return [String]
+      attr_accessor :bank_id
+
+      # The next available action for the payment method.
+      # [Optional]
+      # Read only.
+      # Keys:
+      # - `type` (String): The type of action. Enum: "select_bank".
+      # - `banks` (Array(Hash)): The list of banks available for the customer to select. Each item has
+      #   `bank_id` (String, the unique identifier of the bank), `display_name` (String, the display
+      #   name of the bank), `logo_url` (String, the URL of the bank's logo) and `available`
+      #   (Boolean, whether the bank is currently available for selection).
+      # @return [Hash]
+      attr_accessor :action
     end
   end
 end

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_setup_risk.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Risk assessment settings for the Payment Setup.
+    # Maps the swagger `PaymentSetup.risk` object. Sent under the `risk` key.
+    #
+    # The Payment Setup request is a Hash, so pass { enabled: false } directly, or convert an
+    # instance first with CheckoutSdk::JsonSerializer.to_custom_hash(risk).
+    class PaymentSetupRisk
+      # Indicates whether a risk assessment should be performed.
+      # [Optional]
+      # Default: true
+      # @return [TrueClass, FalseClass]
+      attr_accessor :enabled
+    end
+  end
+end

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

@@ -28,12 +28,56 @@ module CheckoutSdk
       #   :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
+      #   typed classes above (or {CashAppPaymentMethod}, {PayByBankPaymentMethod} or
+      #   {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).
+      #   :payment_methods may also include :paybybank (the key is the single lowercase word
+      #   `paybybank`; the API ignores `pay_by_bank` without an error), a Hash with the keys documented
+      #   on {PayByBankPaymentMethod}; you send :bank_id (the identifier of the bank the customer has
+      #   selected for the payment).
+      #   :payment_methods may also include (every key is optional unless marked required):
+      #   - :card - :token (a Hash with :id, String, the Checkout.com card token), :details (the card
+      #     data: :number (String, write-only), :expiry_month (Integer), :expiry_year (Integer), :name
+      #     (String, write-only), :cvv (String, write-only), :stored (Boolean, write-only) and
+      #     :allow_update (Boolean)), :store_for_future_use (Boolean, write-only), :phone
+      #     (:country_code, String, min 1 character, max 7 characters, and :number, String, min 6
+      #     characters, max 25 characters), :account_holder (:type, one of "individual", "government"
+      #     or "corporate", :first_name, :last_name, :middle_name, :company_name (Strings) and
+      #     :account_name_inquiry (Boolean)) and :preferred_scheme ("visa", "mastercard" or
+      #     "cartes_bancaires"). The card data goes under :details; the API ignores it at the top level
+      #     of :card.
+      #   - :applepay - :token_data (write-only: :version, :data and :signature (Strings) and :header,
+      #     a Hash with :ephemeral_public_key, :public_key_hash and :transaction_id (Strings)), :token (a
+      #     Hash with :id, String, required, pattern ^(tok)_(\w{26})$, and :expires_on, date-time,
+      #     ISO 8601; a String token is not accepted), :store_for_future_use (Boolean, write-only),
+      #     :phone and :account_holder as on :card, and :preferred_scheme ("visa", "mastercard" or
+      #     "cartes_bancaires"). Apple Pay has no :details.
+      #   - :googlepay - :token_data (write-only: :protocol_version, :signature, :signed_message and
+      #     :tokenization_key (Strings)), :token, :store_for_future_use, :phone and :account_holder as
+      #     on :applepay, and :preferred_scheme ("visa" or "mastercard" only). Google Pay has no
+      #     :details.
+      #   - :instrument - :id (String, the unique identifier of the instrument to use).
+      #   - :auto_confirm - String, the payment method that automatically confirms the payment when it
+      #     is ready, for example "card".
+      #   :settings may include :success_url and :failure_url (String, format uri, max 255
+      #   characters), :capture (Boolean, whether to capture the payment immediately, default true) and
+      #   :excluded_payment_methods (Array of Strings, payment method names, for example ["klarna"]).
+      #   :order may include :sub_merchants, an Array of Hashes with :id (String), :product_category
+      #   (String), :number_of_sales (Integer; the API does not define number_of_trades) and
+      #   :registration_date (String, format date, yyyy-MM-dd).
+      #   :metadata - A Hash of key/value pairs to attach to the payment (max 20 keys); each value is a
+      #   String (max 255 characters), a Number or a Boolean.
+      #   :risk {PaymentSetupRisk} - Risk assessment settings for the Payment Setup: :enabled
+      #   (Boolean, whether a risk assessment should be performed, default true).
       #   :customer may include:
       #   - :id - The unique identifier of the customer.
       #   - :country - The two-letter ISO country code of the customer for this payment
@@ -58,7 +102,11 @@ module CheckoutSdk
       #     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.
+      #   payment_methods.cashapp.customer_profile. For Pay by Bank, read
+      #   payment_methods.paybybank.action.banks. Card, Apple Pay and Google Pay return the read-only
+      #   :schemes (supported card scheme names; Google Pay never lists cartes_bancaires) and card
+      #   details :last4, :bin, :scheme (Strings) and :expires_on (date-time); instrument returns the
+      #   read-only :type (String) and :action (:type, "set_instrument").
       def create_payment_setup(payment_setups_request)
         api_client.invoke_post(
           build_path(PAYMENTS_PATH, SETUPS_PATH),
@@ -81,12 +129,56 @@ module CheckoutSdk
       #   :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
+      #   typed classes above (or {CashAppPaymentMethod}, {PayByBankPaymentMethod} or
+      #   {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).
+      #   :payment_methods may also include :paybybank (the key is the single lowercase word
+      #   `paybybank`; the API ignores `pay_by_bank` without an error), a Hash with the keys documented
+      #   on {PayByBankPaymentMethod}; you send :bank_id (the identifier of the bank the customer has
+      #   selected for the payment).
+      #   :payment_methods may also include (every key is optional unless marked required):
+      #   - :card - :token (a Hash with :id, String, the Checkout.com card token), :details (the card
+      #     data: :number (String, write-only), :expiry_month (Integer), :expiry_year (Integer), :name
+      #     (String, write-only), :cvv (String, write-only), :stored (Boolean, write-only) and
+      #     :allow_update (Boolean)), :store_for_future_use (Boolean, write-only), :phone
+      #     (:country_code, String, min 1 character, max 7 characters, and :number, String, min 6
+      #     characters, max 25 characters), :account_holder (:type, one of "individual", "government"
+      #     or "corporate", :first_name, :last_name, :middle_name, :company_name (Strings) and
+      #     :account_name_inquiry (Boolean)) and :preferred_scheme ("visa", "mastercard" or
+      #     "cartes_bancaires"). The card data goes under :details; the API ignores it at the top level
+      #     of :card.
+      #   - :applepay - :token_data (write-only: :version, :data and :signature (Strings) and :header,
+      #     a Hash with :ephemeral_public_key, :public_key_hash and :transaction_id (Strings)), :token (a
+      #     Hash with :id, String, required, pattern ^(tok)_(\w{26})$, and :expires_on, date-time,
+      #     ISO 8601; a String token is not accepted), :store_for_future_use (Boolean, write-only),
+      #     :phone and :account_holder as on :card, and :preferred_scheme ("visa", "mastercard" or
+      #     "cartes_bancaires"). Apple Pay has no :details.
+      #   - :googlepay - :token_data (write-only: :protocol_version, :signature, :signed_message and
+      #     :tokenization_key (Strings)), :token, :store_for_future_use, :phone and :account_holder as
+      #     on :applepay, and :preferred_scheme ("visa" or "mastercard" only). Google Pay has no
+      #     :details.
+      #   - :instrument - :id (String, the unique identifier of the instrument to use).
+      #   - :auto_confirm - String, the payment method that automatically confirms the payment when it
+      #     is ready, for example "card".
+      #   :settings may include :success_url and :failure_url (String, format uri, max 255
+      #   characters), :capture (Boolean, whether to capture the payment immediately, default true) and
+      #   :excluded_payment_methods (Array of Strings, payment method names, for example ["klarna"]).
+      #   :order may include :sub_merchants, an Array of Hashes with :id (String), :product_category
+      #   (String), :number_of_sales (Integer; the API does not define number_of_trades) and
+      #   :registration_date (String, format date, yyyy-MM-dd).
+      #   :metadata - A Hash of key/value pairs to attach to the payment (max 20 keys); each value is a
+      #   String (max 255 characters), a Number or a Boolean.
+      #   :risk {PaymentSetupRisk} - Risk assessment settings for the Payment Setup: :enabled
+      #   (Boolean, whether a risk assessment should be performed, default true).
       #   :customer may include:
       #   - :id - The unique identifier of the customer.
       #   - :country - The two-letter ISO country code of the customer for this payment
@@ -111,7 +203,11 @@ module CheckoutSdk
       #     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.
+      #   payment_methods.cashapp.customer_profile. For Pay by Bank, read
+      #   payment_methods.paybybank.action.banks. Card, Apple Pay and Google Pay return the read-only
+      #   :schemes (supported card scheme names; Google Pay never lists cartes_bancaires) and card
+      #   details :last4, :bin, :scheme (Strings) and :expires_on (date-time); instrument returns the
+      #   read-only :type (String) and :action (:type, "set_instrument").
       def update_payment_setup(id, payment_setups_request)
         api_client.invoke_put(
           build_path(PAYMENTS_PATH, SETUPS_PATH, id),
@@ -126,7 +222,11 @@ module CheckoutSdk
       # @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.
+      #   payment_methods.cashapp.customer_profile. For Pay by Bank, read
+      #   payment_methods.paybybank.action.banks. Card, Apple Pay and Google Pay return the read-only
+      #   :schemes (supported card scheme names; Google Pay never lists cartes_bancaires) and card
+      #   details :last4, :bin, :scheme (Strings) and :expires_on (date-time); instrument returns the
+      #   read-only :type (String) and :action (:type, "set_instrument").
       def get_payment_setup(id)
         api_client.invoke_get(
           build_path(PAYMENTS_PATH, SETUPS_PATH, id),
@@ -143,7 +243,11 @@ module CheckoutSdk
       #   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.
+      #   payment_methods.cashapp.customer_profile. For Pay by Bank, read
+      #   payment_methods.paybybank.action.banks. Card, Apple Pay and Google Pay return the read-only
+      #   :schemes (supported card scheme names; Google Pay never lists cartes_bancaires) and card
+      #   details :last4, :bin, :scheme (Strings) and :expires_on (date-time); instrument returns the
+      #   read-only :type (String) and :action (:type, "set_instrument").
       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/payments/setups/stablecoin_payment_method.rb

@@ -5,7 +5,8 @@ module CheckoutSdk
     # Stablecoin payment method configuration on a Payment Setup. Maps swagger `Stablecoin`.
     #
     # @!attribute status
-    #   @return [String] (response-only) Payment method 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.
     class StablecoinPaymentMethod

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.0'
+  VERSION = '2.8.0'
 end