checkout_sdk 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c6ddde9012cab748f19899933a93f9102807140f0f6ddd043de10b2af1c5331
-  data.tar.gz: 3b101a19818d2c987f0dbbff00aedb5c213391edfc79a9f2b710491fc6b4ae19
+  metadata.gz: 1b407e28ff0b39c99b367549f0a8936f08cdab77844dbbaae25120131b7a68fc
+  data.tar.gz: a51e29d577617ba5c4a36e288df85b6fd03e2184b0f9a7f85db86455258079a0
 SHA512:
-  metadata.gz: fa721cccaad4523065d5c9941a65b07198ed0da224a667308dbebee847dc03b5fb7affb6520e3aa2c84f142953fdf1fd72020dad06378fec1cfaef775d24ca0a
-  data.tar.gz: dd9a1bbf04c7c5fa4508dfd0e6c27ecf2528bbd0b8e4bce0f16fc1d2171ce4f34cbf6e161f3bd51561a510cbf167ce98ac24f91a5bde168cbce9d0d6f894be68
+  metadata.gz: aaf583699b582fdcd33dc32e5178870074b874427ce2a032a0919ef472d8e59ae9627824affffb185a11735607a310a52dabfb5fa52bd10371a715137e128226
+  data.tar.gz: 60331bb9c0b309e98f738d1bbc140fa648c6b75c4a75ebc442f5bd406bcca6cfd343c1bbad8817d894ca6657d03c00f08da9a3f7c084a6e3c86caf1dfc8bd3a9

data/lib/checkout_sdk/issuing/issuing_client.rb

@@ -93,7 +93,10 @@ module CheckoutSdk
       # @param [CardUpdateHeaders, nil] headers the optional return-encrypted-cvv and
       #   Encryption-Key HTTP headers. Setting return_encrypted_cvv without encryption_key returns
       #   a 422 with error code encryption_key_required.
