genesis_ruby 0.3.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +169 -1
- data/VERSION +1 -1
- data/lib/genesis_ruby/api/constants/non_financial/alternatives/alipay/merchant_types.rb +26 -0
- data/lib/genesis_ruby/api/constants/non_financial/alternatives/alipay/site_types.rb +26 -0
- data/lib/genesis_ruby/api/constants/non_financial/kyc/bank_account_types.rb +24 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/foreign_retailer_indicators.rb +24 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/funding/person_types.rb +26 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/money_transfer/purpose_of_payments.rb +46 -19
- data/lib/genesis_ruby/api/constants/transactions/parameters/money_transfer/sender_account_number_types.rb +14 -17
- data/lib/genesis_ruby/api/constants/transactions/parameters/money_transfer/source_of_funds.rb +9 -18
- data/lib/genesis_ruby/api/constants/transactions/parameters/money_transfer/types.rb +31 -4
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/enhanced_statement_response_fields.rb +39 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/response_fields.rb +2 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/statement_order_by_fields.rb +31 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/statement_response_fields.rb +14 -13
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/{processing_type.rb → scopes.rb} +4 -3
- data/lib/genesis_ruby/api/constants/transactions/parameters/purpose_of_payment.rb +117 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/purpose_of_payment_values.rb +267 -0
- data/lib/genesis_ruby/api/constants/transactions/parameters/wallets/e_wallet/payment_types.rb +46 -0
- data/lib/genesis_ruby/api/constants/transactions.rb +9 -0
- data/lib/genesis_ruby/api/mixins/requests/customer_address/billing_info_attributes.rb +3 -1
- data/lib/genesis_ruby/api/mixins/requests/financial/cards/credential_on_file_transaction_link_attributes.rb +83 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/commercial_card_attributes.rb +143 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/funding_attributes.rb +32 -3
- data/lib/genesis_ruby/api/mixins/requests/financial/marketplace_data_attributes.rb +179 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/money_transfer_payout_attributes.rb +49 -46
- data/lib/genesis_ruby/api/mixins/requests/financial/order_attributes.rb +36 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/purpose_of_payment_attributes.rb +14 -4
- data/lib/genesis_ruby/api/mixins/requests/financial/refund/bank_attributes.rb +41 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/refund/beneficiary_attributes.rb +31 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/refund/travel_ticket_attributes.rb +52 -0
- data/lib/genesis_ruby/api/mixins/requests/financial/threeds/force_threeds_attributes.rb +29 -0
- data/lib/genesis_ruby/api/mixins/requests/non_financial/alternatives/alipay/site_information_attributes.rb +57 -0
- data/lib/genesis_ruby/api/mixins/requests/non_financial/date_time_from_to_attributes.rb +102 -0
- data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/background_checks_attributes.rb +31 -10
- data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/verification_document_attributes.rb +49 -7
- data/lib/genesis_ruby/api/mixins/requests/non_financial/kyc/verification_instructions_attributes.rb +90 -0
- data/lib/genesis_ruby/api/mixins/requests/non_financial/reconcile_order_attributes.rb +30 -0
- data/lib/genesis_ruby/api/mixins/requests/non_financial/scope_attributes.rb +29 -0
- data/lib/genesis_ruby/api/mixins/requests/restricted_setter.rb +12 -0
- data/lib/genesis_ruby/api/mixins/requests/scheme_tokenized_attributes.rb +35 -0
- data/lib/genesis_ruby/api/requests/base/financials/credit_card.rb +1 -12
- data/lib/genesis_ruby/api/requests/base/graphql.rb +7 -0
- data/lib/genesis_ruby/api/requests/base/non_financial/billing_api/abstract_statement.rb +226 -0
- data/lib/genesis_ruby/api/requests/base/non_financial/billing_api/base.rb +39 -37
- data/lib/genesis_ruby/api/requests/base/non_financial/reconcile/base.rb +45 -0
- data/lib/genesis_ruby/api/requests/financial/async_refund.rb +41 -0
- data/lib/genesis_ruby/api/requests/financial/cards/authorize.rb +43 -24
- data/lib/genesis_ruby/api/requests/financial/cards/authorize3d.rb +13 -1
- data/lib/genesis_ruby/api/requests/financial/cards/payout.rb +21 -5
- data/lib/genesis_ruby/api/requests/financial/cards/sale.rb +42 -23
- data/lib/genesis_ruby/api/requests/financial/cards/sale3d.rb +13 -1
- data/lib/genesis_ruby/api/requests/financial/mobile/apple_pay.rb +5 -1
- data/lib/genesis_ruby/api/requests/financial/mobile/google_pay.rb +6 -2
- data/lib/genesis_ruby/api/requests/financial/online_banking_payments/my_bank.rb +1 -1
- data/lib/genesis_ruby/api/requests/financial/refund.rb +20 -35
- data/lib/genesis_ruby/api/requests/financial/sdd/sale.rb +6 -1
- data/lib/genesis_ruby/api/requests/financial/wallets/e_wallet.rb +72 -0
- data/lib/genesis_ruby/api/requests/non_financial/alternatives/alipay/register_merchant.rb +147 -0
- data/lib/genesis_ruby/api/requests/non_financial/billing_api/enhanced_statement.rb +46 -0
- data/lib/genesis_ruby/api/requests/non_financial/billing_api/statement.rb +12 -137
- data/lib/genesis_ruby/api/requests/non_financial/billing_api/transactions.rb +4 -2
- data/lib/genesis_ruby/api/requests/non_financial/fraud/chargeback/date_range.rb +10 -19
- data/lib/genesis_ruby/api/requests/non_financial/fraud/rdr/date_range.rb +91 -0
- data/lib/genesis_ruby/api/requests/non_financial/fraud/rdr/transaction.rb +54 -0
- data/lib/genesis_ruby/api/requests/non_financial/fraud/retrieval/date_range.rb +10 -19
- data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/bank_account.rb +76 -0
- data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/create.rb +31 -4
- data/lib/genesis_ruby/api/requests/non_financial/payment_authorizations/date_range.rb +124 -0
- data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/date_range.rb +8 -15
- data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/post_date_range.rb +12 -18
- data/lib/genesis_ruby/api/requests/non_financial/reconcile/date_range.rb +29 -4
- data/lib/genesis_ruby/api/requests/non_financial/reconcile/order.rb +40 -0
- data/lib/genesis_ruby/api/requests/non_financial/reconcile/transaction.rb +1 -15
- data/lib/genesis_ruby/api/requests/non_financial/tokenization/cryptogram.rb +3 -1
- data/lib/genesis_ruby/api/requests/non_financial/tokenization/tokenize.rb +3 -1
- data/lib/genesis_ruby/api/requests/wpf/create.rb +4 -0
- data/lib/genesis_ruby/api/requests/wpf/reconcile.rb +11 -4
- data/lib/genesis_ruby/api/requests/wpf/reconcile_by_date.rb +62 -0
- data/lib/genesis_ruby/api/requests/wpf/reconcile_by_order.rb +38 -0
- data/lib/genesis_ruby/builders/graphql.rb +95 -40
- data/lib/genesis_ruby/dependencies.rb +2 -0
- data/lib/genesis_ruby/utils/money/format.rb +2 -1
- data/lib/genesis_ruby/utils/transactions/financial_types.rb +3 -2
- data/lib/genesis_ruby/utils/transactions/references/refundable_types.rb +2 -1
- data/lib/genesis_ruby/utils/transactions/wpf_types.rb +1 -1
- data/lib/genesis_ruby/version.rb +1 -1
- metadata +40 -35
- data/.kiro/specs/f2025112509-add_managed_recurring_api/.config.kiro +0 -1
- data/.kiro/specs/f2025112509-add_managed_recurring_api/design.md +0 -332
- data/.kiro/specs/f2025112509-add_managed_recurring_api/requirements.md +0 -91
- data/.kiro/specs/f2025112509-add_managed_recurring_api/tasks.md +0 -139
- data/.kiro/specs/f2025112603-add_reverify_endpoint_to_payee_account/.config.kiro +0 -1
- data/.kiro/specs/f2025112603-add_reverify_endpoint_to_payee_account/design.md +0 -148
- data/.kiro/specs/f2025112603-add_reverify_endpoint_to_payee_account/requirements.md +0 -81
- data/.kiro/specs/f2025112603-add_reverify_endpoint_to_payee_account/tasks.md +0 -48
- data/.kiro/specs/f2025112606-add_list_payees_trx_request/.config.kiro +0 -1
- data/.kiro/specs/f2025112606-add_list_payees_trx_request/design.md +0 -112
- data/.kiro/specs/f2025112606-add_list_payees_trx_request/requirements.md +0 -74
- data/.kiro/specs/f2025112606-add_list_payees_trx_request/tasks.md +0 -38
- data/.kiro/specs/f2025112609_update_payee_request_params/design.md +0 -86
- data/.kiro/specs/f2025112609_update_payee_request_params/requirements.md +0 -86
- data/.kiro/specs/f2025112609_update_payee_request_params/tasks.md +0 -40
- data/.kiro/specs/f2025112612-add_payee_owner_documents_and_verification_requests/.config.kiro +0 -1
- data/.kiro/specs/f2025112612-add_payee_owner_documents_and_verification_requests/design.md +0 -246
- data/.kiro/specs/f2025112612-add_payee_owner_documents_and_verification_requests/requirements.md +0 -287
- data/.kiro/specs/f2025112612-add_payee_owner_documents_and_verification_requests/tasks.md +0 -76
- data/.kiro/specs/f2025112614-add_money_transfer_payout_attributes_to_payout_rq/design.md +0 -84
- data/.kiro/specs/f2025112614-add_money_transfer_payout_attributes_to_payout_rq/requirements.md +0 -88
- data/.kiro/specs/f2025112614-add_money_transfer_payout_attributes_to_payout_rq/tasks.md +0 -38
- data/.kiro/steering/product.md +0 -15
- data/.kiro/steering/spec-folder-naming.md +0 -16
- data/.kiro/steering/structure.md +0 -96
- data/.kiro/steering/tech.md +0 -66
- data/Gemfile +0 -6
- data/Gemfile.lock +0 -176
- data/Rakefile +0 -24
- data/genesis_ruby.gemspec +0 -47
- data/lib/genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed.rb +0 -24
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'genesis_ruby/api/constants/transactions/parameters/credential_on_files'
|
|
4
|
+
require 'genesis_ruby/api/constants/transactions/parameters/recurring/types'
|
|
5
|
+
|
|
6
|
+
module GenesisRuby
|
|
7
|
+
module Api
|
|
8
|
+
module Mixins
|
|
9
|
+
module Requests
|
|
10
|
+
module Financial
|
|
11
|
+
module Cards
|
|
12
|
+
# Credential On File Transaction Link ID (Scheme Transaction Link ID) attributes mixin
|
|
13
|
+
module CredentialOnFileTransactionLinkAttributes
|
|
14
|
+
|
|
15
|
+
# Exact length of the Scheme Transaction Link ID
|
|
16
|
+
CREDENTIAL_ON_FILE_TRANSACTION_LINK_ID_LENGTH = 22
|
|
17
|
+
|
|
18
|
+
# Allowed format of the Scheme Transaction Link ID
|
|
19
|
+
CREDENTIAL_ON_FILE_TRANSACTION_LINK_ID_FORMAT = /\A[A-Za-z0-9_-]{22}\z/.freeze
|
|
20
|
+
|
|
21
|
+
attr_reader :credential_on_file_transaction_link_id
|
|
22
|
+
|
|
23
|
+
# Scheme Transaction Link ID of the original transaction (Mastercard)
|
|
24
|
+
def credential_on_file_transaction_link_id=(value)
|
|
25
|
+
if value.nil? || value == ''
|
|
26
|
+
@credential_on_file_transaction_link_id = nil
|
|
27
|
+
|
|
28
|
+
return
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
validate_credential_on_file_transaction_link_id_format value
|
|
32
|
+
|
|
33
|
+
@credential_on_file_transaction_link_id = value
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
protected
|
|
37
|
+
|
|
38
|
+
# Validates the allowed transaction flow for credential_on_file_transaction_link_id upon document building
|
|
39
|
+
def validate_credential_on_file_transaction_link_id
|
|
40
|
+
return if credential_on_file_transaction_link_id.nil?
|
|
41
|
+
return if non_referenced_subsequent_flow? || ucof_flow?
|
|
42
|
+
|
|
43
|
+
raise ParameterError, 'credential_on_file_transaction_link_id is allowed only with recurring_type ' \
|
|
44
|
+
'subsequent without reference_id or with credential_on_file merchant_unscheduled'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
private
|
|
48
|
+
|
|
49
|
+
# Raise InvalidArgumentError when the given value is not a valid Scheme Transaction Link ID
|
|
50
|
+
def validate_credential_on_file_transaction_link_id_format(value)
|
|
51
|
+
unless value.is_a? String
|
|
52
|
+
raise InvalidArgumentError, 'credential_on_file_transaction_link_id accepts only String values'
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
unless value.length == CREDENTIAL_ON_FILE_TRANSACTION_LINK_ID_LENGTH
|
|
56
|
+
raise InvalidArgumentError, 'credential_on_file_transaction_link_id value must be exactly ' \
|
|
57
|
+
"#{CREDENTIAL_ON_FILE_TRANSACTION_LINK_ID_LENGTH} chars long."
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
return if CREDENTIAL_ON_FILE_TRANSACTION_LINK_ID_FORMAT.match? value
|
|
61
|
+
|
|
62
|
+
raise InvalidArgumentError, 'credential_on_file_transaction_link_id accepts only Latin letters, ' \
|
|
63
|
+
'digits, - and _ characters.'
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# Subsequent recurring transaction without reference_id
|
|
67
|
+
def non_referenced_subsequent_flow?
|
|
68
|
+
recurring_type == Api::Constants::Transactions::Parameters::Recurring::Types::SUBSEQUENT &&
|
|
69
|
+
reference_id.to_s.empty?
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Unscheduled Credential On File transaction
|
|
73
|
+
def ucof_flow?
|
|
74
|
+
credential_on_file == Api::Constants::Transactions::Parameters::CredentialOnFiles::MERCHANT_UNSCHEDULED
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
end
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'bigdecimal'
|
|
4
|
+
|
|
5
|
+
module GenesisRuby
|
|
6
|
+
module Api
|
|
7
|
+
module Mixins
|
|
8
|
+
module Requests
|
|
9
|
+
module Financial
|
|
10
|
+
# Commercial Card Data attributes (Mastercard Large Ticket Interchange)
|
|
11
|
+
module CommercialCardAttributes
|
|
12
|
+
|
|
13
|
+
# Item type sent with every commercial card item
|
|
14
|
+
COMMERCIAL_CARD_ITEM_TYPE = 'commercial_card'
|
|
15
|
+
private_constant :COMMERCIAL_CARD_ITEM_TYPE
|
|
16
|
+
|
|
17
|
+
# Commercial card attribute names, used for the readers and the data supplied / absent check
|
|
18
|
+
COMMERCIAL_CARD_FIELDS = %i[
|
|
19
|
+
commercial_card_name commercial_card_reference commercial_card_customer_code
|
|
20
|
+
commercial_card_quantity commercial_card_tax_rate commercial_card_unit_price
|
|
21
|
+
commercial_card_total_tax_amount commercial_card_total_discount_amount
|
|
22
|
+
].freeze
|
|
23
|
+
private_constant :COMMERCIAL_CARD_FIELDS
|
|
24
|
+
|
|
25
|
+
attr_reader(*COMMERCIAL_CARD_FIELDS)
|
|
26
|
+
|
|
27
|
+
# Item name writer (max 35 chars)
|
|
28
|
+
def commercial_card_name=(value)
|
|
29
|
+
limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 35
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Item reference writer (max 15 chars)
|
|
33
|
+
def commercial_card_reference=(value)
|
|
34
|
+
limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 15
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Merchant customer code writer (max 17 chars)
|
|
38
|
+
def commercial_card_customer_code=(value)
|
|
39
|
+
limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 17
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Quantity writer: Integer or digit String, 1..9_999_999_999, stored as Integer
|
|
43
|
+
def commercial_card_quantity=(value)
|
|
44
|
+
quantity = value.to_s.match?(/\A\d+\z/) ? value.to_s.to_i : nil
|
|
45
|
+
|
|
46
|
+
unless value.to_s.empty? || (1..9_999_999_999).cover?(quantity)
|
|
47
|
+
raise InvalidArgumentError, 'commercial_card_quantity must be an integer in range 1 to 9999999999'
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
@commercial_card_quantity = quantity
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Tax rate writer: Percent_Input, stored as its textual form
|
|
54
|
+
def commercial_card_tax_rate=(value)
|
|
55
|
+
text = commercial_card_text(value)
|
|
56
|
+
|
|
57
|
+
unless text.nil? || (text.match?(/\A\d{1,2}(\.\d{1,2})?\z/) && BigDecimal(text).positive?)
|
|
58
|
+
raise InvalidArgumentError,
|
|
59
|
+
'commercial_card_tax_rate must be a percent in range 0.01 to 99.99 with up to two decimal places'
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
@commercial_card_tax_rate = text
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Unit price writer: textual form in major units; validated by transform_amount, like `amount`
|
|
66
|
+
def commercial_card_unit_price=(value)
|
|
67
|
+
@commercial_card_unit_price = commercial_card_text(value)
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# Total tax amount writer: textual form in major units; validated by transform_amount
|
|
71
|
+
def commercial_card_total_tax_amount=(value)
|
|
72
|
+
@commercial_card_total_tax_amount = commercial_card_text(value)
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Total discount amount writer: textual form in major units; validated by transform_amount
|
|
76
|
+
def commercial_card_total_discount_amount=(value)
|
|
77
|
+
@commercial_card_total_discount_amount = commercial_card_text(value)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
protected
|
|
81
|
+
|
|
82
|
+
# Commercial card item structure, children in the documented order. Returns {} while no field is set.
|
|
83
|
+
def commercial_card_attributes_structure # rubocop:disable Metrics/MethodLength
|
|
84
|
+
return {} unless commercial_card_data_supplied?
|
|
85
|
+
|
|
86
|
+
{
|
|
87
|
+
item: {
|
|
88
|
+
item_type: COMMERCIAL_CARD_ITEM_TYPE,
|
|
89
|
+
name: commercial_card_name,
|
|
90
|
+
reference: commercial_card_reference,
|
|
91
|
+
quantity: commercial_card_quantity,
|
|
92
|
+
unit_price: transform_amount(commercial_card_unit_price, currency),
|
|
93
|
+
tax_rate: commercial_card_tax_rate_value,
|
|
94
|
+
total_tax_amount: transform_amount(commercial_card_total_tax_amount, currency),
|
|
95
|
+
total_discount_amount: transform_amount(commercial_card_total_discount_amount, currency),
|
|
96
|
+
merchant_data: { customer_code: commercial_card_customer_code }
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Contextual validation, called from check_requirements after super.
|
|
102
|
+
# Raises for the first missing required field, in the documented order, then for name or reference.
|
|
103
|
+
def validate_commercial_card_attributes
|
|
104
|
+
return unless commercial_card_data_supplied?
|
|
105
|
+
|
|
106
|
+
validate_required_fields %i[
|
|
107
|
+
commercial_card_quantity commercial_card_unit_price commercial_card_tax_rate
|
|
108
|
+
commercial_card_total_tax_amount commercial_card_total_discount_amount
|
|
109
|
+
]
|
|
110
|
+
return unless commercial_card_name.nil? && commercial_card_reference.nil?
|
|
111
|
+
|
|
112
|
+
raise ParameterError,
|
|
113
|
+
'commercial_card_name or commercial_card_reference is required when commercial card data ' \
|
|
114
|
+
'is supplied'
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
private
|
|
118
|
+
|
|
119
|
+
# Textual form of a value, nil for nil or ''
|
|
120
|
+
def commercial_card_text(value)
|
|
121
|
+
return nil if value.to_s.empty?
|
|
122
|
+
|
|
123
|
+
value.is_a?(BigDecimal) ? value.to_s('F') : value.to_s
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# Whether any commercial card field holds a value. Every writer stores nil for '', so nil means unset.
|
|
127
|
+
def commercial_card_data_supplied?
|
|
128
|
+
COMMERCIAL_CARD_FIELDS.any? { |field| !public_send(field).nil? }
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Tax rate rendered value: percent * 100 as Integer, independent of currency
|
|
132
|
+
def commercial_card_tax_rate_value
|
|
133
|
+
return nil if commercial_card_tax_rate.nil?
|
|
134
|
+
|
|
135
|
+
(BigDecimal(commercial_card_tax_rate) * 100).to_i
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
require 'genesis_ruby/api/constants/transactions/parameters/funding/business_application_identifier_types'
|
|
4
4
|
require 'genesis_ruby/api/constants/transactions/parameters/funding/identifier_types'
|
|
5
|
+
require 'genesis_ruby/api/constants/transactions/parameters/funding/person_types'
|
|
5
6
|
require 'genesis_ruby/api/constants/transactions/parameters/funding/receiver_account_types'
|
|
6
7
|
|
|
7
8
|
module GenesisRuby
|
|
@@ -12,13 +13,36 @@ module GenesisRuby
|
|
|
12
13
|
# Mixin Funding Attributes
|
|
13
14
|
module FundingAttributes
|
|
14
15
|
|
|
16
|
+
attr_reader :funding_receiver_type, :funding_sender_type
|
|
17
|
+
|
|
15
18
|
attr_accessor :funding_identifier_type, :funding_business_application_identifier,
|
|
16
19
|
:funding_receiver_first_name, :funding_receiver_last_name, :funding_receiver_country,
|
|
17
20
|
:funding_receiver_account_number, :funding_receiver_account_number_type,
|
|
18
|
-
:funding_receiver_address, :
|
|
21
|
+
:funding_receiver_address, :funding_receiver_address2, :funding_receiver_street_name,
|
|
22
|
+
:funding_receiver_state, :funding_receiver_city, :funding_receiver_zip_code,
|
|
19
23
|
:funding_sender_name, :funding_sender_reference_number, :funding_sender_country,
|
|
20
24
|
:funding_sender_address, :funding_sender_state, :funding_sender_city
|
|
21
25
|
|
|
26
|
+
# Funding Receiver Person Type setter
|
|
27
|
+
def funding_receiver_type=(value)
|
|
28
|
+
allowed_options(
|
|
29
|
+
attribute: __method__,
|
|
30
|
+
allowed: Api::Constants::Transactions::Parameters::Funding::PersonTypes.all,
|
|
31
|
+
value: value,
|
|
32
|
+
allow_empty: true
|
|
33
|
+
)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Funding Sender Person Type setter
|
|
37
|
+
def funding_sender_type=(value)
|
|
38
|
+
allowed_options(
|
|
39
|
+
attribute: __method__,
|
|
40
|
+
allowed: Api::Constants::Transactions::Parameters::Funding::PersonTypes.all,
|
|
41
|
+
value: value,
|
|
42
|
+
allow_empty: true
|
|
43
|
+
)
|
|
44
|
+
end
|
|
45
|
+
|
|
22
46
|
protected
|
|
23
47
|
|
|
24
48
|
# Provide a hash with the funding attributes field allowed values
|
|
@@ -34,22 +58,27 @@ module GenesisRuby
|
|
|
34
58
|
end
|
|
35
59
|
|
|
36
60
|
# Funding Attributes Structure
|
|
37
|
-
def funding_attributes_structure # rubocop:disable Metrics/MethodLength
|
|
61
|
+
def funding_attributes_structure # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
|
|
38
62
|
{
|
|
39
63
|
identifier_type: funding_identifier_type,
|
|
40
64
|
business_application_identifier: funding_business_application_identifier,
|
|
41
65
|
receiver: {
|
|
42
66
|
first_name: funding_receiver_first_name,
|
|
43
67
|
last_name: funding_receiver_last_name,
|
|
68
|
+
type: funding_receiver_type,
|
|
44
69
|
country: funding_receiver_country,
|
|
45
70
|
account_number: funding_receiver_account_number,
|
|
46
71
|
account_number_type: funding_receiver_account_number_type,
|
|
47
72
|
address: funding_receiver_address,
|
|
73
|
+
address2: funding_receiver_address2,
|
|
74
|
+
street_name: funding_receiver_street_name,
|
|
48
75
|
state: funding_receiver_state,
|
|
49
|
-
city: funding_receiver_city
|
|
76
|
+
city: funding_receiver_city,
|
|
77
|
+
zip_code: funding_receiver_zip_code
|
|
50
78
|
},
|
|
51
79
|
sender: {
|
|
52
80
|
name: funding_sender_name,
|
|
81
|
+
type: funding_sender_type,
|
|
53
82
|
reference_number: funding_sender_reference_number,
|
|
54
83
|
country: funding_sender_country,
|
|
55
84
|
address: funding_sender_address,
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'bigdecimal'
|
|
4
|
+
require 'genesis_ruby/api/constants/transactions/parameters/foreign_retailer_indicators'
|
|
5
|
+
|
|
6
|
+
module GenesisRuby
|
|
7
|
+
module Api
|
|
8
|
+
module Mixins
|
|
9
|
+
module Requests
|
|
10
|
+
module Financial
|
|
11
|
+
# Marketplace Data attributes (Visa foreign retailer)
|
|
12
|
+
module MarketplaceDataAttributes
|
|
13
|
+
|
|
14
|
+
# Types accepted as a decimal number for the foreign retailer transaction amount
|
|
15
|
+
MARKETPLACE_DATA_AMOUNT_TYPES = [Integer, Float, BigDecimal, String].freeze
|
|
16
|
+
|
|
17
|
+
# Values are stored unchanged. The amount is set in major currency units.
|
|
18
|
+
attr_accessor :foreign_retailer_indicator, :foreign_retailer_transaction_amount
|
|
19
|
+
|
|
20
|
+
protected
|
|
21
|
+
|
|
22
|
+
# Marketplace Data validations, executed after the generic request validation
|
|
23
|
+
def validate_marketplace_data_attributes
|
|
24
|
+
validate_foreign_retailer_indicator
|
|
25
|
+
|
|
26
|
+
return if marketplace_data_empty?(foreign_retailer_transaction_amount)
|
|
27
|
+
|
|
28
|
+
validate_marketplace_data_dependencies
|
|
29
|
+
validate_foreign_retailer_transaction_amount
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Marketplace Data request structure. Never raises.
|
|
33
|
+
def marketplace_data_attributes_structure
|
|
34
|
+
{
|
|
35
|
+
foreign_retailer_indicator: marketplace_data_indicator_value,
|
|
36
|
+
foreign_retailer_transaction_amount: marketplace_data_minor_amount
|
|
37
|
+
}
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
private
|
|
41
|
+
|
|
42
|
+
# Indicator must be a String equal to an allowed value (runs even without an amount)
|
|
43
|
+
def validate_foreign_retailer_indicator
|
|
44
|
+
value = foreign_retailer_indicator
|
|
45
|
+
|
|
46
|
+
return if marketplace_data_empty?(value) || marketplace_data_valid_indicator?(value)
|
|
47
|
+
|
|
48
|
+
raise ParameterError, format(
|
|
49
|
+
'Parameter foreign_retailer_indicator is set to %{value}, but expected to be one of (%{allowed})',
|
|
50
|
+
value: value,
|
|
51
|
+
allowed: foreign_retailer_indicators.all.join(', ')
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Indicator, amount and currency presence (local, no generic helpers)
|
|
56
|
+
def validate_marketplace_data_dependencies
|
|
57
|
+
{ foreign_retailer_indicator: foreign_retailer_indicator, amount: amount, currency: currency }
|
|
58
|
+
.each do |field, value|
|
|
59
|
+
next unless marketplace_data_empty?(value)
|
|
60
|
+
|
|
61
|
+
raise ParameterError,
|
|
62
|
+
"foreign_retailer_transaction_amount is depending on: #{field}, which is empty (null)!"
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# Currency validity, type, sign, currency precision and upper bound checks
|
|
67
|
+
def validate_foreign_retailer_transaction_amount
|
|
68
|
+
validate_marketplace_data_currency
|
|
69
|
+
|
|
70
|
+
decimal = marketplace_data_decimal(foreign_retailer_transaction_amount)
|
|
71
|
+
|
|
72
|
+
validate_marketplace_data_decimal(decimal)
|
|
73
|
+
validate_marketplace_data_upper_bound(decimal)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Local currency guard: fetch_exponent returns 0 for unknown codes
|
|
77
|
+
def validate_marketplace_data_currency
|
|
78
|
+
return if Api::Constants::Currencies::Iso4217.valid?(currency)
|
|
79
|
+
|
|
80
|
+
raise_marketplace_data_error "requires a valid ISO 4217 currency, #{currency} given"
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Type, sign and currency precision checks
|
|
84
|
+
def validate_marketplace_data_decimal(decimal)
|
|
85
|
+
raise_marketplace_data_error 'must be a valid decimal number' if decimal.nil?
|
|
86
|
+
raise_marketplace_data_error 'must be greater than 0' unless decimal.positive?
|
|
87
|
+
|
|
88
|
+
return if marketplace_data_integral?(decimal)
|
|
89
|
+
|
|
90
|
+
raise_marketplace_data_error "must have max #{marketplace_data_exponent} decimal places for #{currency}"
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Upper bound check, compared in minor currency units
|
|
94
|
+
def validate_marketplace_data_upper_bound(decimal)
|
|
95
|
+
return if marketplace_data_to_minor(decimal) <= marketplace_data_to_minor(amount)
|
|
96
|
+
|
|
97
|
+
raise_marketplace_data_error 'must be less than or equal to the transaction amount'
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Empty means nil or '' only; never calls .empty? on non-String values
|
|
101
|
+
def marketplace_data_empty?(value)
|
|
102
|
+
value.nil? || (value.is_a?(String) && value.empty?)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Exact, case-sensitive match; any non-String value is invalid
|
|
106
|
+
def marketplace_data_valid_indicator?(value)
|
|
107
|
+
value.is_a?(String) && foreign_retailer_indicators.all.include?(value)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Indicator for the request structure: only a non-empty String enters the tree
|
|
111
|
+
def marketplace_data_indicator_value
|
|
112
|
+
value = foreign_retailer_indicator
|
|
113
|
+
|
|
114
|
+
return nil unless value.is_a?(String) && !value.empty?
|
|
115
|
+
|
|
116
|
+
value
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Finite BigDecimal of the given value or nil when it is not a valid decimal number
|
|
120
|
+
def marketplace_data_decimal(value)
|
|
121
|
+
return nil unless MARKETPLACE_DATA_AMOUNT_TYPES.any? { |type| value.is_a?(type) }
|
|
122
|
+
|
|
123
|
+
decimal = BigDecimal(value.to_s)
|
|
124
|
+
|
|
125
|
+
decimal.finite? ? decimal : nil
|
|
126
|
+
rescue ArgumentError, TypeError
|
|
127
|
+
nil
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
# Currency exponent; call only after the currency is a valid ISO 4217 code
|
|
131
|
+
def marketplace_data_exponent
|
|
132
|
+
Api::Constants::Currencies::Iso4217.fetch_exponent(currency)
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Whether the decimal has no more decimal places than the currency exponent allows
|
|
136
|
+
def marketplace_data_integral?(decimal)
|
|
137
|
+
(decimal * (10**marketplace_data_exponent)).frac.zero?
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# Same predicates as validation rules 5 to 8; guarantees the converter cannot raise
|
|
141
|
+
def marketplace_data_convertible?(decimal)
|
|
142
|
+
!decimal.nil? &&
|
|
143
|
+
Api::Constants::Currencies::Iso4217.valid?(currency) &&
|
|
144
|
+
decimal.positive? &&
|
|
145
|
+
marketplace_data_integral?(decimal)
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Foreign amount in minor units or nil when it cannot be converted
|
|
149
|
+
def marketplace_data_minor_amount
|
|
150
|
+
return nil if marketplace_data_empty?(foreign_retailer_transaction_amount)
|
|
151
|
+
|
|
152
|
+
decimal = marketplace_data_decimal(foreign_retailer_transaction_amount)
|
|
153
|
+
|
|
154
|
+
return nil unless marketplace_data_convertible?(decimal)
|
|
155
|
+
|
|
156
|
+
GenesisRuby::Utils::MoneyFormat.amount_to_exponent(decimal, currency)
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Integer minor-unit value for comparison
|
|
160
|
+
def marketplace_data_to_minor(value)
|
|
161
|
+
GenesisRuby::Utils::MoneyFormat.amount_to_exponent(value, currency).to_i
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Foreign retailer indicator constants
|
|
165
|
+
def foreign_retailer_indicators
|
|
166
|
+
Api::Constants::Transactions::Parameters::ForeignRetailerIndicators
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Raise a foreign_retailer_transaction_amount validation error
|
|
170
|
+
def raise_marketplace_data_error(reason)
|
|
171
|
+
raise ParameterError, "foreign_retailer_transaction_amount #{reason}"
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require 'genesis_ruby/api/constants/transactions/parameters/funding/person_types'
|
|
3
4
|
require 'genesis_ruby/api/constants/transactions/parameters/money_transfer/types'
|
|
4
5
|
require 'genesis_ruby/api/constants/transactions/parameters/money_transfer/sender_account_number_types'
|
|
5
|
-
require 'genesis_ruby/api/constants/transactions/parameters/money_transfer/purpose_of_payments'
|
|
6
6
|
require 'genesis_ruby/api/constants/transactions/parameters/money_transfer/source_of_funds'
|
|
7
7
|
|
|
8
8
|
module GenesisRuby
|
|
@@ -13,25 +13,17 @@ module GenesisRuby
|
|
|
13
13
|
# Money Transfer Payout Attributes
|
|
14
14
|
module MoneyTransferPayoutAttributes
|
|
15
15
|
|
|
16
|
-
attr_accessor :money_transfer_sender_account_number,
|
|
17
|
-
:
|
|
18
|
-
:money_transfer_sender_address_country,
|
|
19
|
-
:
|
|
20
|
-
:
|
|
21
|
-
:
|
|
22
|
-
:
|
|
23
|
-
:
|
|
24
|
-
:money_transfer_receiver_last_name,
|
|
25
|
-
:money_transfer_receiver_address_country,
|
|
26
|
-
:money_transfer_receiver_address_city,
|
|
27
|
-
:money_transfer_receiver_address_line,
|
|
28
|
-
:money_transfer_receiver_address_state,
|
|
29
|
-
:money_transfer_receiver_address_postal_code,
|
|
30
|
-
:money_transfer_receiver_account_number,
|
|
31
|
-
:money_transfer_receiver_account_number_type
|
|
16
|
+
attr_accessor :money_transfer_sender_account_number, :money_transfer_service_provider_name,
|
|
17
|
+
:money_transfer_sender_address_first_name, :money_transfer_sender_address_last_name,
|
|
18
|
+
:money_transfer_sender_address_country, :money_transfer_sender_address_city,
|
|
19
|
+
:money_transfer_sender_address_zip_code, :money_transfer_sender_address_address1,
|
|
20
|
+
:money_transfer_sender_address_state, :money_transfer_receiver_first_name,
|
|
21
|
+
:money_transfer_receiver_last_name, :money_transfer_receiver_country,
|
|
22
|
+
:money_transfer_receiver_city, :money_transfer_receiver_zip_code,
|
|
23
|
+
:money_transfer_receiver_address1, :money_transfer_receiver_state
|
|
32
24
|
|
|
33
|
-
attr_reader :money_transfer_type, :
|
|
34
|
-
:
|
|
25
|
+
attr_reader :money_transfer_type, :money_transfer_sender_address_type, :money_transfer_receiver_type,
|
|
26
|
+
:money_transfer_sender_account_number_type, :money_transfer_source_of_funds
|
|
35
27
|
|
|
36
28
|
# Money Transfer Type setter
|
|
37
29
|
def money_transfer_type=(value)
|
|
@@ -44,25 +36,35 @@ module GenesisRuby
|
|
|
44
36
|
)
|
|
45
37
|
end
|
|
46
38
|
|
|
47
|
-
# Money Transfer Sender
|
|
48
|
-
def
|
|
39
|
+
# Money Transfer Sender Address Person Type setter
|
|
40
|
+
def money_transfer_sender_address_type=(value)
|
|
49
41
|
allowed_options(
|
|
50
42
|
attribute: __method__,
|
|
51
|
-
allowed: Api::Constants::Transactions::Parameters::
|
|
52
|
-
SenderAccountNumberTypes.all,
|
|
43
|
+
allowed: Api::Constants::Transactions::Parameters::Funding::PersonTypes.all,
|
|
53
44
|
value: value,
|
|
54
|
-
error_message: 'Invalid data for Money Transfer Sender
|
|
45
|
+
error_message: 'Invalid data for Money Transfer Sender Address Type',
|
|
46
|
+
allow_empty: true
|
|
47
|
+
)
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Money Transfer Receiver Person Type setter
|
|
51
|
+
def money_transfer_receiver_type=(value)
|
|
52
|
+
allowed_options(
|
|
53
|
+
attribute: __method__,
|
|
54
|
+
allowed: Api::Constants::Transactions::Parameters::Funding::PersonTypes.all,
|
|
55
|
+
value: value,
|
|
56
|
+
error_message: 'Invalid data for Money Transfer Receiver Type',
|
|
55
57
|
allow_empty: true
|
|
56
58
|
)
|
|
57
59
|
end
|
|
58
60
|
|
|
59
|
-
# Money Transfer
|
|
60
|
-
def
|
|
61
|
+
# Money Transfer Sender Account Number Type setter
|
|
62
|
+
def money_transfer_sender_account_number_type=(value)
|
|
61
63
|
allowed_options(
|
|
62
64
|
attribute: __method__,
|
|
63
|
-
allowed: Api::Constants::Transactions::Parameters::MoneyTransfer::
|
|
65
|
+
allowed: Api::Constants::Transactions::Parameters::MoneyTransfer::SenderAccountNumberTypes.all,
|
|
64
66
|
value: value,
|
|
65
|
-
error_message: 'Invalid data for Money Transfer
|
|
67
|
+
error_message: 'Invalid data for Money Transfer Sender Account Number Type',
|
|
66
68
|
allow_empty: true
|
|
67
69
|
)
|
|
68
70
|
end
|
|
@@ -99,27 +101,28 @@ module GenesisRuby
|
|
|
99
101
|
sender_account_number: money_transfer_sender_account_number,
|
|
100
102
|
sender_birth_date: money_transfer_sender_birth_date,
|
|
101
103
|
service_provider_name: money_transfer_service_provider_name,
|
|
102
|
-
sender_account_number_type: money_transfer_sender_account_number_type,
|
|
103
|
-
purpose_of_payment: money_transfer_purpose_of_payment,
|
|
104
|
-
source_of_funds: money_transfer_source_of_funds,
|
|
105
104
|
sender_address: {
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
105
|
+
type: money_transfer_sender_address_type,
|
|
106
|
+
first_name: money_transfer_sender_address_first_name,
|
|
107
|
+
last_name: money_transfer_sender_address_last_name,
|
|
108
|
+
country: money_transfer_sender_address_country,
|
|
109
|
+
city: money_transfer_sender_address_city,
|
|
110
|
+
zip_code: money_transfer_sender_address_zip_code,
|
|
111
|
+
address1: money_transfer_sender_address_address1,
|
|
112
|
+
state: money_transfer_sender_address_state
|
|
111
113
|
},
|
|
112
114
|
receiver: {
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
115
|
+
type: money_transfer_receiver_type,
|
|
116
|
+
first_name: money_transfer_receiver_first_name,
|
|
117
|
+
last_name: money_transfer_receiver_last_name,
|
|
118
|
+
country: money_transfer_receiver_country,
|
|
119
|
+
city: money_transfer_receiver_city,
|
|
120
|
+
zip_code: money_transfer_receiver_zip_code,
|
|
121
|
+
address1: money_transfer_receiver_address1,
|
|
122
|
+
state: money_transfer_receiver_state
|
|
123
|
+
},
|
|
124
|
+
sender_account_number_type: money_transfer_sender_account_number_type,
|
|
125
|
+
source_of_funds: money_transfer_source_of_funds
|
|
123
126
|
}
|
|
124
127
|
end
|
|
125
128
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module GenesisRuby
|
|
4
|
+
module Api
|
|
5
|
+
module Mixins
|
|
6
|
+
module Requests
|
|
7
|
+
module Financial
|
|
8
|
+
# Merchant Order attributes. Groups multiple transactions under a single business order.
|
|
9
|
+
# Transaction order IDs must be enabled for the merchant in the Genesis admin.
|
|
10
|
+
module OrderAttributes
|
|
11
|
+
|
|
12
|
+
# Maximum length of the merchant order identifier
|
|
13
|
+
ORDER_ID_MAX_LENGTH = 255
|
|
14
|
+
|
|
15
|
+
attr_reader :order_id
|
|
16
|
+
|
|
17
|
+
# Merchant order identifier, any string up to 255 characters
|
|
18
|
+
def order_id=(value)
|
|
19
|
+
limited_string attribute: __method__,
|
|
20
|
+
value: value.to_s.empty? ? nil : value.to_s,
|
|
21
|
+
max: ORDER_ID_MAX_LENGTH
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
protected
|
|
25
|
+
|
|
26
|
+
# Order request structure
|
|
27
|
+
def order_attributes_structure
|
|
28
|
+
{ order_id: order_id }
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|