checkout_sdk 2.7.1 → 2.8.0

data/lib/checkout_sdk/payments/dunning_retry_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Configuration of Dunning retries.
+    #
+    # @!attribute enabled
+    #   @return [TrueClass, FalseClass] [Required] Indicates if Checkout.com retries the payment when it's declined
+    #     with a supported decline code.
+    # @!attribute max_attempts
+    #   @return [Integer] [Optional] The maximum number of authorization retry attempts, excluding the initial
+    #     authorization. Minimum 1, maximum 15. Default 6.
+    # @!attribute end_after_days
+    #   @return [Integer] [Optional] The maximum number of days between the initial request and the final retry
+    #     attempt. Minimum 1, maximum 60. Default 30.
+    class DunningRetryRequest
+      attr_accessor :enabled,
+                    :max_attempts,
+                    :end_after_days
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payment_instruction.rb

@@ -2,7 +2,16 @@
 
 module CheckoutSdk
   module Payments
+    # Details about the payment instruction of a hosted payments session.
+    # Hosted payments use purpose only.
+    #
     # @!attribute purpose
+    #   The purpose of the payment. This field might be required for AFT transactions depending on the
+    #   card's issuer_country.
+    #   [Optional]
+    #   Enum: "donations" "education" "emergency_need" "expatriation" "family_support" "financial_services"
+    #   "gifts" "income" "insurance" "investment" "it_services" "leisure" "loan_payment" "medical_treatment"
+    #   "other" "pension" "royalties" "savings" "travel_and_tourism"
     #   @return [String] {PaymentPurposeType}
     class HostedPaymentInstruction
       attr_accessor :purpose

data/lib/checkout_sdk/payments/hosted/hosted_payments_session.rb

@@ -5,67 +5,78 @@ require 'checkout_sdk/payments/payment_type'
 module CheckoutSdk
   module Payments
     # @!attribute currency
-    #   @return [String] {CheckoutSdk::Common::Currency}
+    #   @return [String] {CheckoutSdk::Common::Currency} [Required] The three-letter ISO currency code of the payment
     # @!attribute billing
-    #   @return [BillingInformation]
+    #   @return [BillingInformation] [Required] The billing details
     # @!attribute success_url
-    #   @return [String]
+    #   @return [String] [Required] For redirect payment methods, this overrides the default success redirect URL
+    #     configured on your account
     # @!attribute cancel_url
-    #   @return [String]
+    #   @return [String] [Required] The URL to which the customer should be directed if they cancel the payment
     # @!attribute failure_url
-    #   @return [String]
+    #   @return [String] [Required] For redirect payment methods, this overrides the default failure redirect URL
+    #     configured on your account
     # @!attribute amount
-    #   @return [Integer]
+    #   @return [Integer] [Optional] The payment amount. Minimum 0.
     # @!attribute payment_type
-    #   @return [String] {PaymentType}
+    #   @return [String] {PaymentType} [Optional] This must be specified for card payments where the cardholder is not
+    #     present (i.e., recurring or mail order / telephone order)
     # @!attribute payment_ip
-    #   @return [String]
+    #   @return [String] [Optional] The Customers IP address. Only IPv4 and IPv6 addresses are accepted.
+    #   @deprecated The Customers IP address is deprecated in the API reference. Will be removed in the next
+    #     major version.
     # @!attribute billing_descriptor
-    #   @return [BillingDescriptor]
+    #   @return [BillingDescriptor] [Optional] An optional description that is displayed on the customer's statement
+    #     identifying a purchase
     # @!attribute reference
-    #   @return [String]
+    #   @return [String] [Optional] A reference you can use to identify the payment.
     # @!attribute description
-    #   @return [String]
+    #   @return [String] [Optional] A description of the payment
     # @!attribute display_name
-    #   @return [String]
+    #   @return [String] [Optional] The merchant name to display to customers on the checkout page.
     # @!attribute processing_channel_id
-    #   @return [String]
+    #   @return [String] [Optional] The processing channel to be used for the payment
     # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] [Optional] The sub-entities that the payment is being
+    #     processed on behalf of
     # @!attribute customer
