genesis_ruby 0.2.4 → 0.2.5

data/lib/genesis_ruby/api/requests/financial/cards/payout.rb

@@ -0,0 +1,72 @@
+require 'genesis_ruby/api/requests/base/financials/credit_card'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Cards
+          # Payouts are credits without a reference transaction and as such are highly regulated
+          # and need specific gateway terminal configuration
+          class Payout < Requests::Base::Financials::CreditCard
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::BirthDateAttributes
+            include Mixins::Requests::DigitalAssetTypeAttributes
+            include Mixins::Requests::DocumentAttributes
+            include Mixins::Requests::Financial::Cards::FxRateAttributes
+            include Mixins::Requests::Financial::CryptoAttributes
+            include Mixins::Requests::Financial::CustomerIdentificationAttributes
+            include Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Mixins::Requests::Financial::GamingAttributes
+            include Mixins::Requests::Financial::MotoAttributes
+            include Mixins::Requests::Financial::PurposeOfPaymentAttributes
+            include Mixins::Requests::Financial::SourceOfFundsAttributes
+
+            protected
+
+            # Payout Transaction Type
+            def transaction_type
+              GenesisRuby::Api::Constants::Transactions::PAYOUT
+            end
+
+            # Payout Field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[card_holder card_number expiration_month expiration_year]
+
+              field_value_dependencies.merge! required_tokenization_fields_conditional
+            end
+
+            # Payout request structure
+            def payment_transaction_structure # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              super.delete(:credential_on_file_settlement_date)
+              super.delete(:scheme_tokenized)
+
+              super.merge(
+                source_of_funds_attributes_structure,
+                {
+                  gaming:                    gaming,
+                  moto:                      moto,
+                  crypto:                    crypto,
+                  digital_asset_type:        digital_asset_type,
+                  purpose_of_payment:        purpose_of_payment,
+                  customer_email:            customer_email,
+                  customer_phone:            customer_phone,
+                  birth_date:                birth_date,
+                  document_id:               document_id,
+                  fx_rate_id:                fx_rate_id,
+                  billing_address:           billing_address_parameters_structure,
+                  shipping_address:          shipping_address_parameters_structure,
+                  customer_identification:   customer_identification_attributes_structure,
+                  dynamic_descriptor_params: dynamic_descriptor_structure
+                }
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/cards/sale.rb

@@ -9,6 +9,7 @@ module GenesisRuby
           class Sale < Requests::Base::Financials::CreditCard
 
             include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DigitalAssetTypeAttributes
             include Mixins::Requests::DocumentAttributes
             include Mixins::Requests::Financial::Business::BusinessAttributes
             include Mixins::Requests::Financial::Cards::FxRateAttributes
@@ -70,7 +71,8 @@ module GenesisRuby
                 travel:                     travel_data_attributes_structure,
                 funding:                    funding_attributes_structure,
                 installment_plan_id:        installment_plan_id,
-                installment_plan_reference: installment_plan_reference
+                installment_plan_reference: installment_plan_reference,
+                digital_asset_type:         digital_asset_type
               )
             end
 

data/lib/genesis_ruby/api/requests/financial/cards/sale3d.rb

@@ -9,6 +9,7 @@ module GenesisRuby
           class Sale3d < Requests::Base::Financials::CreditCard
 
             include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::DigitalAssetTypeAttributes
             include Mixins::Requests::DocumentAttributes
             include Mixins::Requests::Financial::AsyncAttributes
             include Mixins::Requests::Financial::Business::BusinessAttributes
@@ -85,7 +86,8 @@ module GenesisRuby
                 travel:                     travel_data_attributes_structure,
                 funding:                    funding_attributes_structure,
                 installment_plan_id:        installment_plan_id,
-                installment_plan_reference: installment_plan_reference
+                installment_plan_reference: installment_plan_reference,
+                digital_asset_type:         digital_asset_type
               )
             end
 

