checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/payments/refund_request.rb

@@ -9,12 +9,21 @@ module CheckoutSdk
     # @!attribute metadata
     #   @return [Hash{String => Object}]
     # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    # @!attribute capture_action_id
+    #   @return [String]
+    # @!attribute destination
+    #   @return [CheckoutSdk::Common::Destination]
+    # @!attribute items
+    #   @return [Array(CheckoutSdk::Payments::RefundOrder)]
     class RefundRequest
       attr_accessor :amount,
                     :reference,
                     :metadata,
-                    :amount_allocations
+                    :amount_allocations,
+                    :capture_action_id,
+                    :destination,
+                    :items
     end
   end
 end

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

@@ -20,7 +20,7 @@ module CheckoutSdk
                     :identification
 
       def initialize
-        super CheckoutSdk::Payments::SenderType::CORPORATE
+        super(CheckoutSdk::Payments::SenderType::CORPORATE)
       end
     end
   end

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

@@ -6,6 +6,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute address
     #   @return [CheckoutSdk::Common::Address]
+    # @!attribute reference
+    #   @return [String]
     # @!attribute reference_type
     #   @return [String]
     # @!attribute source_of_funds
@@ -15,12 +17,13 @@ module CheckoutSdk
     class GovernmentSender < Sender
       attr_accessor :company_name,
                     :address,
+                    :reference,
                     :reference_type,
                     :source_of_funds,
                     :identification
 
       def initialize
-        super CheckoutSdk::Payments::SenderType::GOVERNMENT
+        super(CheckoutSdk::Payments::SenderType::GOVERNMENT)
       end
     end
   end

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

@@ -14,6 +14,8 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute identification
     #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    # @!attribute reference
+    #   @return [String]
     # @!attribute reference_type
     #   @return [String]
     # @!attribute date_of_birth
@@ -31,6 +33,7 @@ module CheckoutSdk
                     :dob,
                     :address,
                     :identification,
+                    :reference,
                     :reference_type,
                     :date_of_birth,
                     :source_of_funds,
@@ -38,7 +41,7 @@ module CheckoutSdk
                     :nationality
 
       def initialize
-        super CheckoutSdk::Payments::SenderType::INDIVIDUAL
+        super(CheckoutSdk::Payments::SenderType::INDIVIDUAL)
       end
     end
   end

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

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Payments
     class InstrumentSender < Sender
       def initialize
-        super CheckoutSdk::Payments::SenderType::INSTRUMENT
+        super(CheckoutSdk::Payments::SenderType::INSTRUMENT)
       end
     end
   end

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

@@ -4,17 +4,29 @@ module CheckoutSdk
   module Payments
     class PaymentSessionsClient < Client
       PAYMENT_SESSIONS = 'payment-sessions'
+      COMPLETE = 'complete'
+      private_constant :COMPLETE
 
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
       end
 
       # @param [Hash, PaymentSessionsRequest] payment_sessions
       def create_payment_sessions(payment_sessions)
         api_client.invoke_post(PAYMENT_SESSIONS, sdk_authorization, payment_sessions)
       end
+
+      # Create and immediately submit a payment session. POST /payment-sessions/complete.
+      # @param [Hash] payment_sessions_request
+      def create_and_complete_payment_sessions(payment_sessions_request)
+        api_client.invoke_post(
+          build_path(PAYMENT_SESSIONS, COMPLETE),
+          sdk_authorization,
+          payment_sessions_request
+        )
+      end
     end
   end
 end

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

@@ -60,8 +60,15 @@ module CheckoutSdk
     #   @return [TrueClass, FalseClass]
     # @!attribute ip_address
     #   @return [String]
+    # @!attribute capture_on
+    #   @return [Time]
     # @!attribute tax_amount
     #   @return [Integer]
+    # @!attribute authorization_type
+    #   @return [String] [Optional] {AuthorizationType} Enum: "Final" "Estimated". Default: "Final".
+    # @!attribute payment_plan
+    #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
+    #     To be used when the payment_type is Recurring.
     class PaymentSessionsRequest
       attr_accessor :amount,
                     :currency,