-    #   @return [CheckoutSdk::Common::CustomerRequest]
+    #   @return [CheckoutSdk::Common::CustomerRequest] [Optional] The customer's details
     # @!attribute shipping
-    #   @return [ShippingDetails]
+    #   @return [ShippingDetails] [Optional] The address any products are being sent to.
     # @!attribute recipient
-    #   @return [PaymentRecipient]
+    #   @return [PaymentRecipient] [Optional] Information about the recipient of the payment's funds.
     # @!attribute processing
-    #   @return [ProcessingSettings]
+    #   @return [ProcessingSettings] [Optional] Use the processing object to influence or override the data sent
+    #     during card processing
     # @!attribute allow_payment_methods
-    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)] [Optional] Specifies which payment method options to
+    #     present to the customer.
     # @!attribute disabled_payment_methods
-    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)] [Optional] Specifies which payment method options to
+    #     not present to the customer.
     # @!attribute products
-    #   @return [Array(CheckoutSdk::Common::Product)]
+    #   @return [Array(CheckoutSdk::Common::Product)] [Optional] Contains details about the products in the order.
     # @!attribute risk
-    #   @return [RiskRequest]
+    #   @return [RiskRequest] [Optional] Configures the risk assessment performed during payment processing.
     # @!attribute customer_retry
-    #   @return [PaymentRetryRequest]
+    #   @return [CheckoutSdk::Common::CustomerRetry] [Optional] Configures the parameters for customer retries
+    #     performed by the customer on the checkout page.
     # @!attribute sender
-    #   @return [CheckoutSdk::Payments::Sender]
+    #   @return [CheckoutSdk::Payments::Sender] [Optional] The sender of the payment.
     # @!attribute metadata
-    #   @return [Hash(String=>Object)]
+    #   @return [Hash(String=>Object)] [Optional] Allows you to store additional information about the transaction.
     # @!attribute locale
-    #   @return [String] {LocaleType}
+    #   @return [String] {LocaleType} [Optional] Creates a translated version of the page in the specified language
     # @!attribute three_ds
-    #   @return [ThreeDSRequest]
+    #   @return [ThreeDSRequest] [Optional] Information required for 3D Secure payments
     # @!attribute capture
-    #   @return [TrueClass, FalseClass]
+    #   @return [TrueClass, FalseClass] [Optional] Whether to capture the payment (if applicable).
     # @!attribute capture_on
-    #   @return [Time]
+    #   @return [Time] [Optional] A timestamp (ISO 8601 code) that determines when the payment should be captured.
     # @!attribute instruction
-    #   @return [HostedPaymentInstruction]
+    #   @return [HostedPaymentInstruction] [Optional] Details about the payment instruction.
     # @!attribute payment_method_configuration
-    #   @return [PaymentMethodConfiguration]
+    #   @return [PaymentMethodConfiguration] [Optional] Configuration options for specific payment methods.
     # @!attribute payment_plan
     #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
     #     To be used when the payment_type is Recurring.

data/lib/checkout_sdk/payments/instruction_remittance.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # The remittance details of a bank payout instruction, used for reconciliation.
+    #
+    # @!attribute reference
+    #   A merchant-provided reference for the remittance payment.
+    #   This value is used for payment reconciliation and is reviewed by our banking partner.
+    #   [Optional]
+    #   max 80 characters
+    #   @return [String]
+    class InstructionRemittance
+      attr_accessor :reference
+    end
+  end
+end

data/lib/checkout_sdk/payments/instruction_scheme.rb

@@ -2,7 +2,12 @@
 
 module CheckoutSdk
   module Payments
+    # The payment scheme type of a bank payout instruction.
+    # Enum: "local" "instant"
     class InstructionScheme
+      # @deprecated Not in the request schema, which only lists local and instant; still returned in
+      #   PayoutDetails (instruction.scheme). Retained for backwards compatibility and will be removed in the
+      #   next major version. There is no replacement.
       SWIFT = 'swift'
       LOCAL = 'local'
       INSTANT = 'instant'

data/lib/checkout_sdk/payments/links/payment_link.rb

