checkout_sdk 1.12.0 → 2.1.0

data/lib/checkout_sdk/instruments/update/update_sepa_account_holder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # The account holder details of a SEPA instrument being updated.
+    #
+    # account_holder is itself optional, but if you send it then first_name,
+    # last_name and billing_address are all required.
+    #
+    # @!attribute first_name
+    #   @return [String] The first name of the account holder. [Required]
+    # @!attribute last_name
+    #   @return [String] The last name of the account holder. [Required]
+    # @!attribute billing_address
+    #   @return [UpdateSepaBillingAddress] The billing address of the account
+    #     holder. [Required]
+    # @!attribute company_name
+    #   @return [String] The legal name of a registered company that holds the
+    #     account. [Optional] max 50 characters.
+    # @!attribute type
+    #   @return [String] {InstrumentAccountHolderType} The type of account holder.
+    #     [Optional]
+    class UpdateSepaAccountHolder
+      attr_accessor :first_name,
+                    :last_name,
+                    :billing_address,
+                    :company_name,
+                    :type
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_sepa_billing_address.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # The billing address of the account holder of a SEPA instrument being updated.
+    #
+    # Every property is required if billing_address is sent at all.
+    #
+    # @!attribute address_line1
+    #   @return [String] The first line of the address. [Required] max 200 characters.
+    # @!attribute address_line2
+    #   @return [String] The street number. If no number, pass "w/n".
+    #     [Required] max 10 characters.
+    # @!attribute city
+    #   @return [String] The address city. [Required] max 50 characters.
+    #     Note the store variant allows max 35 only.
+    # @!attribute zip
+    #   @return [String] The address zip/postal code. [Required] max 50 characters.
+    #     Note the store variant allows max 16 only.
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country} The two-letter ISO country
+    #     code of the address. [Required] min 2 characters, max 2 characters.
+    class UpdateSepaBillingAddress
+      attr_accessor :address_line1,
+                    :address_line2,
+                    :city,
+                    :zip,
+                    :country
+    end
+  end
+end

data/lib/checkout_sdk/instruments/update/update_sepa_instrument_data.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # The details of the mandate of a SEPA instrument being updated.
+    #
+    # instrument_data is itself optional, but if you send it then account_number,
+    # country, currency and payment_type are all required.
+    #
+    # @!attribute account_number
+    #   @return [String] The International Bank Account Number (IBAN) of the
+    #     account. [Required] min 15 characters, max 34 characters.
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country} The country of the account.
+    #     [Required] min 2 characters, max 2 characters.
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency} The currency of the account.
+    #     [Required] min 3 characters, max 3 characters.
+    # @!attribute payment_type
+    #   @return [String] {SepaPaymentType} The type of payment, recurring or
+    #     regular. [Required] Lowercase, unlike the Bacs equivalent.
+    # @!attribute type
+    #   @return [String] {SepaMandateType} The type of mandate, Core or B2B.
+    #     [Optional]
+    # @!attribute mandate_id
+    #   @return [String] The mandate ID. If a mandate ID is not provided, a new,
+    #     random mandate ID will be generated. [Optional] min 1 character,
+    #     max 35 characters.
+    # @!attribute date_of_signature
+    #   @return [String] The date on which the mandate was signed, in the format
+    #     yyyy-MM-dd. Required if mandate_id is provided. [Optional]
+    #     Format: date - pass a yyyy-MM-dd String, not a DateTime.
+    class UpdateSepaInstrumentData
+      attr_accessor :account_number,
+                    :country,
+                    :currency,
+                    :payment_type,
+                    :type,
+                    :mandate_id,
+                    :date_of_signature
+    end
+  end
+end

data/lib/checkout_sdk/payments/payments.rb

@@ -94,6 +94,25 @@ require 'checkout_sdk/payments/source/apm/cv_connect_source'
 require 'checkout_sdk/payments/source/apm/trustly_source'
 require 'checkout_sdk/payments/source/apm/illicado_source'
 require 'checkout_sdk/payments/source/apm/sepa_source'