@@ -92,7 +99,10 @@ module CheckoutSdk
                     :sender,
                     :capture,
                     :ip_address,
-                    :tax_amount
+                    :capture_on,
+                    :tax_amount,
+                    :authorization_type,
+                    :payment_plan
     end
   end
 end

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

@@ -5,6 +5,7 @@ module CheckoutSdk
     module StorePaymentDetailsType
       DISABLED = 'disabled'
       ENABLED = 'enabled'
+      COLLECT_CONSENT = 'collect_consent'
     end
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute type
+    #   @return [String] {AccountFundingTransactionIdentificationType}
+    # @!attribute number
+    #   @return [String]
+    # @!attribute issuing_country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class AccountFundingTransactionIdentification
+      attr_accessor :type,
+                    :number,
+                    :issuing_country
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Identification document type used by the sender of an Account Funding Transaction
+    # on a Payment Setup.
+    module AccountFundingTransactionIdentificationType
+      DRIVING_LICENSE = 'driving_license'
+      PASSPORT = 'passport'
+      NATIONAL_ID = 'national_id'
+      TAX_ID = 'tax_id'
+      OTHER = 'other'
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Enum of allowed `purpose` values on a PaymentSetup AccountFundingTransaction.
+    # See https://api-reference.checkout.com (PaymentSetupAccountFundingTransaction.purpose).
+    module AccountFundingTransactionPurpose
+      DONATIONS = 'donations'
+      EDUCATION = 'education'
+      EMERGENCY_NEED = 'emergency_need'
+      EXPATRIATION = 'expatriation'
+      FAMILY_SUPPORT = 'family_support'
+      FINANCIAL_SERVICES = 'financial_services'
+      GIFTS = 'gifts'
+      INCOME = 'income'
+      INSURANCE = 'insurance'
+      INVESTMENT = 'investment'
+      IT_SERVICES = 'it_services'
+      LEISURE = 'leisure'
+      LOAN_PAYMENT = 'loan_payment'
+      MEDICAL_TREATMENT = 'medical_treatment'
+      OTHER = 'other'
+      PENSION = 'pension'
+      ROYALTIES = 'royalties'
+      SAVINGS = 'savings'
+      TRAVEL_AND_TOURISM = 'travel_and_tourism'
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute account_type
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [String] Format: YYYY-MM-DD
+    # @!attribute address
+    #   @return [CheckoutSdk::Common::Address]
+    class AccountFundingTransactionRecipient
+      attr_accessor :first_name,
+                    :last_name,
+                    :account_number,
+                    :account_type,
+                    :date_of_birth,
+                    :address
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [String] Format: YYYY-MM-DD
+    # @!attribute country_of_birth
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute nationality
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute identification
+    #   @return [AccountFundingTransactionIdentification]
+    class AccountFundingTransactionSender
+      attr_accessor :first_name,
+                    :last_name,
+                    :date_of_birth,
+                    :country_of_birth,
+                    :nationality,
+                    :address,
+                    :identification
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Bacs payment method configuration on a Payment Setup. Maps swagger `Bacs`.
+    #
+    # @!attribute status
+    #   @return [String] (response-only) Payment method status.
+    # @!attribute flags
+    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
+    # @!attribute initialization
+    #   @return [String] The initialization type for the payment method.
+    # @!attribute instrument_id
+    #   @return [String] (response-only) The ID of the Bacs instrument used for the payment.
+    # @!attribute account_holder
+    #   @return [Hash] The account holder details (`type`, `first_name`, `last_name`,
+    #     `company_name`, `email`).
+    # @!attribute account_number
+    #   @return [String] The account number of the Bacs Direct Debit account.
+    # @!attribute bank_code
+    #   @return [String] The bank code (sort code) of the Bacs Direct Debit account.
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute allow_partial_match
+    #   @return [TrueClass, FalseClass] Whether to allow a partial match of the account holder details.
+    class BacsPaymentMethod
+      attr_accessor :status,
+                    :flags,
+                    :initialization,
+                    :instrument_id,
+                    :account_holder,
+                    :account_number,
+                    :bank_code,
+                    :country,
+                    :currency,
+                    :allow_partial_match
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Blik payment method configuration on a Payment Setup.
+    #
+    # @!attribute status
+    #   @return [String] (response-only) Payment method status (e.g. "available").
+    # @!attribute flags
+    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
+    # @!attribute partner_code
+    #   @return [String] The 6-digit Blik code generated by the customer's banking app.
+    #     Pattern: ^[0-9]{6}$
+    class BlikPaymentMethod
+      attr_accessor :status,
+                    :flags,
+                    :partner_code
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Card Present payment method configuration on a Payment Setup. Maps swagger `CardPresent`.
+    #
+    # @!attribute status
+    #   @return [String] (response-only) Payment method status.
+    # @!attribute flags
+    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
+    # @!attribute track2
+    #   @return [String] The Track 2 data read from card or device.
+    # @!attribute emv
+    #   @return [String] The EMV data read from the card or device.
+    # @!attribute entry_mode
+    #   @return [String] The mode used to capture the card details at the point of sale.
+    # @!attribute pin
+    #   @return [Hash] The encrypted PIN block details (`key_set_id`, `block`, `block_format`).
+    # @!attribute store_for_future_use
+    #   @return [TrueClass, FalseClass] Set to `true` if you intend to reuse the payment credentials
+    #     in subsequent payments.
+    # @!attribute name
+    #   @return [String] The cardholder name.
+    class CardPresentPaymentMethod
+      attr_accessor :status,
+                    :flags,
+                    :track2,
+                    :emv,
+                    :entry_mode,
+                    :pin,
+                    :store_for_future_use,
+                    :name
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Pay by Bank (Open Banking) payment method configuration on a Payment Setup.
+    # Maps swagger `PayByBank`.
+    #
+    # @!attribute status
+    #   @return [String] (response-only) Payment method status.
+    # @!attribute flags
+    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
+    # @!attribute bank_id
+    #   @return [String] The identifier of the bank the customer has selected for the payment.
+    # @!attribute action
+    #   @return [Hash] (response-only) The next available action for the payment method
+    #     (`type`, `banks`).
+    class PayByBankPaymentMethod
+      attr_accessor :status,
+                    :flags,
+                    :bank_id,
+                    :action
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute enabled
+    #   @return [TrueClass, FalseClass]
+    # @!attribute purpose
+    #   @return [String] {AccountFundingTransactionPurpose}
+    # @!attribute sender
+    #   @return [AccountFundingTransactionSender]
+    # @!attribute recipient
+    #   @return [AccountFundingTransactionRecipient]
+    class PaymentSetupAccountFundingTransaction
+      attr_accessor :enabled,
+                    :purpose,
+                    :sender,
+                    :recipient
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Client for Payment Setups API operations
+    # [Beta]
+    class PaymentSetupsClient < Client
+      PAYMENTS_PATH = 'payments'
+      SETUPS_PATH = 'setups'
+      CONFIRM_PATH = 'confirm'
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+      end
+
+      # Creates a Payment Setup.
+      # To maximize the amount of information the payment setup can use, we recommend that you create
+      # a payment setup as early as possible in the customer's journey. For example, the first time
+      # they land on the basket page.
+      # [Beta]
+      #
+      # @param [Hash] payment_setups_request
+      def create_payment_setup(payment_setups_request)
+        api_client.invoke_post(
+          build_path(PAYMENTS_PATH, SETUPS_PATH),
+          sdk_authorization,
+          payment_setups_request
+        )
+      end
+
+      # Updates a Payment Setup.
+      # You should update the payment setup whenever there are significant changes in the data relevant
+      # to the customer's transaction. For example, when the customer makes a change that impacts the
+      # total payment amount.
+      # [Beta]
+      #
+      # @param [String] id - The unique identifier of the Payment Setup to update
+      # @param [Hash] payment_setups_request
+      def update_payment_setup(id, payment_setups_request)
+        api_client.invoke_put(
+          build_path(PAYMENTS_PATH, SETUPS_PATH, id),
+          sdk_authorization,
+          payment_setups_request
+        )
+      end
+
+      # Retrieves a Payment Setup.
+      # [Beta]
+      #
+      # @param [String] id - The unique identifier of the Payment Setup to retrieve
+      def get_payment_setup(id)
+        api_client.invoke_get(
+          build_path(PAYMENTS_PATH, SETUPS_PATH, id),
+          sdk_authorization
+        )
+      end
+
+      # Confirms a Payment Setup to begin processing the payment request with your chosen
+      # payment method option.
+      # [Beta]
+      #
+      # @param [String] id - The unique identifier of the Payment Setup
+      # @param [String] payment_method_option_id - The unique identifier of the payment option
+      # to process the payment with
+      def confirm_payment_setup(id, payment_method_option_id)
+        api_client.invoke_post(
+          build_path(PAYMENTS_PATH, SETUPS_PATH, id, CONFIRM_PATH, payment_method_option_id),
+          sdk_authorization
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Stablecoin payment method configuration on a Payment Setup. Maps swagger `Stablecoin`.
+    #
+    # @!attribute status
+    #   @return [String] (response-only) Payment method status.
+    # @!attribute flags
+    #   @return [Array(String)] (response-only) Diagnostic flags returned by the API.
+    class StablecoinPaymentMethod
+      attr_accessor :status,
+                    :flags
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/ach_source.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_type
+    #   @return [CheckoutSdk::Common::AccountType]
+    # @!attribute country
+    #   @return [CheckoutSdk::Common::Country]
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute bank_code
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class AchSource < PaymentSource
+      attr_accessor :account_type,
+                    :country,
+                    :account_number,
+                    :bank_code,
+                    :account_holder
+
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::ACH)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/after_pay_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :account_holder
 
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::AFTERPAY
+        super(CheckoutSdk::Common::PaymentSourceType::AFTERPAY)
       end
     end
   end