@@ -5,64 +5,83 @@ require 'checkout_sdk/payments/payment_type'
 module CheckoutSdk
   module Payments
     # @!attribute amount
-    #   @return [Integer]
+    #   @return [Integer] [Required] The payment amount.
     # @!attribute currency
-    #   @return [String] {CheckoutSdk::Common::Currency}
+    #   @return [String] {CheckoutSdk::Common::Currency} [Required] The three-letter ISO currency code of the
+    #     payment. The `currency` and `billing.address.country` fields determine which payment methods are shown on the
+    #     payment page.
     # @!attribute payment_type
-    #   @return [String] {PaymentType}
+    #   @return [String] {PaymentType} [Optional] This must be specified for card payments where the cardholder is not
+    #     present (i.e., recurring or mail order / telephone order). Default: "Regular".
     # @!attribute payment_ip
-    #   @return [String]
+    #   @return [String] [Optional] The Customers IP address. Only IPv4 and IPv6 addresses are accepted.
+    #   @deprecated The Customers IP address is deprecated in the API reference. Will be removed in the next
+    #     major version.
     # @!attribute billing_descriptor
-    #   @return [BillingDescriptor]
+    #   @return [BillingDescriptor] [Optional] An optional description that is displayed on the customer's statement
+    #     identifying a purchase
     # @!attribute reference
-    #   @return [String]
+    #   @return [String] [Optional] A reference you can use to identify the payment.
     # @!attribute description
-    #   @return [String]
+    #   @return [String] [Optional] A description of the payment.
     # @!attribute display_name
-    #   @return [String]
+    #   @return [String] [Optional] The merchant name to display to customers on the checkout page.
     # @!attribute processing_channel_id
-    #   @return [String] - Not available on Previous.
+    #   @return [String] [Optional] The processing channel to use for the payment. This field is required if you
+    #     have more than one processing channel associated with your API key.
     # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] [Optional] The sub-entities that the payment is being
+    #     processed on behalf of.
     # @!attribute expires_in
-    #   @return [Integer]
+    #   @return [Integer] [Optional] The time for which the link remains valid, in seconds. Minimum 1, maximum 5184000.
+    #     Default: 86400.
     # @!attribute customer
-    #   @return [CheckoutSdk::Common::CustomerRequest]
+    #   @return [CheckoutSdk::Common::CustomerRequest] [Optional] The customer's details
     # @!attribute shipping
-    #   @return [ShippingDetails]
+    #   @return [ShippingDetails] [Optional] The address any products are being sent to.
     # @!attribute billing
-    #   @return [BillingInformation]
+    #   @return [BillingInformation] [Required] The billing details.
     # @!attribute recipient
-    #   @return [PaymentRecipient]
+    #   @return [PaymentRecipient] [Optional] Information about the recipient of the payment's funds.
     # @!attribute processing
-    #   @return [ProcessingSettings]
+    #   @return [ProcessingSettings] [Optional] Use the processing object to influence or override the data sent
+    #     during card processing
     # @!attribute allow_payment_methods
-    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)] [Optional] Specifies which payment method options to
+    #     present to the customer.
     # @!attribute disabled_payment_methods
-    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)] [Optional] Specifies which payment method options to
+    #     not present to the customer.
     # @!attribute products
-    #   @return [Array(CheckoutSdk::Common::Product)]
+    #   @return [Array(CheckoutSdk::Common::Product)] [Optional] Contains details about the products in the order.
     # @!attribute metadata
-    #   @return [Hash(String=>Object)]
+    #   @return [Hash(String=>Object)] [Optional] Allows you to store additional information about the transaction.
     # @!attribute three_ds
-    #   @return [ThreeDSRequest]
+    #   @return [ThreeDSRequest] [Optional] Information required for 3D Secure payments.
     # @!attribute risk
-    #   @return [RiskRequest]
+    #   @return [RiskRequest] [Optional] Configures the risk assessment performed during payment processing.
     # @!attribute customer_retry
-    #   @return [CheckoutSdk::Common::CustomerRetry]
+    #   @return [CheckoutSdk::Common::CustomerRetry] [Optional] Configures the parameters for customer retries
+    #     performed by the customer on the checkout page.
     # @!attribute sender
