checkout_sdk 2.7.1 → 2.8.0

data/lib/checkout_sdk/payments/sender/corporate_sender.rb

@@ -2,15 +2,34 @@
 
 module CheckoutSdk
   module Payments
+    # A corporate sender, with type corporate. Used by card payouts, bank payouts and regular payments.
+    # The reference is inherited from {Sender}.
+    #
     # @!attribute company_name
+    #   The sender's company name. For card payouts, this must be a valid legal name: a single character or
+    #   all non-alphabetic characters return a field validation error.
+    #   [Required]
+    #   max 35 characters for card payouts
     #   @return [String]
     # @!attribute address
+    #   The sender's address. For card payouts, the residential address of an individual sender or the
+    #   registered corporate address of a corporate or government sender.
+    #   [Required]
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute reference_type
+    #   The type of identifier used as the reference. Card payouts only.
+    #   [Required] for card payouts
+    #   Enum: "other"
     #   @return [String]
     # @!attribute source_of_funds
+    #   The source of the funds used to fund the card payout. Card payouts only.
+    #   [Required] for card payouts
+    #   Enum: "credit" "debit" "prepaid" "deposit_account" "mobile_money_account" "cash"
     #   @return [String] {SourceOfFunds}
     # @!attribute identification
+    #   The sender's identification. For card payouts, required if the card's issuer_country is one of AR, BR,
+    #   CO or PE.
+    #   [Optional] Card payouts only.
     #   @return [CheckoutSdk::Common::AccountHolderIdentification]
     class CorporateSender < Sender
       attr_accessor :company_name,

data/lib/checkout_sdk/payments/sender/government_sender.rb

@@ -2,17 +2,38 @@
 
 module CheckoutSdk
   module Payments
+    # A government sender, with type government. Card payouts only.
+    #
     # @!attribute company_name
+    #   The sender's company name. This must be a valid legal name: a single character or all non-alphabetic
+    #   characters return a field validation error.
+    #   [Required]
+    #   max 35 characters
     #   @return [String]
     # @!attribute address
+    #   The sender's registered corporate address.
+    #   [Required]
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute reference
+    #   The unique identifier for the sender, for example a customer number. Only alphanumeric characters
+    #   are supported.
+    #   [Required]
+    #   min 5 characters
+    #   max 15 characters
     #   @return [String]
     # @!attribute reference_type
+    #   The type of identifier used as the reference.
+    #   [Required]
+    #   Enum: "other"
     #   @return [String]
     # @!attribute source_of_funds
+    #   The source of the funds used to fund the card payout.
+    #   [Required]
+    #   Enum: "credit" "debit" "prepaid" "deposit_account" "mobile_money_account" "cash"
     #   @return [String] {SourceOfFunds}
     # @!attribute identification
+    #   The sender's identification. Required if the card's issuer_country is one of AR, BR, CO or PE.
+    #   [Optional]
     #   @return [CheckoutSdk::Common::AccountHolderIdentification]
     class GovernmentSender < Sender
       attr_accessor :company_name,

data/lib/checkout_sdk/payments/sender/individual_sender.rb

@@ -2,29 +2,75 @@
 
 module CheckoutSdk
   module Payments
+    # An individual sender, with type individual. Used by card payouts, bank payouts and regular payments.
+    #
     # @!attribute first_name
+    #   The sender's legal first name. For card payouts, the combination of first_name, middle_name and
+    #   last_name should exceed 3 letters in length, and a single character or all non-alphabetic
+    #   characters return a field validation error.
+    #   [Required]
+    #   max 50 characters for card payouts
     #   @return [String]
     # @!attribute middle_name
+    #   The sender's middle name. Card payouts only.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     # @!attribute last_name
+    #   The sender's legal last name. For card payouts, the combination of first_name, middle_name and
+    #   last_name must exceed 3 letters in length, and a single character or all non-alphabetic characters
+    #   return a field validation error.
+    #   [Required]
+    #   max 50 characters for card payouts
     #   @return [String]
     # @!attribute dob
+    #   The sender's date of birth in a YYYY-MM-DD format. Strongly recommended where available. Bank
+    #   payouts only; card payouts and regular payments use date_of_birth.
+    #   [Optional]
+    #   max 10 characters
     #   @return [String]
     # @!attribute address
+    #   The sender's address. For card payouts, the sender's residential address.
+    #   [Required]
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute identification
+    #   The sender's identification. For card payouts, required if the card's issuer_country is one of AR, BR,
+    #   CO or PE.
+    #   [Optional]
     #   @return [CheckoutSdk::Common::AccountHolderIdentification]
     # @!attribute reference