+require 'checkout_sdk/payments/source/apm/bacs_source'
+require 'checkout_sdk/payments/source/apm/ach_source_account_type'
+require 'checkout_sdk/payments/source/apm/ach_source_account_holder'
+require 'checkout_sdk/payments/source/apm/sepa_source_billing_address'
+require 'checkout_sdk/payments/source/apm/sepa_source_account_holder'
+require 'checkout_sdk/payments/source/apm/alipay_cn_source'
+require 'checkout_sdk/payments/source/apm/alipay_hk_source'
+require 'checkout_sdk/payments/source/apm/dana_source'
+require 'checkout_sdk/payments/source/apm/gcash_source'
+require 'checkout_sdk/payments/source/apm/kakaopay_source'
+require 'checkout_sdk/payments/source/apm/mobile_pay_source'
+require 'checkout_sdk/payments/source/apm/pay_now_source'
+require 'checkout_sdk/payments/source/apm/tng_source'
+require 'checkout_sdk/payments/source/apm/truemoney_source'
+require 'checkout_sdk/payments/source/apm/twint_source'
+require 'checkout_sdk/payments/source/apm/vipps_source'
+require 'checkout_sdk/payments/source/apm/swish_account_holder'
+require 'checkout_sdk/payments/source/apm/swish_billing_descriptor'
+require 'checkout_sdk/payments/source/apm/swish_source'
 require 'checkout_sdk/payments/source/apm/ach_source'
 require 'checkout_sdk/payments/source/apm/bizum_source'
 require 'checkout_sdk/payments/source/apm/octopus_source'

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

@@ -2,16 +2,27 @@
 
 module CheckoutSdk
   module Payments
+    # An ach payment source.
+    #
     # @!attribute account_type
-    #   @return [CheckoutSdk::Common::AccountType]
+    #   @return [String] {AchSourceAccountType} The type of Direct Debit account.
+    #     [Required] savings, checking or cash. Note this is **not**
+    #     {CheckoutSdk::Common::AccountType}, which declares `current` instead of
+    #     `checking` and is rejected at this position.
     # @!attribute country
-    #   @return [CheckoutSdk::Common::Country]
+    #   @return [String] {CheckoutSdk::Common::Country} The source country.
+    #     [Required] min 2 characters, max 2 characters.
     # @!attribute account_number
-    #   @return [String]
+    #   @return [String] The account number of the Direct Debit account.
+    #     [Required] min 4 characters, max 17 characters.
     # @!attribute bank_code
-    #   @return [String]
+    #   @return [String] The bank code of the Direct Debit account.
+    #     [Required] min 8 characters, max 9 characters.
     # @!attribute account_holder
-    #   @return [CheckoutSdk::Common::AccountHolder]
+    #   @return [AchSourceAccountHolder] The account holder's details. [Required]
+    #     Maps swagger `AccountHolderAch`. A {CheckoutSdk::Common::AccountHolder} or a
+    #     Hash is still accepted, but only the seven properties that schema declares
+    #     are valid at this position.
     class AchSource < PaymentSource
       attr_accessor :account_type,
                     :country,

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The account holder's details on an ACH payment source.
+    #
+    # Maps swagger `AccountHolderAch` exactly. This is deliberately not
+    # {CheckoutSdk::Common::AccountHolder}, which carries 16 properties against the
+    # seven declared here.
+    #
+    # Two nested types are reused rather than redeclared, because their property sets
+    # match: `billing_address` uses {CheckoutSdk::Common::Address}, whose six
+    # properties are exactly the `Address` schema this position references. For
+    # `identification` the reused type carries one property, date_of_expiry, that this
+    # position does not declare - noted on the attribute below.
+    #
+    # @!attribute type
+    #   @return [String] {CheckoutSdk::Common::AccountHolderType} The type of account
+    #     holder. [Required] individual, corporate or government.
+    # @!attribute first_name
+    #   @return [String] The account holder's first name. [Required]
+    # @!attribute last_name
+    #   @return [String] The account holder's last name. [Required]
+    # @!attribute company_name
+    #   @return [String] The account holder's company name. [Optional]
+    # @!attribute billing_address
+    #   @return [CheckoutSdk::Common::Address] The account holder's billing address.
+    #     [Optional]
+    # @!attribute date_of_birth
+    #   @return [String] The account holder's date of birth. [Optional]
+    # @!attribute identification
+    #   @return [CheckoutSdk::Common::AccountHolderIdentification] The account
+    #     holder's identification. [Optional] This position declares only type,
+    #     issuing_country and number - do not set date_of_expiry.
+    class AchSourceAccountHolder
+      attr_accessor :type,
+                    :first_name,
+                    :last_name,
+                    :company_name,
+                    :billing_address,
+                    :date_of_birth,
+                    :identification
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The type of Direct Debit account on an ACH payment source.
+    #
+    # `PaymentRequestAchSource` is the only position in the specification declaring
+    # this set. Two neighbouring types are deliberately different and must not be
+    # substituted:
+    #
+    # - {CheckoutSdk::Common::AccountType} is savings / **current** / cash, and serves
+    #   the bank-account instrument and destination positions. It does not declare
+    #   `checking`, so it cannot express a valid ACH source account type.
+    # - {CheckoutSdk::Instruments::AchAccountType} is savings / checking, and serves
+    #   the stored ACH instrument positions. It does not declare `cash`.
+    module AchSourceAccountType
+      SAVINGS = 'savings'
+      CHECKING = 'checking'
+      CASH = 'cash'
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Alipay CN source.
+    #
+    # The schema declares no properties beyond `type`.
+    class AlipayCnSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::ALIPAY_CN)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Alipay HK source.
+    #
+    # The schema declares no properties beyond `type`.
+    class AlipayHkSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::ALIPAY_HK)
+      end
+    end
+  end
+end

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