-    #   @return [CheckoutSdk::Payments::Sender]
+    #   @return [CheckoutSdk::Payments::Sender] [Optional] The sender of the payment.
     # @!attribute return_url
-    #   @return [String]
+    #   @return [String] [Optional] If provided, the success page will include a button that redirects your customer
+    #     to the provided URL.
     # @!attribute locale
-    #   @return [String]
+    #   @return [String] [Optional] Creates a translated version of the page in the specified language.
+    #     Default: "en-GB".
     # @!attribute capture
-    #   @return [TrueClass, FalseClass]
+    #   @return [TrueClass, FalseClass] [Optional] Whether to capture the payment (if applicable).
     # @!attribute capture_on
-    #   @return [Time]
+    #   @return [Time] [Optional] A timestamp (ISO 8601 code) that determines when the payment should be captured.
     # @!attribute payment_plan
     #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
     #     To be used when the payment_type is Recurring.
+    # @!attribute instruction
+    #   @return [HostedPaymentInstruction] [Optional] Details about the payment instruction.
+    # @!attribute payment_method_configuration
+    #   @return [PaymentMethodConfiguration] [Optional] Configuration options for specific payment methods.
     # @!attribute authorization_type
     #   @return [String] [Optional] {AuthorizationType} Enum: "Final" "Estimated". Default: "Final".
     class PaymentLink
@@ -95,7 +114,9 @@ module CheckoutSdk
                     :capture,
                     :capture_on,
                     :payment_plan,
-                    :authorization_type
+                    :authorization_type,
+                    :instruction,
+                    :payment_method_configuration
 
       def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
         @payment_type = payment_type

data/lib/checkout_sdk/payments/payment_instruction.rb

@@ -2,27 +2,74 @@
 
 module CheckoutSdk
   module Payments
+    # Additional details about the instruction of a payment, a payout or an unreferenced refund.
+    # Card payouts and unreferenced refunds use purpose and funds_transfer_type; bank payouts use scheme and
+    # remittance; regular payments (PaymentRequest) use purpose only.
+    #
     # @!attribute purpose
-    #   @return [String]
+    #   The purpose of the payment, card payout or unreferenced refund.
+    #   For card payouts, required if the card's issuer_country is one of AR, BD, CL, CO, EG, IN, MX or SA.
+    #   For unreferenced refunds, required if the card's issuer_country is one of AR, BD, CL, CO, EG, IN or MX.
+    #   For regular payments, it might be required for AFT transactions depending on the card's issuer_country.
+    #   [Optional]
+    #   Enum: "family_support" "expatriation" "travel_and_tourism" "education" "medical_treatment"
+    #   "emergency_need" "leisure" "savings" "gifts" "donations" "financial_services" "it_services"
+    #   "investment" "insurance" "loan_payment" "pension" "royalties" "other" "income"
+    #   @return [String] {PaymentPurposeType}
     # @!attribute charge_bearer
+    #   The charge bearer of a bank payout.
+    #   [Optional]
+    #   @deprecated Not in the request schema; still returned in PayoutDetails (instruction.charge_bearer).
+    #     Retained for backwards compatibility and will be removed in the next major version. There is no
+    #     replacement.
     #   @return [String] {ChargeBearer}
     # @!attribute repair
+    #   Whether the bank payout may be repaired.
+    #   [Optional]
+    #   @deprecated Not in the request schema; still returned in PayoutDetails (instruction.repair).
+    #     Retained for backwards compatibility and will be removed in the next major version. There is no
+    #     replacement.
     #   @return [TrueClass, FalseClass]
     # @!attribute scheme
+    #   An option to restrict the payment scheme type of a bank payout, when not available payouts will fail.
+    #   [Optional]
+    #   Enum: "local" "instant"
     #   @return [String] {InstructionScheme}
+    # @!attribute remittance
+    #   The remittance details of a bank payout, used for reconciliation.
+    #   [Optional]
+    #   @return [InstructionRemittance]
     # @!attribute quote_id