data/lib/checkout_sdk/payments/source/apm/alma_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :billing_address
 
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::ALMA
+        super(CheckoutSdk::Common::PaymentSourceType::ALMA)
       end
     end
   end

data/lib/checkout_sdk/payments/source/apm/bancontact_source.rb

@@ -17,7 +17,7 @@ module CheckoutSdk
                     :language
 
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::BANCONTACT
+        super(CheckoutSdk::Common::PaymentSourceType::BANCONTACT)
       end
     end
   end

data/lib/checkout_sdk/payments/source/apm/benefit_source.rb

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Payments
     class BenefitSource < PaymentSource
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::BENEFIT
+        super(CheckoutSdk::Common::PaymentSourceType::BENEFIT)
       end
     end
   end

data/lib/checkout_sdk/payments/source/apm/bizum_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute mobile_number
+    #   @return [String]
+    class BizumSource < PaymentSource
+      attr_accessor :mobile_number
+
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::BIZUM)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/blik_source.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Blik payment source for the /payments endpoint.
+    #
+    # When source.type is "blik":
+    #   - currency must be PLN
+    #   - amount must not exceed 5,000,000 (minor unit)
+    #   - reference is limited to 35 characters
+    # For customer-initiated payments, provide the 6-digit BLIK code in
+    # `processing.partner_code`. For merchant-initiated recurring payments,
+    # use either source.type: "id" with a previous source.id, or
+    # source.type: "blik" with `partner_agreement_id`.
+    #
+    # @!attribute id
+    #   @return [String] (response-only) The Checkout.com source identifier
+    #     for a partner agreement created during a Blik recurring payment.
+    # @!attribute partner_agreement_id
+    #   @return [String] The Blik PAYID identifying an external partner
+    #     agreement created with another PSP.
+    class BlikSource < PaymentSource
+      attr_accessor :id,
+                    :partner_agreement_id
+
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::BLIK)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/cv_connect_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :billing_address
 
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::CV_CONNECT
+        super(CheckoutSdk::Common::PaymentSourceType::CV_CONNECT)
       end
     end
   end

data/lib/checkout_sdk/payments/source/apm/eps_source.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :purpose
 
       def initialize
-        super CheckoutSdk::Common::PaymentSourceType::EPS
+        super(CheckoutSdk::Common::PaymentSourceType::EPS)
       end
     end
   end