+    #   For card payouts, the unique identifier for the sender, for example a customer number; only
+    #   alphanumeric characters are supported. For bank payouts, a unique reference to the underlying
+    #   client's customer, a global KYC requirement. For regular payments, the unique reference for the
+    #   sender of the payment.
+    #   [Required] for card payouts and bank payouts, [Optional] for regular payments
+    #   min 5 characters, max 15 characters for card payouts
     #   @return [String]
     # @!attribute reference_type
+    #   The type of identifier used as the reference. Card payouts only.
+    #   [Required] for card payouts
+    #   Enum: "other"
     #   @return [String]
     # @!attribute date_of_birth
+    #   The sender's date of birth, in the format YYYY-MM-DD. For card payouts, required for cross-border
+    #   money transfers. Card payouts and regular payments; bank payouts use dob.
+    #   [Optional]
+    #   10 characters for card payouts, max 10 characters for regular payments
     #   @return [String]
     # @!attribute source_of_funds
+    #   The source of the funds used to fund the card payout. Card payouts only.
+    #   [Required] for card payouts
+    #   Enum: "credit" "debit" "prepaid" "deposit_account" "mobile_money_account" "cash"
     #   @return [String] {SourceOfFunds}
     # @!attribute country_of_birth
+    #   The sender's country of birth, as a two-letter ISO country code. Card payouts only.
+    #   [Optional]
+    #   2 characters
     #   @return [String] {CheckoutSdk::Common::Country}
     # @!attribute nationality
+    #   The sender's nationality, as a two-letter ISO country code. Card payouts only.
+    #   [Optional]
+    #   2 characters
     #   @return [String] {CheckoutSdk::Common::Country}
     class IndividualSender < Sender
       attr_accessor :first_name,

data/lib/checkout_sdk/payments/sender/instrument_sender.rb

@@ -2,6 +2,9 @@
 
 module CheckoutSdk
   module Payments
+    # An instrument sender, with type instrument: the sender information is retrieved from the payment
+    # instrument (the destination, for bank payouts). Used by bank payouts and regular payments.
+    # The reference is inherited from {Sender}: [Required] for bank payouts, [Optional] for regular payments.
     class InstrumentSender < Sender
       def initialize
         super(CheckoutSdk::Payments::SenderType::INSTRUMENT)

data/lib/checkout_sdk/payments/sender/sender.rb

@@ -2,9 +2,25 @@
 
 module CheckoutSdk
   module Payments
+    # The sender of a payment or a payout. Set the subclass that matches the sender type.
+    # - Card payouts (money transfers): {IndividualSender}, {CorporateSender}, {GovernmentSender}.
+    # - Bank payouts: {IndividualSender}, {CorporateSender}, {InstrumentSender}. Not supported for Platform or
+    #   Direct Seller Checkout.com clients.
+    # - Regular payments (PaymentRequest): {IndividualSender}, {CorporateSender}, {InstrumentSender}.
+    #
     # @!attribute type
+    #   The sender type. Set by each subclass.
+    #   [Required]
+    #   Enum: "individual" "corporate" "government" (card payouts); "instrument" "individual" "corporate"
+    #   (bank payouts and regular payments)
     #   @return [String] {SenderType}
     # @!attribute reference
+    #   For card payouts, the unique identifier for the sender, for example a customer number; only
+    #   alphanumeric characters are supported. For bank payouts, a unique reference to the underlying
+    #   client's customer, a global KYC requirement. For regular payments, the unique reference for the
+    #   sender of the payment.
+    #   [Required] for card payouts and bank payouts, [Optional] for regular payments
+    #   min 5 characters, max 15 characters for card payouts
     #   @return [String]
     class Sender
       attr_reader :type

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

@@ -3,69 +3,90 @@
 module CheckoutSdk
   module Payments
     # @!attribute amount
-    #   @return [Integer]
+    #   @return [Integer] [Required] The payment amount.
     # @!attribute currency
-    #   @return [String] {CheckoutSdk::Common::Currency}
+    #   @return [String] {CheckoutSdk::Common::Currency} [Required] The three-letter ISO currency code.
     # @!attribute payment_type
-    #   @return [TrueClass, FalseClass]
+    #   @return [String] {PaymentType} [Optional] Must be specified for card-not-present (CNP) payments.
+    #     Enum: "Regular" "Recurring" "MOTO" "Installment" "Unscheduled". Default: "Regular".
     # @!attribute billing