+    #   The FX quote identifier of a bank payout.
+    #   [Optional]
+    #   @deprecated Not in the request schema; still returned in PayoutDetails (instruction.quote_id).
+    #     Retained for backwards compatibility and will be removed in the next major version. There is no
+    #     replacement.
     #   @return [String]
     # @!attribute skip_expiry
+    #   [Optional]
+    #   @deprecated Not in any schema of the specification. Retained for backwards compatibility and will be
+    #     removed in the next major version. There is no replacement.
     #   @return [TrueClass, FalseClass]
     # @!attribute funds_transfer_type
+    #   The funds transfer type code for the type of card payout you're performing.
+    #   You can only use codes that have been assigned to you by the card schemes and Checkout.com, based
+    #   on your business case and requirements. If you have only been assigned one funds transfer type
+    #   code, this field is optional. For unreferenced refunds it is required if
+    #   processing.processing_speed is fast: use MI for Visa and C60 for Mastercard.
+    #   [Required] for card payouts, [Optional] for unreferenced refunds
     #   @return [String]
     # @!attribute mvv
+    #   [Optional]
+    #   @deprecated Not in any schema of the specification. Retained for backwards compatibility and will be
+    #     removed in the next major version. There is no replacement.
     #   @return [String]
     class PaymentInstruction
       attr_accessor :purpose,
                     :charge_bearer,
                     :repair,
                     :scheme,
+                    :remittance,
                     :quote_id,
                     :skip_expiry,
                     :funds_transfer_type,

data/lib/checkout_sdk/payments/payment_request.rb

@@ -62,7 +62,7 @@ module CheckoutSdk
     # @!attribute items
     #   @return [Array(Product)]
     # @!attribute retry
-    #   @return [PaymentRetryRequest]
+    #   @return [PaymentRetryRequest] [Optional] Configuration of asynchronous retries.
     # @!attribute metadata
     #   @return [Hash{String => Object}]
     # @!attribute instruction

data/lib/checkout_sdk/payments/payment_retry_request.rb

@@ -2,16 +2,18 @@
 
 module CheckoutSdk
   module Payments
+    # Configuration of asynchronous retries (POST /payments).
+    #
     # @!attribute enabled
-    #   @return [TrueClass, FalseClass]
-    # @!attribute max_attempts
-    #   @return [Integer]
-    # @!attribute end_after_days
-    #   @return [Integer]
+    #   @return [TrueClass, FalseClass] [Required] Indicates whether asynchronous retries are enabled for the payment.
+    # @!attribute dunning
+    #   @return [DunningRetryRequest] [Optional] Configuration of asynchronous Dunning retries.
+    # @!attribute downtime
+    #   @return [DowntimeRetryRequest] [Optional] Configuration of asynchronous Downtime retries.
     class PaymentRetryRequest
       attr_accessor :enabled,
-                    :max_attempts,
-                    :end_after_day
+                    :dunning,
+                    :downtime
     end
   end
 end

data/lib/checkout_sdk/payments/payment_segment.rb

@@ -2,11 +2,22 @@
 
 module CheckoutSdk
   module Payments
+    # The dimension details about business segment for payment request. At least one dimension required.
+    #
     # @!attribute brand
+    #   The brand of business segment.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     # @!attribute business_category
+    #   The category of business segment.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     # @!attribute market
+    #   The market of business segment.
+    #   [Optional]
+    #   max 50 characters
     #   @return [String]
     class PaymentSegment
       attr_accessor :brand,

data/lib/checkout_sdk/payments/payment_type.rb

@@ -2,11 +2,14 @@
 
 module CheckoutSdk
   module Payments
+    # The payment type of a payment request.
+    # Enum: "Regular" "Recurring" "MOTO" "Installment" "PayLater" "Unscheduled"
     module PaymentType
       REGULAR = 'Regular'
       RECURRING = 'Recurring'
-      MOTO = 'Moto'
+      MOTO = 'MOTO'
       INSTALLMENT = 'Installment'
+      PAY_LATER = 'PayLater'
       UNSCHEDULED = 'Unscheduled'
     end
   end