@@ -2,6 +2,15 @@
 
 module CheckoutSdk
   module Payments
+    # Alipay Plus source.
+    #
+    # The specification gives each of these wire types its own schema and its own
+    # entry on the `PaymentRequestSource` discriminator, so each also has a dedicated
+    # class: {AlipayPlusSource} for `alipay_plus` itself, plus {AlipayCnSource},
+    # {AlipayHkSource}, {DanaSource}, {GcashSource}, {KakaopaySource},
+    # {TruemoneySource} and {TngSource}. Prefer the dedicated class. The factory
+    # methods below are retained for backward compatibility and produce identical
+    # JSON.
     class AlipayPlusSource < PaymentSource
       # @return [AlipayPlusSource] of type {CheckoutSdk::Common::PaymentSourceType::ALIPAY_PLUS}
       def self.alipay_plus_source

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Bacs Direct Debit source.
+    #
+    # @!attribute id
+    #   @return [String] The Bacs Direct Debit instrument ID. [Required]
+    #     Pattern: ^(src)_(\w{26})$
+    class BacsSource < PaymentSource
+      attr_accessor :id
+
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::BACS)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # DANA source.
+    #
+    # The schema declares no properties beyond `type`.
+    class DanaSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::DANA)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # GCash source.
+    #
+    # The schema declares no properties beyond `type`.
+    class GcashSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::GCASH)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Kakao Pay source.
+    #
+    # The schema declares no properties beyond `type`.
+    class KakaopaySource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::KAKAOPAY)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # MobilePay source.
+    #
+    # The schema declares no properties beyond `type`.
+    class MobilePaySource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::MOBILEPAY)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # PayNow source.
+    #
+    # The schema declares no properties beyond `type`.
+    class PayNowSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::PAYNOW)
+      end
+    end
+  end
+end

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

@@ -2,28 +2,45 @@
 
 module CheckoutSdk
   module Payments
+    # SEPA Direct Debit source.
+    #
     # @!attribute country
-    #   @return [CheckoutSdk::Common::Country]
+    #   @return [String] {CheckoutSdk::Common::Country} The account's country, as an
+    #     ISO 3166-1 alpha-2 code. [Required]
     # @!attribute account_number
-    #   @return [String]
-    # @!attribute bank_code
-    #   @return [String]
+    #   @return [String] The account holder's IBAN. [Required]
     # @!attribute currency
-    #   @return [CheckoutSdk::Common::Currency]
+    #   @return [String] {CheckoutSdk::Common::Currency} The account holder's account
+    #     currency. [Required]
+    # @!attribute account_holder
+    #   @return [SepaSourceAccountHolder] The account holder's personal information.
+    #     [Required] Its billing_address is required, and that address requires all
+    #     five of its properties. A {CheckoutSdk::Common::AccountHolder} or a Hash is
+    #     still accepted, but only the five properties
+    #     `PaymentRequestSEPAV4Source.account_holder` declares are valid here. See
+    #     {SepaSourceAccountHolder#type} for the casing to send.
     # @!attribute mandate_id
-    #   @return [String]
+    #   @return [String] The ID of the mandate. [Optional]
+    # @!attribute mandate_type
+    #   @return [String] {CheckoutSdk::Instruments::SepaMandateType} The type of
+    #     mandate, Core or B2B. [Optional]
     # @!attribute date_of_signature
-    #   @return [String]
-    # @!attribute account_holder
-    #   @return [CheckoutSdk::Common::AccountHolder]
+    #   @return [String] The date the mandate was signed, in the format yyyy-MM-dd.
+    #     [Optional]
+    # @!attribute bank_code
+    #   @return [String] Not declared by PaymentRequestSEPAV4Source. No SEPA schema
+    #     in the specification declares a bank code, and the SEPA source is
+    #     identified by IBAN through account_number. Retained for
+    #     retro-compatibility purposes only. Possibly an obsoleted field.
     class SepaSource < PaymentSource
       attr_accessor :country,
                     :account_number,
-                    :bank_code,
                     :currency,
+                    :account_holder,
                     :mandate_id,
+                    :mandate_type,
                     :date_of_signature,