-    #   @return [BillingInformation]
+    #   @return [BillingInformation] [Required] The billing details.
     # @!attribute billing_descriptor
-    #   @return [BillingDescriptor]
+    #   @return [BillingDescriptor] [Optional] A description of the purchase, which is displayed on the customer's
+    #     statement.
     # @!attribute reference
-    #   @return [String]
+    #   @return [String] [Optional] A reference you can use to identify the payment.
     # @!attribute description
-    #   @return [String]
+    #   @return [String] [Optional] A description for the payment.
     # @!attribute customer
-    #   @return [CheckoutSdk::Common::CustomerRequest]
+    #   @return [CheckoutSdk::Common::CustomerRequest] [Optional] The customer's details.
     # @!attribute shipping
-    #   @return [ShippingDetails]
+    #   @return [ShippingDetails] [Optional] The shipping details
     # @!attribute recipient
-    #   @return [PaymentRecipient]
+    #   @return [PaymentRecipient] [Optional] Information about the recipient of the payment's funds.
     # @!attribute processing
-    #   @return [ProcessingSettings]
+    #   @return [ProcessingSettings] [Optional] Use the processing object to influence or override the data sent
+    #     during card processing
     # @!attribute processing_channel_id
-    #   @return [String]
+    #   @return [String] [Optional] The processing channel to use for the payment.
     # @!attribute expires_on
-    #   @return [Time]
+    #   @return [Time] [Optional] A timestamp specifying when the `PaymentSession` should expire, as an ISO 8601 code.
     # @!attribute payment_method_configuration
-    #   @return [PaymentMethodConfiguration]
+    #   @return [PaymentMethodConfiguration] [Optional] Configurations for payment method-specific settings.
     # @!attribute enabled_payment_methods
-    #   @return [Array(PaymentMethodsType)]
+    #   @return [Array(PaymentMethodsType)] [Optional] Specifies which payment method options to present to the
+    #     customer.
     # @!attribute disabled_payment_methods
-    #   @return [Array(PaymentMethodsType)]
+    #   @return [Array(PaymentMethodsType)] [Optional] Specifies which payment method options to not present to the
+    #     customer.
     # @!attribute items
-    #   @return [Array(Product)]
+    #   @return [Array(Product)] [Optional] The line items in the order.
     # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] [Optional] The sub-entities that the payment is being
+    #     processed on behalf of.
     # @!attribute risk
-    #   @return [RiskRequest]
+    #   @return [RiskRequest] [Optional] Configures the risk assessment performed during payment processing.
     # @!attribute retry
-    #   @return [PaymentRetryRequest]
+    #   @return [PaymentRetryRequest] [Optional] Configuration of asynchronous retries.
+    #   @deprecated Not part of the payment sessions request; the API ignores it. Will be removed in the next
+    #     major version.
+    # @!attribute customer_retry
+    #   @return [CheckoutSdk::Common::CustomerRetry] [Optional] Configures the parameters for customer retries
+    #     performed by the customer on the checkout page. max_attempts is the maximum number of customer retry
+    #     attempts, excluding the initial payment attempt (minimum 0, maximum 5, default 5); it is required
+    #     when customer_retry is set.
     # @!attribute display_name
-    #   @return [String]
+    #   @return [String] [Optional] The merchant's display name.
     # @!attribute success_url
-    #   @return [String]
+    #   @return [String] [Required] Overrides the default success redirect URL configured on your account, for payment
+    #     methods that require a redirect.
     # @!attribute failure_url
-    #   @return [String]
+    #   @return [String] [Required] Overrides the default failure redirect URL configured on your account, for payment
+    #     methods that require a redirect.
     # @!attribute metadata
-    #   @return [Hash{String => Object}]
+    #   @return [Hash{String => Object}] [Optional] Allows you to store additional information about a transaction
+    #     with custom fields and up to five user-defined fields, which can be used for reporting purposes.
     # @!attribute locale
-    #   @return [String]
+    #   @return [String] [Optional] Creates a translated version of the page in the specified language.
     # @!attribute three_ds
-    #   @return [ThreeDSRequest]
+    #   @return [ThreeDSRequest] [Optional] Information required for 3D Secure authentication payments.
     # @!attribute sender
-    #   @return [Sender]
+    #   @return [Sender] [Optional] The sender of the payment.
     # @!attribute capture
-    #   @return [TrueClass, FalseClass]
+    #   @return [TrueClass, FalseClass] [Optional] Specifies whether to capture the payment, if applicable.
     # @!attribute ip_address