data/lib/checkout_sdk/payments/payments.rb

@@ -5,6 +5,10 @@ require 'checkout_sdk/payments/passenger'
 require 'checkout_sdk/payments/authorization_request'
 require 'checkout_sdk/payments/d_local_processing_settings'
 require 'checkout_sdk/payments/payout_request'
+require 'checkout_sdk/payments/unreferenced_refund_request'
+require 'checkout_sdk/payments/card_payout_item'
+require 'checkout_sdk/payments/card_payout_processing'
+require 'checkout_sdk/payments/payment_segment'
 require 'checkout_sdk/payments/user_action'
 require 'checkout_sdk/payments/three_ds_request'
 require 'checkout_sdk/payments/product_type'
@@ -16,6 +20,7 @@ require 'checkout_sdk/payments/payer'
 require 'checkout_sdk/payments/authorization_type'
 require 'checkout_sdk/payments/os_type'
 require 'checkout_sdk/payments/payment_instruction'
+require 'checkout_sdk/payments/instruction_remittance'
 require 'checkout_sdk/payments/payment_method_details'
 require 'checkout_sdk/payments/refund_request'
 require 'checkout_sdk/payments/payments_search_request'
@@ -42,6 +47,9 @@ require 'checkout_sdk/payments/shipping_preference'
 require 'checkout_sdk/payments/exemption'
 require 'checkout_sdk/payments/three_ds_flow_type'
 require 'checkout_sdk/payments/void_request'
+require 'checkout_sdk/payments/dunning_retry_request'
+require 'checkout_sdk/payments/downtime_retry_request'
+require 'checkout_sdk/payments/payment_retry_request'
 require 'checkout_sdk/payments/payment_request'
 require 'checkout_sdk/payments/processing_settings'
 require 'checkout_sdk/payments/processing_data'
@@ -137,6 +145,7 @@ require 'checkout_sdk/payments/sender/sender_information'
 
 # Destination
 require 'checkout_sdk/payments/destination/destination'
+require 'checkout_sdk/payments/destination/network_token_destination'
 require 'checkout_sdk/payments/destination/token_destination'
 require 'checkout_sdk/payments/destination/bank_account_destination'
 require 'checkout_sdk/payments/destination/card_destination'
@@ -240,6 +249,7 @@ require 'checkout_sdk/payments/setups/payment_setup_device_client'
 require 'checkout_sdk/payments/setups/payment_setup_device_os'
 require 'checkout_sdk/payments/setups/payment_setup_payment_method_initialization'
 require 'checkout_sdk/payments/setups/payment_setup_payment_method_status'
+require 'checkout_sdk/payments/setups/payment_setup_payment_type'
 require 'checkout_sdk/payments/setups/stablecoin_payment_method'
 require 'checkout_sdk/payments/setups/payment_setups_client'
 

data/lib/checkout_sdk/payments/payments_client.rb

@@ -27,6 +27,16 @@ module CheckoutSdk
                                idempotency_key)
       end
 
+      # @param [Hash, UnreferencedRefundRequest] unreferenced_refund_request
+      # @param [String, nil] idempotency_key
+      # @return [Hash]
+      def request_unreferenced_refund(unreferenced_refund_request, idempotency_key = nil)
+        api_client.invoke_post(PAYMENTS_PATH,
+                               sdk_authorization,
+                               unreferenced_refund_request,
+                               idempotency_key)
+      end
+
       # @param [String] payment_id
       # @param [Hash, CaptureRequest] capture_request
       # @param [String, nil] idempotency_key

data/lib/checkout_sdk/payments/payout_billing_descriptor.rb

@@ -2,7 +2,17 @@
 
 module CheckoutSdk
   module Payments
+    # The billing descriptor of a bank payout. Beneficiary banks typically construct the billing descriptor
+    # using the billing descriptor reference and sender information. For direct sellers, the sender is
+    # typically your entity's legal company name. If the ultimate sender is provided, then it is the values
+    # of the Sender object.
+    #
     # @!attribute reference
