checkout_sdk 2.3.0 → 2.5.0

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.3.0'
+  VERSION = '2.5.0'
 end

data/lib/checkout_sdk.rb

@@ -75,6 +75,7 @@ require 'checkout_sdk/standalone_account_updater/standalone_account_updater'
 require 'checkout_sdk/network_tokens/network_tokens'
 require 'checkout_sdk/payment_methods/payment_methods'
 require 'checkout_sdk/identities/identities'
+require 'checkout_sdk/inventory/inventory'
 
 # Checkout modules (previous)
 require 'checkout_sdk/sources/sources'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-17 00:00:00.000000000 Z
+date: 2026-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -343,6 +343,12 @@ files:
 - lib/checkout_sdk/identities/identity_verification/identity_verification_request.rb
 - lib/checkout_sdk/identities/identity_verification/idv_client_information.rb
 - lib/checkout_sdk/identities/identity_verification/idv_declared_data.rb
+- lib/checkout_sdk/identities/identity_verification/idv_identity_client_information.rb
+- lib/checkout_sdk/identities/identity_verification/idv_identity_declared_data.rb
+- lib/checkout_sdk/identities/idv_address.rb
+- lib/checkout_sdk/identities/idv_attempt_assets_query_filter.rb
+- lib/checkout_sdk/identities/idv_attempts_query_filter.rb
+- lib/checkout_sdk/identities/idv_phone_number.rb
 - lib/checkout_sdk/instruments/ach_account_type.rb
 - lib/checkout_sdk/instruments/bacs_payment_type.rb
 - lib/checkout_sdk/instruments/base_instruments_client.rb
@@ -386,9 +392,18 @@ files:
 - lib/checkout_sdk/instruments/update/update_sepa_account_holder.rb
 - lib/checkout_sdk/instruments/update/update_sepa_billing_address.rb
 - lib/checkout_sdk/instruments/update/update_sepa_instrument_data.rb
+- lib/checkout_sdk/inventory/inventory.rb
+- lib/checkout_sdk/inventory/inventory_adjustment_request.rb
+- lib/checkout_sdk/inventory/inventory_client.rb
+- lib/checkout_sdk/inventory/inventory_money.rb
+- lib/checkout_sdk/inventory/inventory_reservation_item.rb
+- lib/checkout_sdk/inventory/inventory_reservation_request.rb
+- lib/checkout_sdk/inventory/inventory_set_levels_request.rb
+- lib/checkout_sdk/inventory/inventory_set_product_request.rb
 - lib/checkout_sdk/issuing/add_control_group_request.rb
 - lib/checkout_sdk/issuing/add_control_profile_request.rb
 - lib/checkout_sdk/issuing/amend_dispute_request.rb
+- lib/checkout_sdk/issuing/card_update_headers.rb
 - lib/checkout_sdk/issuing/cardholder_access_token_request.rb
 - lib/checkout_sdk/issuing/create_dispute_request.rb
 - lib/checkout_sdk/issuing/escalate_dispute_request.rb
@@ -433,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
@@ -478,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
@@ -534,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
@@ -552,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
@@ -650,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