-      # @return [OpenStruct] the update response, carrying encrypted_cvv when requested
+      # @return [OpenStruct] the update response, carrying encrypted_cvv when requested. For a
+      #   virtual card the response may also carry is_single_use (boolean, default false),
+      #   specifying whether the card is set to expire after a single use. Physical cards never
+      #   send it.
       def update_card(card_id, update_card_request, headers = nil)
         api_client.invoke_patch(
           build_path(ISSUING, CARDS, card_id),

data/lib/checkout_sdk/issuing/update_card_request.rb

@@ -39,14 +39,21 @@ module CheckoutSdk
     #   Example: 2026-06-01T10:00Z
     #   @return [String]
     # @!attribute revocation_date
-    #   Date scheduling the card's automatic revocation.
-    #   [Optional]
-    #   Format: yyyy-MM-dd (time is midnight UTC)
-    #   Example: 2027-03-12
-    #   @return [String]
+    #   @return [String] Date for the card to be automatically revoked, in the form `yyyy-mm-dd`.
+    #     Must be after the current date. Maps swagger `IssuingRevocationDate`.
+    #   @deprecated Use {#scheduled_revocation_date} instead.
+    # @!attribute scheduled_revocation_date
+    #   @return [String] Date for the card to be automatically revoked, in the form `yyyy-mm-dd`.
+    #     Overrides the deprecated {#revocation_date} when both are given. Maps swagger
+    #     `IssuingScheduledRevocationDate`.
+    # @!attribute status
+    #   @return [String] Set to `active` to reactivate an `inactive` or `suspended` card.
+    #     Mutually exclusive with `scheduled_activation_date`: submitting both returns a
+    #     `scheduled_activation_date_conflicts_with_activation` error. The only supported
+    #     value is `active`.
     class UpdateCardRequest
       attr_accessor :reference, :metadata, :expiry_month, :expiry_year,
-                    :scheduled_activation_date, :revocation_date
+                    :scheduled_activation_date, :revocation_date, :scheduled_revocation_date, :status
     end
   end
 end

data/lib/checkout_sdk/payments/accommodation_data.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Contains information about the accommodation booked by the customer.
+    #
+    # Maps the swagger `AccommodationData` schema, which `POST /payments`, the
+    # `GET /payments/{id}` response and `PaymentContextProcessing` all resolve to.
+    #
+    # `property_phone` and `customer_service_phone` are declared on `AccommodationData` only.
+    # The `PaymentInterfacesProcessingAccommodationData` schema used by hosted payments, payment
+    # links and payment sessions carries the other eleven properties but neither phone array, so
+    # those two are read on `POST /payments` and payment contexts and ignored elsewhere.
+    #
+    # @!attribute name
+    #   @return [String] The name of the accommodation.
+    #     [Optional]
+    #     Example: "The Sea View Hotel"
+    # @!attribute booking_reference
+    #   @return [String] The booking reference for the stay.
+    #     [Optional]
+    #     Example: "HOTEL123"
+    # @!attribute check_in_date
+    #   @return [String] The date the customer checks in.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "2023-06-20"
+    # @!attribute check_out_date
+    #   @return [String] The date the customer checks out.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "2023-06-23"
+    # @!attribute address
+    #   @return [AccommodationAddress] The address of the accommodation.
+    #     [Optional]
+    # @!attribute state
+    #   @return [String] The state or region the accommodation is in.
+    #     [Optional]
+    #     A plain string, not a country code. Example: "FL"
+    # @!attribute country
+    #   @return [String] The country the accommodation is in.
+    #     [Optional]
+    #     A plain string, not an ISO 3166-1 alpha-2 code: the specification's own example is the
+    #     three-letter "USA", which no alpha-2 enum can hold. Example: "USA"
+    # @!attribute city
+    #   @return [String] The city the accommodation is in.
+    #     [Optional]
+    #     Example: "Los Angeles"
+    # @!attribute number_of_rooms
+    #   @return [Integer] The number of rooms booked.
+    #     [Optional]
+    #     Example: 2
+    # @!attribute guests
+    #   @return [Array(AccommodationGuest)] The guests staying at the accommodation.
+    #     [Optional]
+    # @!attribute room
+    #   @return [Array(AccommodationRoom)] The rooms booked by the customer.
+    #     [Optional]
+    #     Named `room` in the singular by the specification, and it is an array.
+    # @!attribute property_phone
+    #   @return [Array(AccommodationPhone)] Phone numbers for the property.
+    #     [Optional]
+    #     Declared on `AccommodationData` only.
+    # @!attribute customer_service_phone
+    #   @return [Array(AccommodationPhone)] Customer service phone numbers for the property.
+    #     [Optional]
+    #     Declared on `AccommodationData` only.
+    class AccommodationData
+      attr_accessor :name,
+                    :booking_reference,
+                    :check_in_date,
+                    :check_out_date,
+                    :address,
+                    :state,
+                    :country,
+                    :city,
+                    :number_of_rooms,
+                    :guests,
+                    :room,
+                    :property_phone,
+                    :customer_service_phone
+    end
+
+    # Partial address information for an accommodation.
+    #
+    # The specification declares exactly these two properties, so this is deliberately not the
+    # wide {CheckoutSdk::Common::Address}.
+    #
+    # @!attribute address_line1
+    #   @return [String] The first line of the address.
+    #     [Optional]
+    #     Example: "123 Beach Road"
+    # @!attribute zip
+    #   @return [String] The postal code of the address.
+    #     [Optional]
+    #     Example: "10001"
+    class AccommodationAddress
+      attr_accessor :address_line1,
+                    :zip
+    end
+
+    # A guest staying at the accommodation.
+    #
+    # @!attribute first_name
+    #   @return [String] The guest's first name.
+    #     [Optional]
+    #     Example: "Jane"
+    # @!attribute last_name
+    #   @return [String] The guest's last name.
+    #     [Optional]
+    #     Example: "Doe"
+    # @!attribute date_of_birth
+    #   @return [String] The guest's date of birth.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "1985-07-14"
+    class AccommodationGuest
+      attr_accessor :first_name,
+                    :last_name,
+                    :date_of_birth
+    end
+
+    # A room booked at the accommodation.
+    #
+    # Both properties are strings in this schema. The payment setups equivalent,
+    # {PaymentSetupAccommodationRoom}, declares a numeric `rate` and an integer
+    # `number_of_nights` instead, so the two are not interchangeable.
+    #
+    # @!attribute rate
+    #   @return [String] The nightly rate for the room.
+    #     [Optional]
+    #     A string, not a number. Example: "70"
+    # @!attribute number_of_nights_at_room_rate
+    #   @return [String] The number of nights booked at that rate.
+    #     [Optional]
+    #     A string, not an integer. Example: "3"
+    class AccommodationRoom
+      attr_accessor :rate,
+                    :number_of_nights_at_room_rate
+    end
+
+    # A phone number for an accommodation property.
+    #
+    # The specification declares exactly these two properties, so this is deliberately not the
+    # wide {CheckoutSdk::Common::Phone}.
+    #
+    # @!attribute country_code
+    #   @return [String] The international dialling code.
+    #     [Optional]
+    #     Example: "44"
+    # @!attribute number
+    #   @return [String] The phone number.
+    #     [Optional]
+    #     Example: "7123456789"
+    class AccommodationPhone
+      attr_accessor :country_code,
+                    :number
+    end
+  end
+end

data/lib/checkout_sdk/payments/ach_service_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Which ACH service to use for the payment, when `source.type` is `ach`.
+    #
+    # Named after the .NET `AchServiceType` enum and the PHP doc reference, which map the same
+    # property.
+    module AchServiceType
+      SAME_DAY = 'same_day'
+      STANDARD = 'standard'
+    end
+  end
+end

data/lib/checkout_sdk/payments/aggregator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Information about the payment aggregator.
+    #
+    # Maps the swagger `Aggregator` schema. Named after the schema, unlike .NET which calls its
+    # equivalent `ProcessingAggregator`; Ruby has no name collision here.
+    #
+    # @!attribute sub_merchant_id
+    #   @return [String] The sub-merchant ID.
+    #     [Optional]
+    #     Example: "9cf70789ba90123"
+    # @!attribute aggregator_id_visa
+    #   @return [String] The Visa identifier for the payment aggregator.
+    #     [Optional]
+    #     Example: "10012345"
+    # @!attribute aggregator_id_mc
+    #   @return [String] The Mastercard identifier for the payment aggregator.
+    #     [Optional]
+    #     Example: "00000123456"
+    class Aggregator
+      attr_accessor :sub_merchant_id,
+                    :aggregator_id_visa,
+                    :aggregator_id_mc
+    end
+  end
+end

data/lib/checkout_sdk/payments/airline_data.rb

@@ -2,12 +2,46 @@
 
 module CheckoutSdk
   module Payments
+    # Contains information about the airline ticket and flights booked by the customer.
+    #
+    # Maps the swagger `AirlineData` schema, which `POST /payments`, the `GET /payments/{id}`
+    # response and `PaymentContextProcessing` all resolve to, and the
+    # `PaymentInterfacesProcessingAirlineData` schema used by hosted payments, payment links and
+    # payment sessions. The two declare the same three properties.
+    #
     # @!attribute ticket
-    #   @return [Ticket]
+    #   @return [Ticket] Contains information about the airline ticket.
+    #     [Optional]
+    #     A single object, not a collection.
     # @!attribute passenger
-    #   @return [Passenger]
+    #   @return [Passenger, Array(Passenger)] Contains information about the passenger or
+    #     passengers on the flight.
+    #     [Optional]
+    #
+    #     Accepts either a single {Passenger} or an array of them, and the choice is not
+    #     cosmetic. Verified against the sandbox on 2026-09-25:
+    #
+    #       | Surface                  | object | array |
+    #       |--------------------------|--------|-------|
+    #       | POST /payments           | 201    | 201   |
+    #       | POST /hosted-payments    | 201    | 422   |
+    #       | POST /payment-links      | 201    | 422   |
+    #       | POST /payment-contexts   | 201    | 422   |
+    #
+    #     So assign a single {Passenger} for one passenger: that is accepted on every request
+    #     surface. Assign an array only for two or more, and only on `POST /payments`, which is
+    #     the sole surface that takes it. Leave the attribute unset when there are no passengers:
+    #     an empty array and an explicit null are both rejected with
+    #     `processing_airline_data_0_passenger_invalid`.
+    #
+    #     This inverts the specification, which declares the property array-only on `AirlineData`
+    #     and `oneOf[array, object]` on `PaymentInterfacesProcessingAirlineData`. The array branch
+    #     does not exist in practice on three of the four surfaces. Responses may carry either
+    #     shape, so read defensively.
     # @!attribute flight_leg_details
-    #   @return [Array(FlightLegDetails)]
+    #   @return [Array(FlightLegDetails)] Contains information about the flight legs booked by the
+    #     customer.
+    #     [Optional]
     class AirlineData
       attr_accessor :ticket,
                     :passenger,

data/lib/checkout_sdk/payments/flight_leg_details.rb

@@ -2,33 +2,59 @@
 
 module CheckoutSdk
   module Payments
+    # Contains information about a flight leg booked by the customer.
+    #
+    # Maps the inline `flight_leg_details` item on the swagger `AirlineData` and
+    # `PaymentInterfacesProcessingAirlineData` schemas, and `PaymentSetupFlightLegDetails` for
+    # payment setups. All three declare the same nine properties with the same spelling, which is
+    # why one class serves the payments and the setups paths.
+    #
     # @!attribute flight_number
-    #   @return [Integer]
+    #   @return [String] The flight number.
+    #     [Optional]
+    #     Example: "101"
     # @!attribute carrier_code
-    #   @return [String]
-    # @!attribute service_class
-    #   @return [String]
+    #   @return [String] The IATA carrier code.
+    #     [Optional]
+    #     Example: "BA"
+    # @!attribute class_of_travelling
+    #   @return [String] The fare class of the leg.
+    #     [Optional]
+    #     Example: "J"
     # @!attribute departure_date
-    #   @return [String]
+    #   @return [String] The date the flight departs.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "2023-06-19"
     # @!attribute departure_time
-    #   @return [String]
+    #   @return [String] The local time the flight departs.
+    #     [Optional]
+    #     Example: "15:30"
     # @!attribute departure_airport
-    #   @return [String]
+    #   @return [String] The IATA code of the departure airport.
+    #     [Optional]
+    #     Example: "LHR"
     # @!attribute arrival_airport
-    #   @return [String]
-    # @!attribute stopover_code
-    #   @return [String]
+    #   @return [String] The IATA code of the arrival airport.
+    #     [Optional]
+    #     Example: "LAX"
+    # @!attribute stop_over_code
+    #   @return [String] Whether a stopover is permitted on the leg.
+    #     [Optional]
+    #     Example: "x"
     # @!attribute fare_basis_code
-    #   @return [String]
+    #   @return [String] The fare basis code for the leg.
+    #     [Optional]
+    #     Example: "SPRSVR"
     class FlightLegDetails
       attr_accessor :flight_number,
                     :carrier_code,
-                    :service_class,
+                    :class_of_travelling,
                     :departure_date,
                     :departure_time,
                     :departure_airport,
                     :arrival_airport,
-                    :stopover_code,
+                    :stop_over_code,
                     :fare_basis_code
     end
   end

data/lib/checkout_sdk/payments/pan_processed_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The preferred type of Primary Account Number (PAN) for the payment.
+    #
+    # Named after the .NET `PanProcessedType` enum, which maps the same property.
+    module PanProcessedType
+      # Indicates a preference for using the full card number.
+      FPAN = 'fpan'
+      # Indicates a preference for using the Checkout.com Network Token.
+      DPAN = 'dpan'
+    end
+  end
+end

data/lib/checkout_sdk/payments/partner_customer_risk_data.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # A key-and-value pair with merchant-specific data for the transaction.
+    #
+    # The specification describes `partner_customer_risk_data` as "an array of key-and-value
+    # pairs" but declares it as a single inline object with `key` and `value`. The description and
+    # the declared type disagree; this class models the declared shape, which is what the gateway
+    # validates against.
+    #
+    # @!attribute key
+    #   @return [String] The key for the pair.
+    #     [Optional]
+    # @!attribute value
+    #   @return [String] The value for the pair.
+    #     [Optional]
+    class PartnerCustomerRiskData
+      attr_accessor :key,
+                    :value
+    end
+  end
+end

data/lib/checkout_sdk/payments/passenger.rb

@@ -2,17 +2,29 @@
 
 module CheckoutSdk
   module Payments
-    # Contains information about a passenger on the flight
-    # (PaymentInterfacesProcessingAirlinePassengerData).
+    # Contains information about a passenger on the flight.
+    #
+    # Maps the inline `passenger` item on the swagger `AirlineData` and
+    # `PaymentInterfacesProcessingAirlineData` schemas. See {AirlineData#passenger} for the
+    # cardinality rule: a single object is accepted on every request surface, an array only on
+    # POST /payments.
     #
     # @!attribute first_name
-    #   @return [String]
+    #   @return [String] The passenger's first name.
+    #     [Optional]
+    #     Example: "John"
     # @!attribute last_name
-    #   @return [String]
+    #   @return [String] The passenger's last name.
+    #     [Optional]
+    #     Example: "White"
     # @!attribute date_of_birth
-    #   @return [String] Format: YYYY-MM-DD
+    #   @return [String] The passenger's date of birth.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "1990-05-26"
     # @!attribute address
-    #   @return [PassengerAddress]
+    #   @return [PassengerAddress] Contains information about the passenger's address.
+    #     [Optional]
     class Passenger
       attr_accessor :first_name,
                     :last_name,
@@ -22,8 +34,13 @@ module CheckoutSdk
 
     # Partial address information for an airline passenger.
     #
+    # The specification declares exactly one property here, so this is deliberately not the wide
+    # {CheckoutSdk::Common::Address}.
+    #
     # @!attribute country
-    #   @return [String] {CheckoutSdk::Common::Country}
+    #   @return [String] The two-letter ISO country code of the passenger's country residence.
+    #     [Optional]
+    #     Example: "US"
     class PassengerAddress
       attr_accessor :country
     end

data/lib/checkout_sdk/payments/payments.rb

@@ -26,6 +26,13 @@ require 'checkout_sdk/payments/capture_type'
 require 'checkout_sdk/payments/payment_type'
 require 'checkout_sdk/payments/merchant_initiated_reason'
 require 'checkout_sdk/payments/preferred_schema'
+require 'checkout_sdk/payments/ticket'
+require 'checkout_sdk/payments/accommodation_data'
+require 'checkout_sdk/payments/aggregator'
+require 'checkout_sdk/payments/partner_customer_risk_data'
+require 'checkout_sdk/payments/pan_processed_type'
+require 'checkout_sdk/payments/ach_service_type'
+require 'checkout_sdk/payments/processing_card_type'
 require 'checkout_sdk/payments/airline_data'
 require 'checkout_sdk/payments/risk_request'
 require 'checkout_sdk/payments/billing_descriptor'
@@ -126,7 +133,6 @@ require 'checkout_sdk/payments/sender/government_sender'
 require 'checkout_sdk/payments/sender/individual_sender'
 require 'checkout_sdk/payments/sender/corporate_sender'
 require 'checkout_sdk/payments/sender/instrument_sender'
-require 'checkout_sdk/payments/sender/ticket'
 require 'checkout_sdk/payments/sender/sender_information'
 
 # Destination

data/lib/checkout_sdk/payments/processing_card_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Whether to process the payment as a credit or debit transaction, when a combo card is used.
+    #
+    # Deliberately NOT named `CardType`. The specification's values here are lowercase
+    # `credit` and `debit`, while every generic card-type enum across the SDK family uses
+    # `Credit`/`Debit` or `CREDIT`/`DEBIT`. .NET types this property as its generic `CardType`,
+    # whose values are `Credit` and `Debit`, so it sends the wrong casing. Go avoided that by
+    # adding a dedicated `ProcessingCardType`; this follows Go.
+    module ProcessingCardType
+      CREDIT = 'credit'
+      DEBIT = 'debit'
+    end
+  end
+end

data/lib/checkout_sdk/payments/processing_data.rb

@@ -34,7 +34,7 @@ module CheckoutSdk
     # @!attribute partner_transaction_id
     #   @return [String] [Optional] Unique transaction identification provided by partner.
     # @!attribute partner_error_codes
-    #   @return [Array<String>] [Optional] The list of error codes that led the payment to fail or
+    #   @return [Array(String)] [Optional] The list of error codes that led the payment to fail or
     #     be declined, as given by the payment provider.
     # @!attribute partner_error_message
     #   @return [String] [Optional] Error description provided by partner.
@@ -51,7 +51,7 @@ module CheckoutSdk
     #     additional information about the transaction. For declined transactions it also
     #     indicates whether the payment can be retried and how long to wait.
     # @!attribute custom_payment_method_ids
-    #   @return [Array<String>] [Optional] An array defining which of the configured payment
+    #   @return [Array(String)] [Optional] An array defining which of the configured payment
     #     options within a payment category (for example, pay_later or pay_over_time) should be
     #     displayed for this purchase.
     # @!attribute aft
@@ -84,10 +84,10 @@ module CheckoutSdk
     #     differ from the card's scheme used for the payment if the card is co-badged and the
     #     payment was authorized on a different network. Read-only.
     # @!attribute accommodation_data
-    #   @return [Array<AccommodationData>] [Optional] Contains information about the accommodation
+    #   @return [Array(AccommodationData)] [Optional] Contains information about the accommodation
     #     booked by the customer.
     # @!attribute airline_data
-    #   @return [Array<AirlineData>] [Optional] Contains information about the airline ticket and
+    #   @return [Array(AirlineData)] [Optional] Contains information about the airline ticket and
     #     flights booked by the customer.
     # @!attribute scheme_transaction_link_id
     #   @return [String] [Optional] The scheme transaction link identifier. Returned for

data/lib/checkout_sdk/payments/processing_settings.rb

@@ -2,81 +2,265 @@
 
 module CheckoutSdk
   module Payments
+    # Settings that control how the payment is processed.
+    #
+    # One shared type covering several request shapes: `POST /payments` resolves to
+    # `PaymentRequestProcessing`, while hosted payments, payment links and payment sessions
+    # resolve to the wider `PaymentInterfacesProcessing`. A property is therefore not necessarily
+    # read by every endpoint that accepts this object, and the notes below say which.
+    #
+    # Attributes marked "not in any request processing schema" are retained for backwards
+    # compatibility. The gateway discards them.
+    #
     # @!attribute order_id
-    #   @return [String]
+    #   @return [String] The number provided by the cardholder. Purchase order or invoice number
+    #     may be used.
+    #     [Optional]
+    #     max 15 characters
+    #     Example: "123456789"
     # @!attribute tax_amount
-    #   @return [Integer]
+    #   @return [Numeric] The total amount of sales tax on the total purchase amount.
+    #     [Optional]
+    #     min 0
+    #     Example: 3000
     # @!attribute discount_amount
-    #   @return [Integer]
+    #   @return [Numeric] The discount amount applied to the transaction by the merchant.
+    #     [Optional]
+    #     min 0
     # @!attribute duty_amount
-    #   @return [Integer]
+    #   @return [Numeric] The total charges for any import or export duty included in the
+    #     transaction.
+    #     [Optional]
+    #     min 0
     # @!attribute shipping_amount
-    #   @return [Integer]
+    #   @return [Numeric] The total freight or shipping and handling charges for the transaction.
+    #     [Optional]
+    #     min 0
+    #     Example: 300
     # @!attribute shipping_tax_amount
-    #   @return [Integer]
+    #   @return [Numeric] The tax amount of the freight or shipping and handling charges for the
+    #     transaction.
+    #     [Optional]
+    #     min 0
+    #     Example: 100
+    # @!attribute surcharge_amount
+    #   @return [Integer] Surcharge amount applied to the transaction in minor units by the
+    #     merchant.
+    #     [Optional]
+    #     min 0
+    #     Example: 200
+    # @!attribute original_order_amount
+    #   @return [Numeric] The payment for a merchant's order may be split, and the original order
+    #     price indicates the transaction amount of the entire order.
+    #     [Optional]
+    #     min 0
+    # @!attribute foreign_retailer_amount
+    #   @return [Integer] The foreign retailer amount the merchant applied to the transaction, in
+    #     the minor currency unit.
+    #     [Optional]
+    #     min 0
+    #     Example: 200
     # @!attribute aft
-    #   @return [TrueClass, FalseClass]
+    #   @return [TrueClass, FalseClass] Indicates if the payment is an Account Funding
+    #     Transaction.
+    #     [Optional]
     # @!attribute preferred_scheme
-    #   @return [String] {PreferredSchema}
+    #   @return [String] The preferred scheme for co-badged card payment processing. If performing
+    #     3DS via a third party, set this value to the scheme that processed 3DS. This field does
+    #     not support PINless debit schemes in the US (STAR, PULSE, NYCE, ACCEL, SHAZAM).
+    #     [Optional]
+    #     One of: mastercard, visa, cartes_bancaires. See {PreferredSchema}
     # @!attribute merchant_initiated_reason
-    #   @return [String] {MerchantInitiatedReason}
+    #   @return [String] Indicates the reason for a merchant-initiated payment request.
+    #     [Optional]
+    #     One of: Delayed_charge, Resubmission, No_show, Reauthorization.
+    #     See {MerchantInitiatedReason}
     # @!attribute campaign_id
-    #   @return [Integer]
+    #   @return [Integer] Unique number of the campaign this payment will be running in. Only
+    #     required for Afterpay campaign invoices.
+    #     [Optional]
     # @!attribute product_type
-    #   @return [String] {ProductType}
+    #   @return [String] Product type of the payment. Required when `source.type` is `wechatpay`,
+    #     optional for `tamara`, required for `sequra`. The accepted values differ per source
+    #     type. See {ProductType}
+    #     [Optional]
+    #     Example: "QR Code"
     # @!attribute open_id
-    #   @return [String]
-    # @!attribute original_order_amount
-    #   @return [Integer]
+    #   @return [String] Value obtained from the WeChat Web Authorization API before initiating
+    #     Official Account or Mini Program payments. Required if `source.type` is `wechatpay` and
+    #     `processing.product_type` is `Official Account` or `Mini Program`.
+    #     [Optional]
+    #     Example: "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
     # @!attribute receipt_id
-    #   @return [String]
+    #   @return [String] Merchant receipt ID.
+    #     [Optional]
+    #     max 32 characters
+    # @!attribute reconciliation_id
+    #   @return [String] The transaction identifier to track a payment request.
+    #     [Optional]
+    #     Example: "4123495123"
     # @!attribute terminal_type
-    #   @return [String] {TerminalType}
+    #   @return [String] The client-side terminal type, whether it is a website opened via a PC
+    #     browser, a mobile browser, or a mobile application.
+    #     [Optional]
+    #     One of: APP, WAP, WEB. See {TerminalType}
     # @!attribute os_type
-    #   @return [String] {OsType}
+    #   @return [String] The device operating system. Required when `terminal_type` is not `WEB`.
+    #     [Optional]
+    #     One of: ANDROID, IOS. See {OsType}
     # @!attribute invoice_id
-    #   @return [String]
+    #   @return [String] Invoice ID number.
+    #     [Optional]
+    #     max 127 characters
     # @!attribute brand_name
-    #   @return [String]
+    #   @return [String] The label that overrides the business name in the PayPal account on the
+    #     PayPal pages.
+    #     [Optional]
+    #     max 127 characters
+    #     Declared on `PaymentInterfacesProcessing` only.
     # @!attribute locale
-    #   @return [String]
+    #   @return [String] The language and region of the customer in ISO 639-2 language code; the
+    #     value consists of language-country.
+    #     [Optional]
+    #     Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$
+    #     min 2 characters, max 10 characters
+    #     Example: "en-US"
     # @!attribute shipping_preference
-    #   @return [String] {ShippingPreference}
+    #   @return [String] The shipping preference for the payment.
+    #     [Optional]
+    #     One of: no_shipping, set_provided_address, get_from_file. See {ShippingPreference}
+    #     Declared on `PaymentContextProcessing` only, so it is read by POST /payment-contexts.
     # @!attribute user_action
-    #   @return [String] {UserAction}
-    # @!attribute set_transaction_context
-    #   @return [Array(Hash{String => String})]
-    # @!attribute airline_data
-    #   @return [Array(AirlineData)]
-    # @!attribute otp_value
-    #   @return [String]
+    #   @return [String] Property required by PayPal to have an appropriate payment flow.
+    #     [Optional]
+    #     One of: pay_now, continue. See {UserAction}
+    #     Declared on `PaymentContextProcessing` only.
+    # @!attribute pan_preference
+    #   @return [String] The preferred type of Primary Account Number (PAN) for the payment. Only
+    #     works for `source.type` cards, instruments and tokens. `dpan` indicates a preference for
+    #     the Checkout.com Network Token, `fpan` for the full card number.
+    #     [Optional]
+    #     One of: fpan, dpan. See {PanProcessedType}
+    # @!attribute provision_network_token
+    #   @return [TrueClass, FalseClass] Indicates whether to provision a network token for the
+    #     payment.
+    #     [Optional]
+    # @!attribute card_type
+    #   @return [String] Specifies whether to process the payment as a credit or debit
+    #     transaction, if a combo card is used. Required for domestic payments in Brazil performed
+    #     using a Brazilian card.
+    #     [Optional]
+    #     One of: credit, debit. See {ProcessingCardType}
+    # @!attribute service_type
+    #   @return [String] Specifies which ACH service to use for the payment, if you set
+    #     `source.type` to `ach`.
+    #     [Optional]
+    #     One of: same_day, standard. See {AchServiceType}
     # @!attribute purchase_country
-    #   @return [String] {CheckoutSdk::Common::Country}
+    #   @return [String] The two-letter ISO country code of the purchase country. If you are a
+    #     Visa-registered ramp provider operating with affiliates, this field is required.
+    #     [Optional]
+    #     max 2 characters
+    #     Example: "GB". See {CheckoutSdk::Common::Country}
     # @!attribute custom_payment_method_ids
-    #   @return [Array(String)]
+    #   @return [Array(String)] Promo codes. They define which of the configured payment options
+    #     within a payment category (pay_later, pay_over_time, and so on) are shown for this
+    #     purchase.
+    #     [Optional]
+    #     Declared on `PaymentInterfacesProcessing` only.
     # @!attribute merchant_callback_url
-    #   @return [String]
+    #   @return [String] A URL which you can use to notify the customer that the order has been
+    #     created.
+    #     [Optional]
     # @!attribute line_of_business
-    #   @return [String]
+    #   @return [String] Beta. The line of business that the payment is associated with.
+    #     [Optional]
+    #     Example: "Flights"
+    # @!attribute partner_code
+    #   @return [String] The customer's 6-digit Blik code. Required when `source.type` is `blik`
+    #     and `merchant_initiated` is `false`.
+    #     [Optional]
+    #     Pattern: ^\d{6}$
+    #     min 6 characters, max 6 characters
+    #     Example: "902111"
+    # @!attribute scheme_transaction_link_id
+    #   @return [String] The scheme transaction link identifier.
+    #     [Optional]
+    # @!attribute affiliate_id
+    #   @return [String] The unique identifier for Visa-registered ramp providers. Must only
+    #     contain alphanumeric characters. Required if you are a Visa-registered ramp provider
+    #     operating with affiliates.
+    #     [Optional]
+    #     Pattern: ^[a-zA-Z0-9]{1,15}$
+    #     max 15 characters
+    # @!attribute affiliate_url
+    #   @return [String] The affiliate URL. Required if you are a Visa-registered ramp provider
+    #     operating with affiliates.
+    #     [Optional]
+    #     Example: "www.mycrypto.com"
+    # @!attribute aggregator
+    #   @return [Aggregator] Information about the payment aggregator.
+    #     [Optional]
+    # @!attribute partner_customer_risk_data
+    #   @return [PartnerCustomerRiskData] Key-and-value pair with merchant-specific data for the
+    #     transaction.
+    #     [Optional]
+    #     Declared on `PaymentInterfacesProcessing` and `PaymentContextProcessing`, not on
+    #     `PaymentRequestProcessing`.
+    # @!attribute airline_data
+    #   @return [Array(AirlineData)] Contains information about the airline ticket and flights
+    #     booked by the customer.
+    #     [Optional]
+    # @!attribute accommodation_data
+    #   @return [Array(AccommodationData)] Contains information about the accommodation booked by
+    #     the customer.
+    #     [Optional]
+    # @!attribute set_transaction_context
+    #   @return [Array(Hash{String => String})] Additional transaction context information.
+    #     [Optional]
+    #     Not in any request processing schema, in either specification. Serializes as
+    #     `set_transaction_context`, which no schema defines, so the gateway discards it. Retained
+    #     for backwards compatibility.
+    # @!attribute otp_value
+    #   @return [String] The one-time password value for authentication.
+    #     [Optional]
+    #     Not on `PaymentRequestProcessing` or `PaymentInterfacesProcessing`. It is declared on
+    #     the payment contexts payment request and on the capture request only, so setting it here
+    #     has no effect.
     # @!attribute shipping_delay
-    #   @return [Integer]
+    #   @return [Integer] The shipping delay in days.
+    #     [Optional]
+    #     Not in any request processing schema, in either specification. The gateway discards it.
+    #     Retained for backwards compatibility.
     # @!attribute shipping_info
-    #   @return [Array(CheckoutSdk::Common::ShippingInfo)]
+    #   @return [Array(CheckoutSdk::Common::ShippingInfo)] Additional shipping information for the
+    #     payment.
+    #     [Optional]
+    #     Not in any request processing schema, in either specification. The gateway discards it.
+    #     Retained for backwards compatibility.
     # @!attribute dlocal
-    #   @return [DLocalProcessingSettings]
+    #   @return [DLocalProcessingSettings] dLocal-specific processing settings.
+    #     [Optional]
+    #     Previous API (ABC) only. Absent from the current (NAS) processing schemas.
     # @!attribute senderInformation
-    #   @return [SenderInformation]
+    #   @return [SenderInformation] Sender information for the payment.
+    #     [Optional]
+    #     Not in the current specification. The property appears under neither
+    #     `senderInformation` nor `sender_information` in any spec available to this workspace,
+    #     including the live API reference, and no processing schema declares a sender property of
+    #     any kind. Deprecated in practice; the current API carries sender details in the top
+    #     level `sender` object on the payment request instead.
+    #
+    #     Left exactly as it is on purpose. Ruby uses attribute names as wire keys verbatim, so
+    #     this goes out as `senderInformation`. That camelCase spelling is long standing across
+    #     the SDK family but has never been confirmed against a live ABC endpoint, so treat it as
+    #     unverified rather than correct, and do not change it in either direction without such a
+    #     confirmation.
     # @!attribute purpose
-    #   @return [String]
-    # @!attribute affiliate_id
-    #   @return [string]
-    # @!attribute affiliate_url
-    #   @return [string]
-    # @!attribute partner_code
-    #   @return [String] The customer's 6-digit BLIK code. Required when source.type is "blik"
-    #     and merchant_initiated is false. Pattern: ^\d{6}$
-    # @!attribute scheme_transaction_link_id
-    #   @return [String] [Optional] The scheme transaction link identifier.
+    #   @return [String] The purpose of the payment.
+    #     [Optional]
+    #     Not declared on any processing schema in either specification. The name appears
+    #     elsewhere in the spec on unrelated objects. The gateway discards it here.
     class ProcessingSettings
       attr_accessor :order_id,
                     :tax_amount,
@@ -84,14 +268,17 @@ module CheckoutSdk
                     :duty_amount,
                     :shipping_amount,
                     :shipping_tax_amount,
+                    :surcharge_amount,
+                    :original_order_amount,
+                    :foreign_retailer_amount,
                     :aft,
                     :preferred_scheme,
                     :merchant_initiated_reason,
                     :campaign_id,
                     :product_type,
                     :open_id,
-                    :original_order_amount,
                     :receipt_id,
+                    :reconciliation_id,
                     :terminal_type,
                     :os_type,
                     :invoice_id,
@@ -99,22 +286,29 @@ module CheckoutSdk
                     :locale,
                     :shipping_preference,
                     :user_action,
-                    :set_transaction_context,
-                    :airline_data,
-                    :otp_value,
+                    :pan_preference,
+                    :provision_network_token,
+                    :card_type,
+                    :service_type,
                     :purchase_country,
                     :custom_payment_method_ids,
                     :merchant_callback_url,
                     :line_of_business,
+                    :partner_code,
+                    :scheme_transaction_link_id,
+                    :affiliate_id,
+                    :affiliate_url,
+                    :aggregator,
+                    :partner_customer_risk_data,
+                    :airline_data,
+                    :accommodation_data,
+                    :set_transaction_context,
+                    :otp_value,
                     :shipping_delay,
                     :shipping_info,
                     :dlocal,
                     :senderInformation,
-                    :purpose,
-                    :affiliate_id,
-                    :affiliate_url,
-                    :partner_code,
-                    :scheme_transaction_link_id
+                    :purpose
     end
   end
 end

data/lib/checkout_sdk/payments/ticket.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Contains information about the airline ticket.
+    #
+    # Maps the inline `ticket` object on the swagger `AirlineData` and
+    # `PaymentInterfacesProcessingAirlineData` schemas. Both declare the same six properties.
+    #
+    # @!attribute number
+    #   @return [String] The ticket's unique identifier.
+    #     [Optional]
+    #     Example: "045-21351455613"
+    # @!attribute issue_date
+    #   @return [String] Date the airline ticket was issued.
+    #     [Optional]
+    #     Format: date (YYYY-MM-DD)
+    #     Example: "2023-05-20"
+    # @!attribute issuing_carrier_code
+    #   @return [String] Carrier code of the ticket issuer.
+    #     [Optional]
+    #     Example: "AI"
+    # @!attribute travel_package_indicator
+    #   @return [String] C = Car rental reservation, A = Airline flight reservation,
+    #     B = Both car rental and airline flight reservations included, N = Unknown.
+    #     [Optional]
+    #     Example: "B"
+    # @!attribute travel_agency_name
+    #   @return [String] The name of the travel agency.
+    #     [Optional]
+    #     Example: "World Tours"
+    # @!attribute travel_agency_code
+    #   @return [String] The unique identifier from IATA or ARC for the travel agency that
+    #     issues the ticket.
+    #     [Optional]
+    #     Example: "01"
+    class Ticket
+      attr_accessor :number,
+                    :issue_date,
+                    :issuing_carrier_code,
+                    :travel_package_indicator,
+                    :travel_agency_name,
+                    :travel_agency_code
+    end
+  end
+end

data/lib/checkout_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-24 00:00:00.000000000 Z
+date: 2026-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -448,6 +448,9 @@ files:
 - lib/checkout_sdk/payment_methods/payment_methods.rb
 - lib/checkout_sdk/payment_methods/payment_methods_client.rb
 - lib/checkout_sdk/payment_methods/payment_methods_query.rb
+- lib/checkout_sdk/payments/accommodation_data.rb
+- lib/checkout_sdk/payments/ach_service_type.rb
+- lib/checkout_sdk/payments/aggregator.rb
 - lib/checkout_sdk/payments/airline_data.rb
 - lib/checkout_sdk/payments/apple_pay/apple_pay_certificate_request.rb
 - lib/checkout_sdk/payments/apple_pay/apple_pay_client.rb
@@ -493,7 +496,9 @@ files:
 - lib/checkout_sdk/payments/merchant_initiated_reason.rb
 - lib/checkout_sdk/payments/network_token_type.rb
 - lib/checkout_sdk/payments/os_type.rb
+- lib/checkout_sdk/payments/pan_processed_type.rb
 - lib/checkout_sdk/payments/partial_authorization.rb
+- lib/checkout_sdk/payments/partner_customer_risk_data.rb
 - lib/checkout_sdk/payments/passenger.rb
 - lib/checkout_sdk/payments/payer.rb
 - lib/checkout_sdk/payments/payment_instruction.rb
@@ -549,6 +554,7 @@ files:
 - lib/checkout_sdk/payments/previous/source/network_token_source.rb
 - lib/checkout_sdk/payments/previous/source/payment_source.rb
 - lib/checkout_sdk/payments/previous/source/token_source.rb
+- lib/checkout_sdk/payments/processing_card_type.rb
 - lib/checkout_sdk/payments/processing_data.rb
 - lib/checkout_sdk/payments/processing_settings.rb
 - lib/checkout_sdk/payments/product.rb
@@ -567,7 +573,6 @@ files:
 - lib/checkout_sdk/payments/sender/sender_information.rb
 - lib/checkout_sdk/payments/sender/sender_type.rb
 - lib/checkout_sdk/payments/sender/source_of_funds.rb
-- lib/checkout_sdk/payments/sender/ticket.rb
 - lib/checkout_sdk/payments/sessions/payment_methods_type.rb
 - lib/checkout_sdk/payments/sessions/payment_sessions_client.rb
 - lib/checkout_sdk/payments/sessions/payment_sessions_request.rb
@@ -665,6 +670,7 @@ files:
 - lib/checkout_sdk/payments/terminal_type.rb
 - 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/user_action.rb
 - lib/checkout_sdk/payments/void_request.rb
 - lib/checkout_sdk/platform_type.rb

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module CheckoutSdk
-  module Payments
-    # @!attribute number
-    #   @return [String]
-    # @!attribute issue_date
-    #   @return [String]
-    # @!attribute issuing_carrier_code
-    #   @return [String]
-    # @!attribute travel_agency_name
-    #   @return [String]
-    # @!attribute travel_agency_code
-    #   @return [String]
-    class Ticket
-      attr_accessor :number,
-                    :issue_date,
-                    :issuing_carrier_code,
-                    :travel_agency_name,
-                    :travel_agency_code
-    end
-  end
-end