-    #   @return [String]
+    #   @return [String] [Optional] The Customers IP address. Only IPv4 and IPv6 addresses are accepted.
+    #   @deprecated The Customers IP address is deprecated in the API reference. Will be removed in the next
+    #     major version.
     # @!attribute capture_on
-    #   @return [Time]
+    #   @return [Time] [Optional] A timestamp specifying when to capture the payment, as an ISO 8601 code.
     # @!attribute tax_amount
-    #   @return [Integer]
+    #   @return [Integer] [Optional] The total tax amount, in the minor currency unit. Not in the
+    #     payment sessions request specification.
     # @!attribute authorization_type
     #   @return [String] [Optional] {AuthorizationType} Enum: "Final" "Estimated". Default: "Final".
+    # @!attribute instruction
+    #   @return [HostedPaymentInstruction] [Optional] Details about the payment instruction.
     # @!attribute payment_plan
     #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
     #     To be used when the payment_type is Recurring.
@@ -90,6 +111,7 @@ module CheckoutSdk
                     :amount_allocations,
                     :risk,
                     :retry,
+                    :customer_retry,
                     :display_name,
                     :success_url,
                     :failure_url,
@@ -102,7 +124,8 @@ module CheckoutSdk
                     :capture_on,
                     :tax_amount,
                     :authorization_type,
-                    :payment_plan
+                    :payment_plan,
+                    :instruction
     end
   end
 end

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

@@ -2,11 +2,20 @@
 
 module CheckoutSdk
   module Payments
+    # Sender identification details of an Account Funding Transaction on a Payment Setup.
+    # Maps swagger `PaymentSetup.account_funding_transaction.sender.identification`.
+    #
     # @!attribute type
-    #   @return [String] {AccountFundingTransactionIdentificationType}
+    #   The type of identification used to identify the sender.
+    #   [Optional]
+    #   @return [String] One of {AccountFundingTransactionIdentificationType}.
     # @!attribute number
+    #   The identification number.
+    #   [Optional]
     #   @return [String]
     # @!attribute issuing_country
+    #   The two-letter ISO country code of the country that issued the identification.
+    #   [Optional]
     #   @return [String] {CheckoutSdk::Common::Country}
     class AccountFundingTransactionIdentification
       attr_accessor :type,

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

@@ -2,14 +2,15 @@
 
 module CheckoutSdk
   module Payments
-    # Identification document type used by the sender of an Account Funding Transaction
-    # on a Payment Setup.
+    # The type of identification used to identify the sender of an Account Funding Transaction on a
+    # Payment Setup. Maps swagger `PaymentSetup.account_funding_transaction.sender.identification.type`.
     module AccountFundingTransactionIdentificationType
+      # A driving license.
       DRIVING_LICENSE = 'driving_license'
+      # A passport.
       PASSPORT = 'passport'
+      # A national identity document.
       NATIONAL_ID = 'national_id'
-      TAX_ID = 'tax_id'
-      OTHER = 'other'
     end
   end
 end

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

@@ -2,17 +2,45 @@
 
 module CheckoutSdk
   module Payments
+    # Account funding transaction recipient details on a Payment Setup.
+    # Maps swagger `PaymentSetup.account_funding_transaction.recipient`.
+    #
     # @!attribute first_name
+    #   The recipient's first name.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     # @!attribute last_name
+    #   The recipient's last name.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     # @!attribute account_number
+    #   Any identifier like part of the PAN (first six digits and last four digits), an IBAN, an internal
+    #   account number, or a phone number related to the primary recipient's account.
+    #   [Optional]
+    #   max 34 characters
     #   @return [String]
     # @!attribute account_type
+    #   The type of the recipient's account.
+    #   [Optional]
+    #   @deprecated Not part of the Recipient 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 recipient (yyyy-mm-dd).
+    #   [Optional]
+    #   Format: date
+    #   @return [String]
     # @!attribute address
+    #   The recipient's address. Maps swagger `PaymentSetupAddress`; all keys are optional:
+    #   - `address_line1`: The first line of the address. max 200 characters
+    #   - `address_line2`: The second line of the address. max 200 characters
+    #   - `city`: The address city. max 50 characters
+    #   - `state`: The address state or county. max 50 characters
+    #   - `zip`: The postal or zip code. max 50 characters
+    #   - `country`: The address country, in ISO 3166-1 alpha-2 format. max 2 characters
+    #   [Optional]
     #   @return [CheckoutSdk::Common::Address]
     class AccountFundingTransactionRecipient
       attr_accessor :first_name,

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).