data/lib/genesis_ruby/api/requests/financial/crypto/bit_pay/payout.rb

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Crypto
+          module BitPay
+            # BitPay Payout is a crypto currency payout method where merchants are requesting payouts
+            # in FIAT currency and the funds are transferred in Bitcoin equivalent to a crypto wallet address
+            class Payout < Requests::Base::Financial
+
+              include Api::Mixins::Requests::AddressInfoAttributes
+              include Api::Mixins::Requests::Financial::AsyncAttributes
+              include Api::Mixins::Requests::Financial::NotificationAttributes
+
+              attr_accessor :crypto_address, :crypto_wallet_provider
+
+              protected
+
+              # BitPay Payout transaction type
+              def transaction_type
+                Api::Constants::Transactions::BITPAY_PAYOUT
+              end
+
+              # BitPay Payout field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[transaction_id notification_url return_success_url
+                  return_failure_url amount currency crypto_address crypto_wallet_provider]
+              end
+
+              # BitPay Payout parameters structure
+              def payment_transaction_structure
+                {
+                  notification_url:       notification_url,
+                  return_success_url:     return_success_url,
+                  return_failure_url:     return_failure_url,
+                  customer_email:         customer_email,
+                  crypto_address:         crypto_address,
+                  crypto_wallet_provider: crypto_wallet_provider,
+                  billing_address:        billing_address_parameters_structure,
+                  shipping_address:       shipping_address_parameters_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/crypto/bit_pay/refund.rb

@@ -0,0 +1,36 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Crypto
+          module BitPay
+            # BitPay Refund is a custom refund method which will handle the asynchronous
+            # BitPay refund workflow
+            class Refund < Requests::Base::Reference
+
+              protected
+
+              # BitPay Refund transaction type
+              def transaction_type
+                Api::Constants::Transactions::BITPAY_REFUND
+              end
+
+              # BitPay Refund field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[transaction_id amount currency reference_id]
+              end
+
+              # BitPay Refund parameters structure
+              def reference_transaction_structure
+                {}
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/crypto/bit_pay/sale.rb

@@ -0,0 +1,55 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Crypto
+          module BitPay
+            # BitPay is a cryptocurrency payments provider supporting blockchain payments
+            # with Bitcoin (BTC) and BitcoinCash (BCH)
+            # BitPay Sale is an asynchronous transaction type
+            class Sale < Requests::Base::Financial
+
+              include Api::Mixins::Requests::AddressInfoAttributes
+
+              attr_reader :return_url
+
+              # Return URL setter
+              def return_url=(value)
+                unless GenesisRuby::Utils::Common.valid_url?(value)
+                  raise ParameterError, "Invalid URL given for #{__method__}"
+                end
+
+                @return_url = value
+              end
+
+              protected
+
+              # BitPay Sale transaction type
+              def transaction_type
+                Api::Constants::Transactions::BITPAY_SALE
+              end
+
+              # BitPay Sale field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[transaction_id return_url amount currency customer_email]
+              end
+
+              # BitPay Sale parameters structure
+              def payment_transaction_structure
+                {
+                  return_url:       return_url,
+                  customer_email:   customer_email,
+                  billing_address:  billing_address_parameters_structure,
+                  shipping_address: shipping_address_parameters_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/gift_cards/fashioncheque.rb

@@ -0,0 +1,47 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module GiftCards
+          # Fashioncheque transactions are made using gift cards provided by Fashioncheque
+          class Fashioncheque < Requests::Base::Financial
+
+            include Api::Mixins::Requests::AddressInfoAttributes
+            include Api::Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Api::Mixins::Requests::Financial::GiftCardsAttributes
+            include Api::Mixins::Requests::Financial::ReferenceAttributes
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenAttributes
+
+            protected
+
+            # Fashioncheque transaction type
+            def transaction_type
+              Api::Constants::Transactions::FASHIONCHEQUE
+            end
+
+            # Fashioncheque field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id amount currency card_number]
+            end
+
+            # Fashioncheque parameters structure
+            def payment_transaction_structure
+              {
+                card_number:               card_number,
+                cvv:                       cvv,
+                token:                     token,
+                reference_id:              reference_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/gift_cards/intersolve.rb

@@ -0,0 +1,46 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module GiftCards
+          # Intersolve transactions are made using gift card provided by Intersolve
+          class Intersolve < Requests::Base::Financial
+
+            include Api::Mixins::Requests::AddressInfoAttributes
+            include Api::Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Api::Mixins::Requests::Financial::GiftCardsAttributes
+            include Api::Mixins::Requests::Financial::ReferenceAttributes
+            include Api::Mixins::Requests::Financial::Cards::TokenizationAttributes
+
+            protected
+
+            # Intersolve transaction type
+            def transaction_type
+              Api::Constants::Transactions::INTERSOLVE
+            end
+
+            # Intersolve field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id amount currency card_number]
+            end
+
+            # Intersolve parameters structure
+            def payment_transaction_structure
+              {
+                card_number:               card_number,
+                cvv:                       cvv,
+                reference_id:              reference_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure
+              }.merge(tokenization_attributes_structure)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/gift_cards/tcs.rb

@@ -0,0 +1,47 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module GiftCards
+          # The container store transactions are made using gift cards provided by TCS
+          class Tcs < Requests::Base::Financial
+
+            include Api::Mixins::Requests::AddressInfoAttributes
+            include Api::Mixins::Requests::Financial::DynamicDescriptorAttributes
+            include Api::Mixins::Requests::Financial::GiftCardsAttributes
+            include Api::Mixins::Requests::Financial::ReferenceAttributes
+            include Api::Mixins::Requests::NonFinancial::Tokenization::TokenAttributes
+
+            protected
+
+            # TCS transaction type
+            def transaction_type
+              Api::Constants::Transactions::TCS
+            end
+
+            # TCS field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id amount currency card_number]
+            end
+
+            # TCS parameters structure
+            def payment_transaction_structure
+              {
+                card_number:               card_number,
+                cvv:                       cvv,
+                token:                     token,
+                reference_id:              reference_id,
+                billing_address:           billing_address_parameters_structure,
+                shipping_address:          shipping_address_parameters_structure,
+                dynamic_descriptor_params: dynamic_descriptor_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/mobile/african_mobile_sale.rb

@@ -0,0 +1,81 @@
+require 'genesis_ruby/api/constants/transactions/parameters/african_mobile_operators'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Mobile
+          # African Mobile Sale, otherwise known as Charge, is an APM used to process
+          # Mobile network operator payments
+          class AfricanMobileSale < Requests::Base::Financial
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::Financial::AfricanMobileAttributes
+            include Mixins::Requests::Financial::AsyncAttributes
+
+            protected
+
+            # African Mobile Sale transaction type
+            def transaction_type
+              Api::Constants::Transactions::AFRICAN_MOBILE_SALE
+            end
+
+            # African Mobile Sale field validations
+            def init_field_validations # rubocop:disable Metrics/MethodLength
+              super
+
+              required_fields.push *%i[transaction_id return_success_url return_failure_url
+                amount currency operator target customer_phone billing_country]
+
+              field_values.merge! billing_country: %w(GH KE UG),
+                                  currency:        %w(GHS KES UGX),
+                                  operator:
+                                    Api::Constants::Transactions::Parameters::AfricanMobileOperators.sale
+
+              field_value_dependencies.merge!(
+                {
+                  currency: {
+                    GHS: {
+                      billing_country: %w(GH),
+                      operator:        [
+                        Api::Constants::Transactions::Parameters::AfricanMobileOperators::VODACOM
+                      ]
+                    },
+                    KES: {
+                      billing_country: %w(KE),
+                      operator:        [
+                        Api::Constants::Transactions::Parameters::AfricanMobileOperators::SAFARICOM
+                      ]
+                    },
+                    UGX: {
+                      billing_country: %w(UG),
+                      operator:        [
+                        Api::Constants::Transactions::Parameters::AfricanMobileOperators::AIRTEL,
+                        Api::Constants::Transactions::Parameters::AfricanMobileOperators::MTN
+                      ]
+                    }
+                  }
+                }
+              )
+            end
+
+            # African Mobile Sale request structure
+            def payment_transaction_structure
+              {
+                return_success_url: return_success_url,
+                return_failure_url: return_failure_url,
+                operator:           operator,
+                target:             target,
+                customer_email:     customer_email,
+                customer_phone:     customer_phone,
+                billing_address:    billing_address_parameters_structure,
+                shipping_address:   shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/mobile/russian_mobile_sale.rb

@@ -0,0 +1,55 @@
+require 'genesis_ruby/api/constants/transactions/parameters/mobile/apple_pay/payment_subtypes'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Mobile
+          # Russian Mobile Sale, otherwise known as Charge, is an APM used
+          # to process Mobile network operator payments
+          class RussianMobileSale < Requests::Base::Financial
+
+            include Mixins::Requests::AddressInfoAttributes
+            include Mixins::Requests::Financial::AsyncAttributes
+
+            attr_accessor :target, :operator
+
+            protected
+
+            # Russian Mobile Sale transaction type
+            def transaction_type
+              Api::Constants::Transactions::RUSSIAN_MOBILE_SALE
+            end
+
+            # Russian Mobile Sale field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id usage return_success_url return_failure_url
+                amount currency operator target customer_phone billing_country]
+
+              field_values.merge! billing_country: %w(RU),
+                                  currency:        %w(RUB),
+                                  operator:        %w(mtc megafon tele2 beeline)
+            end
+
+            # Russian Mobile Sale request structure
+            def payment_transaction_structure
+              {
+                return_success_url: return_success_url,
+                return_failure_url: return_failure_url,
+                operator:           operator,
+                target:             target,
+                customer_email:     customer_email,
+                customer_phone:     customer_phone,
+                billing_address:    billing_address_parameters_structure,
+                shipping_address:   shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/vouchers/neosurf.rb

@@ -0,0 +1,61 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module Financial
+        module Vouchers
+          # Neosurf is a prepaid card (voucher) that is used for online shopping
+          class Neosurf < Base::Financial
+
+            include Api::Mixins::Requests::AddressInfoAttributes
+            include Api::Mixins::Requests::Financial::AsyncAttributes
+
+            attr_reader :voucher_number
+
+            # Voucher number. Alphanumeric maximum 10 characters
+            def voucher_number=(value)
+              limited_string attribute: __method__,
+                             value: value.to_s.empty? ? nil : value.to_s,
+                             min: 1,
+                             max: 10
+            end
+
+            protected
+
+            # Neosurf transaction type
+            def transaction_type
+              Api::Constants::Transactions::NEOSURF
+            end
+
+            # Neosurf Field Validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[transaction_id amount currency billing_country]
+              field_values.merge! currency:        %w( AUD BGN BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR
+                                                      ILS INR JPY KRW MXN MYR NOK NZD PHP PLN RON RUB SEK
+                                                      SGD THB TRY USD XOF ZAR ),
+                                  billing_country: %w( AT DZ AU BI BF BJ BE CV CY CA CF TD CO CG CM CD DK GQ
+                                                    FR GM DE GA GN GH GW HK IE IT CI KE LU MW MZ MA MR ML
+                                                    NE NG NL NZ NO PL PT RW RU RO SE ES SL SN ST CH RS TR
+                                                    TG TN GB TZ UG ZW ZM )
+            end
+
+            # Neosurf request structure
+            def payment_transaction_structure
+              {
+                voucher_number:     voucher_number,
+                customer_email:     customer_email,
+                customer_phone:     customer_phone,
+                return_success_url: return_success_url,
+                return_failure_url: return_failure_url,
+                billing_address:    billing_address_parameters_structure,
+                shipping_address:   shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fraud/chargeback/date_range.rb

@@ -0,0 +1,82 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Chargeback
+            # Date range based chargeback retrieval allows you to fetch information for all
+            # chargebacks for a given merchant within a given date range
+            class DateRange < Api::Request
+
+              include Api::Mixins::Requests::NonFinancial::DateAttributes
+              include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+              attr_accessor :externally_processed, :processing_type
+
+              # Start of the requested date range
+              def start_date
+                @start_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # End of the requested date range
+              def end_date
+                @end_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Date of import in the system
+              def import_date
+                @import_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Date of import in the system
+              def import_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              protected
+
+              # Set Gateway API configuration
+              def init_configuration
+                init_xml_configuration
+                init_api_gateway_configuration request_path: 'chargebacks/by_date', include_token: false
+                @api_config.parser_skip_root_node = false
+              end
+
+              # Field Validations
+              def init_field_validations
+                super
+
+                constant_values = {
+                  externally_processed: Constants::Transactions::Parameters::NonFinancial::ExternallyProcessed.all,
+                  processing_type:      Constants::Transactions::Parameters::NonFinancial::ProcessingType.all
+                }
+
+                required_fields.push *%i[start_date]
+                field_values.merge! constant_values
+              end
+
+              # API Request structure
+              def populate_structure # rubocop:disable Metrics/MethodLength
+                @tree_structure = {
+                  chargeback_request: {
+                    start_date:           start_date,
+                    end_date:             end_date,
+                    import_date:          import_date,
+                    page:                 page,
+                    per_page:             per_page,
+                    externally_processed: externally_processed,
+                    processing_type:      processing_type
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end