-                    :account_holder
+                    :bank_code
 
       def initialize
         super(CheckoutSdk::Common::PaymentSourceType::SEPA)

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The account holder's personal information on a SEPA payment source.
+    #
+    # Maps the `account_holder` object of swagger `PaymentRequestSEPAV4Source`
+    # exactly. This is deliberately not {CheckoutSdk::Common::AccountHolder}, which
+    # carries 16 properties against the five declared here.
+    #
+    # @!attribute billing_address
+    #   @return [SepaSourceBillingAddress] The account holder's billing address.
+    #     [Required] All five of its properties are required.
+    # @!attribute first_name
+    #   @return [String] The account holder's first name. [Optional]
+    #     max 50 characters.
+    # @!attribute last_name
+    #   @return [String] The account holder's last name. [Optional]
+    #     max 50 characters.
+    # @!attribute company_name
+    #   @return [String] The account holder's company name. [Optional]
+    #     max 50 characters.
+    # @!attribute type
+    #   @return [String] {InstrumentAccountHolderType} The type of account holder.
+    #     [Optional] Send this lowercase (individual / corporate). The specification
+    #     declares it capitalized at this one position, but every other
+    #     account-holder-type position declares it lowercase and every other
+    #     Checkout.com SDK sends lowercase. Pending confirmation from the API owners.
+    class SepaSourceAccountHolder
+      attr_accessor :billing_address,
+                    :first_name,
+                    :last_name,
+                    :company_name,
+                    :type
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The account holder's billing address on a SEPA payment source.
+    #
+    # Every property is required. This is deliberately not
+    # {CheckoutSdk::Common::Address}, which also declares `state` - a property this
+    # position does not accept.
+    #
+    # @!attribute address_line1
+    #   @return [String] The account holder's street name. [Required]
+    # @!attribute address_line2
+    #   @return [String] The account holder's street number. [Required]
+    #     max 10 characters.
+    # @!attribute city
+    #   @return [String] The account holder's city. [Required] max 35 characters.
+    # @!attribute zip
+    #   @return [String] The account holder's zip code. [Required] max 16 characters.
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country} The account holder's country,
+    #     as an ISO 3166-1 alpha-2 code. [Required] max 2 characters.
+    class SepaSourceBillingAddress
+      attr_accessor :address_line1,
+                    :address_line2,
+                    :city,
+                    :zip,
+                    :country
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Information about the account holder's details on a Swish payment source.
+    #
+    # @!attribute first_name
+    #   @return [String] The account holder's first name. [Required]
+    #     max 50 characters.
+    # @!attribute last_name
+    #   @return [String] The account holder's last name. [Required]
+    #     max 50 characters.
+    class SwishAccountHolder
+      attr_accessor :first_name,
+                    :last_name
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Payment billing descriptor on a Swish payment source.
+    #
+    # @!attribute name
+    #   @return [String] A description for the payment, which displays on the
+    #     customer's statement. [Required] max 120 characters.
+    class SwishBillingDescriptor
+      attr_accessor :name
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Swish source.
+    #
+    # @!attribute payment_country
+    #   @return [String] The 2-letter ISO country code of the country in which the
+    #     payment instrument is issued or operated. [Required] The schema declares
+    #     one value only: SE. min 2 characters, max 2 characters.
+    # @!attribute account_holder
+    #   @return [SwishAccountHolder] Information about the account holder's details.
+    #     [Required]
+    # @!attribute billing_descriptor
+    #   @return [SwishBillingDescriptor] Payment billing descriptor. [Optional]
+    class SwishSource < PaymentSource
+      # The only payment_country the schema declares.
+      SWEDEN = 'SE'
+
+      attr_accessor :payment_country,
+                    :account_holder,
+                    :billing_descriptor
+
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::SWISH)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Touch n Go source.
+    #
+    # The schema declares no properties beyond `type`.
+    class TngSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::TNG)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # TrueMoney source.
+    #
+    # The schema declares no properties beyond `type`.
+    class TruemoneySource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::TRUEMONEY)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # TWINT source.
+    #
+    # The schema declares no properties beyond `type`.
+    class TwintSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::TWINT)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Vipps source.
+    #
+    # The schema declares no properties beyond `type`.
+    class VippsSource < PaymentSource
+      def initialize
+        super(CheckoutSdk::Common::PaymentSourceType::VIPPS)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/void_request.rb

@@ -2,12 +2,16 @@
 
 module CheckoutSdk
   module Payments
+    # @!attribute amount
+    #   @return [Integer] the amount to void, min 0, max 9999999999.
+    #     If not specified, the full payment amount is voided.
     # @!attribute reference
     #   @return [String]
     # @!attribute metadata
     #   @return [Hash{String => Object}]
     class VoidRequest
-      attr_accessor :reference,
+      attr_accessor :amount,
+                    :reference,
                     :metadata
     end
   end