+    #   The reference shown on the beneficiary's bank statement. The length varies per beneficiary bank;
+    #   in general, fewer than 11 characters are recommended. References are not supported in the US.
+    #   [Required]
+    #   min 11 characters
+    #   max 15 characters
     #   @return [String]
     class PayoutBillingDescriptor
       attr_accessor :reference

data/lib/checkout_sdk/payments/payout_request.rb

@@ -2,26 +2,80 @@
 
 module CheckoutSdk
   module Payments
+    # A card payout or bank payout request, sent to POST /payments.
+    #
     # @!attribute source
+    #   The source of the payout. For bank payouts, the source from which the payout is funded.
+    #   [Required]
     #   @return [PayoutSource]
     # @!attribute destination
+    #   The destination of the payout.
+    #   You can encrypt this field by using the Cko-Encryption-Key-Id and Cko-Encrypted-Properties headers.
+    #   Card payouts take {CardDestination}, {NetworkTokenDestination}, {IdDestination} or {TokenDestination};
+    #   bank payouts take {IdDestination} or {BankAccountDestination}.
+    #   [Required]
     #   @return [Destination]
     # @!attribute amount
+    #   The amount to pay out, in minor units.
+    #   [Optional] for card payouts, [Required] for bank payouts
+    #   min 0
     #   @return [Integer]
     # @!attribute currency
+    #   The three-letter ISO 4217 code for the currency you want to pay out to the recipient.
+    #   For bank payouts, it should match the currency of the destination account.
+    #   [Required]
+    #   min 3 characters, max 3 characters for bank payouts
     #   @return [String] {CheckoutSdk::Common::Currency}
     # @!attribute reference
+    #   A custom reference to identify the payout. For example, an order number.
+    #   [Optional]
+    #   max 50 characters for card payouts
     #   @return [String]
     # @!attribute billing_descriptor
+    #   The billing descriptor for bank payouts. Beneficiary banks typically construct it using the
+    #   billing descriptor reference and the sender information.
+    #   [Required] for bank payouts, not used by card payouts
     #   @return [PayoutBillingDescriptor]
     # @!attribute sender
+    #   The sender of the payout. Required for money transfer card payouts. For bank payouts, the
+    #   ultimate sender of the payout, that is, your customer; not supported for Platform or Direct
+    #   Seller Checkout.com clients.
+    #   [Optional]
     #   @return [Sender]
     # @!attribute instruction
+    #   Additional details about the payout instruction.
+    #   [Required] for card payouts, [Optional] for bank payouts
     #   @return [PaymentInstruction]
     # @!attribute processing_channel_id
+    #   The unique identifier for the processing channel.
+    #   [Required]
+    #   ^(pc)_(\w{26})$
+    #   29 characters (min 29, max 29) for card payouts only
     #   @return [String]
     # @!attribute metadata
+    #   Stores additional information about the transaction with custom fields. Card payouts only.
+    #   [Optional]
     #   @return [Hash{String => Object}]
+    # @!attribute segment
+    #   The dimension details about business segment for payment request. At least one dimension required.
+    #   [Optional]
+    #   @return [PaymentSegment]
+    # @!attribute items
+    #   The order's line items. Card payouts only.
+    #   [Optional]
+    #   @return [Array(CardPayoutItem)]
+    # @!attribute previous_payment_id
+    #   The identifier of an existing payment from the recurring series, if the payout is a recurring
+    #   payment that uses stored card details. If the card payout is linked to a previous Account
+    #   Funding Transaction (AFT), include the previous payment's ID when Checkout.com processed the
+    #   AFT, or the scheme's transaction ID when another payment service provider processed it.
+    #   Card payouts only.
+    #   [Optional]
+    #   @return [String]
+    # @!attribute processing
+    #   Information related to the processing of the payout. Card payouts only.
+    #   [Optional]
+    #   @return [CardPayoutProcessing]
     class PayoutRequest
       attr_accessor :source,
                     :destination,
@@ -32,7 +86,11 @@ module CheckoutSdk
                     :sender,
                     :instruction,
                     :processing_channel_id,
-                    :metadata
+                    :metadata,
+                    :segment,
+                    :items,
+                    :previous_payment_id,
+                    :processing
     end
   end
 end